Skip navigation links

Jakarta Deployment API v1.7.2
A B C D E F G H I J M N O P R S T U V W X 

A

ActionType - Class in javax.enterprise.deploy.shared
Class ActionTypes defines enumeration values for the Jakarta EE DeploymentStatus actions.
ActionType(int) - Constructor for class javax.enterprise.deploy.shared.ActionType
Construct a new enumeration value with the given integer value.
addProgressListener(ProgressListener) - Method in interface javax.enterprise.deploy.spi.status.ProgressObject
Add a listener to receive Progress events on deployment actions.
addPropertyChangeListener(PropertyChangeListener) - Method in interface javax.enterprise.deploy.spi.DConfigBean
Register a property listener for this bean.
addXpathListener(String, XpathListener) - Method in interface javax.enterprise.deploy.model.DDBean
Register a listener for a specific XPath.
addXpathListener(ModuleType, String, XpathListener) - Method in interface javax.enterprise.deploy.model.J2eeApplicationObject
Register a listener for changes in XPath that are related to this deployableObject.

B

BEAN_ADDED - Static variable in class javax.enterprise.deploy.model.XpathEvent
Adding a DDBean
BEAN_CHANGED - Static variable in class javax.enterprise.deploy.model.XpathEvent
Changing a DDBean
BEAN_REMOVED - Static variable in class javax.enterprise.deploy.model.XpathEvent
Removing a DDBean
BeanNotFoundException - Exception in javax.enterprise.deploy.spi.exceptions
This exception is to report that the bean is not a child of the parent bean.
BeanNotFoundException(String) - Constructor for exception javax.enterprise.deploy.spi.exceptions.BeanNotFoundException
Creates an new BeanNotFoundException object.

C

CANCEL - Static variable in class javax.enterprise.deploy.shared.ActionType
A cancel operation is being preformed on the DeploymentManager action command.
cancel() - Method in interface javax.enterprise.deploy.spi.status.ProgressObject
(optional) A cancel request on an in-process operation stops all further processing of the operation and returns the environment to it original state before the operation was executed.
CAR - Static variable in class javax.enterprise.deploy.shared.ModuleType
The module is an Client Application archive.
ClientConfiguration - Interface in javax.enterprise.deploy.spi.status
The ClientConfiguration object installs, configures and executes an Application Client.
ClientExecuteException - Exception in javax.enterprise.deploy.spi.exceptions
This exception reports errors in setting up an application client for execution.
ClientExecuteException() - Constructor for exception javax.enterprise.deploy.spi.exceptions.ClientExecuteException
Creates new ClientExecuteException without detail message.
ClientExecuteException(String) - Constructor for exception javax.enterprise.deploy.spi.exceptions.ClientExecuteException
Constructs an ClientExecuteException with the specified detail message.
CommandType - Class in javax.enterprise.deploy.shared
Class CommandTypes defines enumeration values for the DeploymentStatus object.
CommandType(int) - Constructor for class javax.enterprise.deploy.shared.CommandType
Construct a new enumeration value with the given integer value.
COMPLETED - Static variable in class javax.enterprise.deploy.shared.StateType
The action operation has completed normally.
ConfigurationException - Exception in javax.enterprise.deploy.spi.exceptions
This exception reports errors in generating a configuration bean.
ConfigurationException() - Constructor for exception javax.enterprise.deploy.spi.exceptions.ConfigurationException
Creates new ConfigurationException without detail message.
ConfigurationException(String) - Constructor for exception javax.enterprise.deploy.spi.exceptions.ConfigurationException
Constructs an ConfigurationException with the specified detail message.
createConfiguration(DeployableObject) - Method in interface javax.enterprise.deploy.spi.DeploymentManager
Retrieve the object that provides server-specific deployment configuration information for the Jakarta EE deployable component.

D

DConfigBean - Interface in javax.enterprise.deploy.spi
The DConfigBean is a deployment configuration bean (DConfigBean) that is associated with one or more deployment descriptor beans, (DDBean).
DConfigBeanRoot - Interface in javax.enterprise.deploy.spi
A Jakarta EE component module consists of one or more deployment descriptor files and zero or more non-deployment descriptor XML instance documents.
DConfigBeanVersionType - Class in javax.enterprise.deploy.shared
Class DConfigBeanVersionTypes defines enumeration values for the J2EE Platform verion number.
DConfigBeanVersionType(int) - Constructor for class javax.enterprise.deploy.shared.DConfigBeanVersionType
Construct a new enumeration value with the given integer value.
DConfigBeanVersionUnsupportedException - Exception in javax.enterprise.deploy.spi.exceptions
This exception is to report that there is no support for the DConfigBean version requested.
DConfigBeanVersionUnsupportedException(String) - Constructor for exception javax.enterprise.deploy.spi.exceptions.DConfigBeanVersionUnsupportedException
Creates an new DConfigBeanVersionUnsupportedException object.
DDBean - Interface in javax.enterprise.deploy.model
An interface for beans that represent a fragment of a standard deployment descriptor.
DDBeanCreateException - Exception in javax.enterprise.deploy.model.exceptions
This exception reports errors in generating a DDBean.
DDBeanCreateException() - Constructor for exception javax.enterprise.deploy.model.exceptions.DDBeanCreateException
Creates new DDBeanCreateException without detail message.
DDBeanCreateException(String) - Constructor for exception javax.enterprise.deploy.model.exceptions.DDBeanCreateException
Constructs an DDBeanCreateException with the specified detail message.
DDBeanRoot - Interface in javax.enterprise.deploy.model
An interface that represents the root of a standard deployment descriptor.
DeployableObject - Interface in javax.enterprise.deploy.model
The DeployableObject interface is an abstract representation of a Jakarta EE deployable module (JAR, WAR, RAR, EAR).
DeploymentConfiguration - Interface in javax.enterprise.deploy.spi
An interface that defines a container for all the server-specific configuration information for a single top-level Jakarta EE module.
DeploymentFactory - Interface in javax.enterprise.deploy.spi.factories
The DeploymentFactory interface is a deployment driver for a Jakarta EE plaform product.
DeploymentFactoryManager - Class in javax.enterprise.deploy.shared.factories
The DeploymentFactoryManager class is a central registry for Jakarta EE DeploymentFactory objects.
DeploymentManager - Interface in javax.enterprise.deploy.spi
The DeploymentManager object provides the core set of functions a Jakarta EE platform must provide for Java EE application deployment.
DeploymentManagerCreationException - Exception in javax.enterprise.deploy.spi.exceptions
This exception is to report problems in returning a DeploymentManager object cause by such things as server down, unable to authenticate and the like.
DeploymentManagerCreationException(String) - Constructor for exception javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException
Creates an new DeploymentManagerCreationException object.
DeploymentStatus - Interface in javax.enterprise.deploy.spi.status
The DeploymentStatus interface provides information about the progress status of a deployment action.
DISTRIBUTE - Static variable in class javax.enterprise.deploy.shared.CommandType
The DeploymentManger action operation being processed is distribute.
distribute(Target[], File, File) - Method in interface javax.enterprise.deploy.spi.DeploymentManager
The distribute method performs three tasks; it validates the deployment configuration data, generates all container specific classes and interfaces, and moves the fully baked archive to the designated deployment targets.
distribute(Target[], InputStream, InputStream) - Method in interface javax.enterprise.deploy.spi.DeploymentManager
distribute(Target[], ModuleType, InputStream, InputStream) - Method in interface javax.enterprise.deploy.spi.DeploymentManager
The distribute method performs three tasks; it validates the deployment configuration data, generates all container specific classes and interfaces, and moves the fully baked archive to the designated deployment targets.

E

EAR - Static variable in class javax.enterprise.deploy.shared.ModuleType
The module is an EAR archive.
EJB - Static variable in class javax.enterprise.deploy.shared.ModuleType
The module is an Enterprise Java Bean archive.
entries() - Method in interface javax.enterprise.deploy.model.DeployableObject
Returns an enumeration of the module file entries.
EXECUTE - Static variable in class javax.enterprise.deploy.shared.ActionType
The DeploymentManager action command is executing.
execute() - Method in interface javax.enterprise.deploy.spi.status.ClientConfiguration
This method performs an exec and starts the application client running in another process.

F

FAILED - Static variable in class javax.enterprise.deploy.shared.StateType
The action operation has failed.
fireXpathEvent(XpathEvent) - Method in interface javax.enterprise.deploy.model.XpathListener
 

G

getAction() - Method in interface javax.enterprise.deploy.spi.status.DeploymentStatus
Retrieve the deployment ActionType for this event.
getActionType(int) - Static method in class javax.enterprise.deploy.shared.ActionType
Return an object of the specified value.
getAttributeNames() - Method in interface javax.enterprise.deploy.model.DDBean
Returns the list of attribute names associated with the XML element.
getAttributeValue(String) - Method in interface javax.enterprise.deploy.model.DDBean
Returns the string value of the named attribute.
getAvailableModules(ModuleType, Target[]) - Method in interface javax.enterprise.deploy.spi.DeploymentManager
Retrieve the list of all Jakarta EE application modules running or not running on the identified targets.
getBean() - Method in class javax.enterprise.deploy.model.XpathEvent
The bean being added/removed/changed.
getChangeEvent() - Method in class javax.enterprise.deploy.model.XpathEvent
 
getChildBean(String) - Method in interface javax.enterprise.deploy.model.DDBean
Return a list of DDBeans based upon the XPath.
getChildBean(String) - Method in interface javax.enterprise.deploy.model.DeployableObject
Return an array of standard beans representing the XML content returned based upon the XPath.
getChildBean(ModuleType, String) - Method in interface javax.enterprise.deploy.model.J2eeApplicationObject
Return a list of DDBean based upon an XPath; all deployment descriptors of the specified type are searched.
getChildTargetModuleID() - Method in interface javax.enterprise.deploy.spi.TargetModuleID
Retrieve a list of identifiers of the children of this deployed module.
getClassFromScope(String) - Method in interface javax.enterprise.deploy.model.DeployableObject
Retrieve the specified class from this deployable module.
getClientConfiguration(TargetModuleID) - Method in interface javax.enterprise.deploy.spi.status.ProgressObject
Return the ClientConfiguration object associated with the TargetModuleID.
getCommand() - Method in interface javax.enterprise.deploy.spi.status.DeploymentStatus
Retrieve the deployment CommandType of this event.
getCommandType(int) - Static method in class javax.enterprise.deploy.shared.CommandType
Return an object of the specified value.
getCurrentLocale() - Method in interface javax.enterprise.deploy.spi.DeploymentManager
Returns the active locale this implementation of javax.enterprise.deploy.spi subpackages is running.
getDConfigBean(DDBean) - Method in interface javax.enterprise.deploy.spi.DConfigBean
Return the JavaBean containing the server-specific deployment configuration information based upon the XML data provided by the DDBean.
getDConfigBean(DDBeanRoot) - Method in interface javax.enterprise.deploy.spi.DConfigBeanRoot
Return a DConfigBean for a deployment descriptor that is not the module's primary deployment descriptor.
getDConfigBeanRoot(DDBeanRoot) - Method in interface javax.enterprise.deploy.spi.DeploymentConfiguration
Returns the top level configuration bean, DConfigBeanRoot, associated with the deployment descriptor represented by the designated DDBeanRoot bean.
getDConfigBeanVersion() - Method in interface javax.enterprise.deploy.spi.DeploymentManager
Returns the Jakarta EE platform version number for which the configuration beans are provided.
getDConfigBeanVersionType(int) - Static method in class javax.enterprise.deploy.shared.DConfigBeanVersionType
Return an object of the specified value.
getDDBean() - Method in interface javax.enterprise.deploy.spi.DConfigBean
Return the JavaBean containing the deployment descriptor XML text associated with this DConfigBean.
getDDBeanRoot() - Method in interface javax.enterprise.deploy.model.DeployableObject
Return the top level standard bean representing the root of the deployment descriptor.
getDDBeanRoot(String) - Method in interface javax.enterprise.deploy.model.DeployableObject
Returns a DDBeanRoot object for the XML instance document named.
getDDBeanRootVersion() - Method in interface javax.enterprise.deploy.model.DDBeanRoot
Returns the version number of an XML instance document.
getDefaultLocale() - Method in interface javax.enterprise.deploy.spi.DeploymentManager
Returns the default locale supported by this implementation of javax.enterprise.deploy.spi subpackages.
getDeployableObject() - Method in interface javax.enterprise.deploy.model.DDBeanRoot
Return the containing DeployableObject
getDeployableObject(String) - Method in interface javax.enterprise.deploy.model.J2eeApplicationObject
Return the DeployableObject of the specified URI designator.
getDeployableObject() - Method in interface javax.enterprise.deploy.spi.DeploymentConfiguration
Returns an object that provides access to the deployment descriptor data and classes of a Java EE module.
getDeployableObjects(ModuleType) - Method in interface javax.enterprise.deploy.model.J2eeApplicationObject
Return the all DeployableObjects of the specified type.
getDeployableObjects() - Method in interface javax.enterprise.deploy.model.J2eeApplicationObject
Return the all DeployableObjects in this application.
getDeploymentFactories() - Method in class javax.enterprise.deploy.shared.factories.DeploymentFactoryManager
Retrieve the lists of currently registered DeploymentFactories.
getDeploymentManager(String, String, String) - Method in class javax.enterprise.deploy.shared.factories.DeploymentFactoryManager
Retrieves a DeploymentManager instance to use for deployment.
getDeploymentManager(String, String, String) - Method in interface javax.enterprise.deploy.spi.factories.DeploymentFactory
Return a connected DeploymentManager instance.
getDeploymentStatus() - Method in class javax.enterprise.deploy.spi.status.ProgressEvent
Retrieve the status information.
getDeploymentStatus() - Method in interface javax.enterprise.deploy.spi.status.ProgressObject
Retrieve the status of this activity.
getDescription() - Method in interface javax.enterprise.deploy.spi.Target
Retrieve other descriptive information about the target.
getDisconnectedDeploymentManager(String) - Method in class javax.enterprise.deploy.shared.factories.DeploymentFactoryManager
Return a disconnected DeploymentManager instance.
getDisconnectedDeploymentManager(String) - Method in interface javax.enterprise.deploy.spi.factories.DeploymentFactory
Return a disconnected DeploymentManager instance.
getDisplayName() - Method in interface javax.enterprise.deploy.spi.factories.DeploymentFactory
Provide a string with the name of this vendor's DeploymentManager.
getEntry(String) - Method in interface javax.enterprise.deploy.model.DeployableObject
Returns the InputStream for the given entry name The file name must be relative to the root of the module.
getEnumValueTable() - Method in class javax.enterprise.deploy.shared.ActionType
Returns the enumeration value table for class ActionType
getEnumValueTable() - Method in class javax.enterprise.deploy.shared.CommandType
Returns the enumeration value table for class CommandType.
getEnumValueTable() - Method in class javax.enterprise.deploy.shared.DConfigBeanVersionType
Returns the enumeration value table for class DConfigBeanVersionType.
getEnumValueTable() - Method in class javax.enterprise.deploy.shared.ModuleType
Returns the enumeration value table for class ModuleType.
getEnumValueTable() - Method in class javax.enterprise.deploy.shared.StateType
Returns the enumeration value table for class StateType.
getFilename() - Method in interface javax.enterprise.deploy.model.DDBeanRoot
Returns the filename relative to the root of the module of the XML instance document this DDBeanRoot represents.
getId() - Method in interface javax.enterprise.deploy.model.DDBean
Returns a tool-specific reference for attribute ID on an element in the deployment descriptor.
getInstance() - Static method in class javax.enterprise.deploy.shared.factories.DeploymentFactoryManager
Retrieve the Singleton DeploymentFactoryManager
getMessage() - Method in interface javax.enterprise.deploy.spi.status.DeploymentStatus
Retrieve any additional information about the status of this event.
getModuleDTDVersion() - Method in interface javax.enterprise.deploy.model.DDBeanRoot
Deprecated.
As of version 1.1 replaced by DDBeanRoot.getDDBeanRootVersion()
getModuleDTDVersion() - Method in interface javax.enterprise.deploy.model.DeployableObject
Deprecated.
As of version 1.1 replaced by DDBeanRoot.getDDBeanRootVersion()
getModuleExtension() - Method in class javax.enterprise.deploy.shared.ModuleType
Return the file extension string for this enumeration.
getModuleID() - Method in interface javax.enterprise.deploy.spi.TargetModuleID
Retrieve the id assigned to represent the deployed module.
getModuleType(int) - Static method in class javax.enterprise.deploy.shared.ModuleType
Return an object of the specified value.
getModuleUris(ModuleType) - Method in interface javax.enterprise.deploy.model.J2eeApplicationObject
Return the list of URIs of the designated module type.
getModuleUris() - Method in interface javax.enterprise.deploy.model.J2eeApplicationObject
Return the list of URIs for all modules in the application.
getName() - Method in interface javax.enterprise.deploy.spi.Target
Retrieve the name of the target server.
getNonRunningModules(ModuleType, Target[]) - Method in interface javax.enterprise.deploy.spi.DeploymentManager
Retrieve the list of Jakarta EE application modules distributed to the identified targets and that are currently not running on the associated server or servers.
getOffset() - Method in class javax.enterprise.deploy.shared.ActionType
Returns the lowest integer value used by this enumeration value's enumeration class.
getOffset() - Method in class javax.enterprise.deploy.shared.CommandType
Returns the lowest integer value used by this enumeration value's enumeration class.
getOffset() - Method in class javax.enterprise.deploy.shared.DConfigBeanVersionType
Returns the lowest integer value used by this enumeration value's enumeration class.
getOffset() - Method in class javax.enterprise.deploy.shared.ModuleType
Returns the lowest integer value used by this enumeration value's enumeration class.
getOffset() - Method in class javax.enterprise.deploy.shared.StateType
Returns the lowest integer value used by this enumeration value's enumeration class.
getParentTargetModuleID() - Method in interface javax.enterprise.deploy.spi.TargetModuleID
Retrieve the identifier of the parent object of this deployed module.
getProductVersion() - Method in interface javax.enterprise.deploy.spi.factories.DeploymentFactory
Provide a string identifying version of this vendor's DeploymentManager.
getResultTargetModuleIDs() - Method in interface javax.enterprise.deploy.spi.status.ProgressObject
Retrieve the list of TargetModuleIDs successfully processed or created by the associated DeploymentManager operation.
getRoot() - Method in interface javax.enterprise.deploy.model.DDBean
Return the root element for this DDBean.
getRunningModules(ModuleType, Target[]) - Method in interface javax.enterprise.deploy.spi.DeploymentManager
Retrieve the list of Jakarta EE application modules distributed to the identified targets and that are currently running on the associated server or servers.
getState() - Method in interface javax.enterprise.deploy.spi.status.DeploymentStatus
Retrieve the StateType value.
getStateType(int) - Static method in class javax.enterprise.deploy.shared.StateType
Return an object of the specified value.
getStringTable() - Method in class javax.enterprise.deploy.shared.ActionType
Returns the string table for class ActionType.
getStringTable() - Method in class javax.enterprise.deploy.shared.CommandType
Returns the string table for class CommandType.
getStringTable() - Method in class javax.enterprise.deploy.shared.DConfigBeanVersionType
Returns the string table for class DConfigBeanVersionType.
getStringTable() - Method in class javax.enterprise.deploy.shared.ModuleType
Returns the string table for class ModuleType.
getStringTable() - Method in class javax.enterprise.deploy.shared.StateType
Returns the string table for class StateType.
getSupportedLocales() - Method in interface javax.enterprise.deploy.spi.DeploymentManager
Returns an array of supported locales for this implementation.
getTarget() - Method in interface javax.enterprise.deploy.spi.TargetModuleID
Retrieve the name of the target server.
getTargetModuleID() - Method in class javax.enterprise.deploy.spi.status.ProgressEvent
Retrieve the TargetModuleID for this event
getTargets() - Method in interface javax.enterprise.deploy.spi.DeploymentManager
Retrieve the list of deployment targets supported by this DeploymentManager.
getText() - Method in interface javax.enterprise.deploy.model.DDBean
Returns the XML text for by this bean.
getText(String) - Method in interface javax.enterprise.deploy.model.DDBean
Return a list of text values for a given XPath in the deployment descriptor.
getText(String) - Method in interface javax.enterprise.deploy.model.DeployableObject
Return the XML content associated with the XPath from a deployment descriptor.
getText(ModuleType, String) - Method in interface javax.enterprise.deploy.model.J2eeApplicationObject
Return the text value from the XPath; search only the deployment descriptors of the specified type.
getType() - Method in interface javax.enterprise.deploy.model.DDBeanRoot
Return the ModuleType of deployment descriptor.
getType() - Method in interface javax.enterprise.deploy.model.DeployableObject
Return the ModuleType of deployment descriptor (i.e., EAR, JAR, WAR, RAR) this deployable object represents.
getValue() - Method in class javax.enterprise.deploy.shared.ActionType
Returns this enumeration value's integer value.
getValue() - Method in class javax.enterprise.deploy.shared.CommandType
Returns this enumeration value's integer value.
getValue() - Method in class javax.enterprise.deploy.shared.DConfigBeanVersionType
Returns this enumeration value's integer value.
getValue() - Method in class javax.enterprise.deploy.shared.ModuleType
Returns this enumeration value's integer value.
getValue() - Method in class javax.enterprise.deploy.shared.StateType
Returns this enumeration value's integer value.
getWebURL() - Method in interface javax.enterprise.deploy.spi.TargetModuleID
If this TargetModulID represents a web module retrieve the URL for it.
getXpath() - Method in interface javax.enterprise.deploy.model.DDBean
Returns the original xpath string provided by the DConfigBean.
getXpath() - Method in interface javax.enterprise.deploy.model.DDBeanRoot
Return the XPath for this standard bean.
getXpaths() - Method in interface javax.enterprise.deploy.spi.DConfigBean
Return a list of XPaths designating the deployment descriptor information this DConfigBean requires.

H

handleProgressEvent(ProgressEvent) - Method in interface javax.enterprise.deploy.spi.status.ProgressListener
Invoked when a deployment progress event occurs.
handlesURI(String) - Method in interface javax.enterprise.deploy.spi.factories.DeploymentFactory
Tests whether this factory can create a DeploymentManager object based on the specificed URI.

I

InvalidModuleException - Exception in javax.enterprise.deploy.spi.exceptions
This exception is to report an invalid Jakarta EE deployment module type.
InvalidModuleException(String) - Constructor for exception javax.enterprise.deploy.spi.exceptions.InvalidModuleException
Creates an new InvalidModuleException object.
isAddEvent() - Method in class javax.enterprise.deploy.model.XpathEvent
Is this an add event?
isCancelSupported() - Method in interface javax.enterprise.deploy.spi.status.ProgressObject
Tests whether the vendor supports a cancel opertation for deployment activities.
isChangeEvent() - Method in class javax.enterprise.deploy.model.XpathEvent
Is this a change event?
isCompleted() - Method in interface javax.enterprise.deploy.spi.status.DeploymentStatus
A convience method to report if the operation is in the completed state.
isDConfigBeanVersionSupported(DConfigBeanVersionType) - Method in interface javax.enterprise.deploy.spi.DeploymentManager
Returns 'true' if the configuration beans support the Jakarta EE platform version specified.
isFailed() - Method in interface javax.enterprise.deploy.spi.status.DeploymentStatus
A convience method to report if the operation is in the failed state.
isLocaleSupported(Locale) - Method in interface javax.enterprise.deploy.spi.DeploymentManager
Reports if this implementation supports the designated locale.
isRedeploySupported() - Method in interface javax.enterprise.deploy.spi.DeploymentManager
This method designates whether this platform vendor provides application redeployment functionality.
isRemoveEvent() - Method in class javax.enterprise.deploy.model.XpathEvent
Is this a remove event?
isRunning() - Method in interface javax.enterprise.deploy.spi.status.DeploymentStatus
A convience method to report if the operation is in the running state.
isStopSupported() - Method in interface javax.enterprise.deploy.spi.status.ProgressObject
Tests whether the vendor supports a stop opertation for deployment activities.

J

J2eeApplicationObject - Interface in javax.enterprise.deploy.model
J2eeApplicationObject is an interface that represents a Jakarta EE application (EAR); it maintains a DeployableObject for each module in the archive.
javax.enterprise.deploy.model - package javax.enterprise.deploy.model
Provides Tool Vendor implementation classes.
javax.enterprise.deploy.model.exceptions - package javax.enterprise.deploy.model.exceptions
Provides Tool Vendor exception implementation classes.
javax.enterprise.deploy.shared - package javax.enterprise.deploy.shared
Provides shared objects for Tool Vendor and Product Vendor implementation classes.
javax.enterprise.deploy.shared.factories - package javax.enterprise.deploy.shared.factories
Provides shared factory manager object for Tool Vendor and Product Vendor implementation classes.
javax.enterprise.deploy.spi - package javax.enterprise.deploy.spi
Provides Jakarta EE Product Vendor implementation classes.
javax.enterprise.deploy.spi.exceptions - package javax.enterprise.deploy.spi.exceptions
Provides Jakarta EE Product Vendor deployment exception implementation classes.
javax.enterprise.deploy.spi.factories - package javax.enterprise.deploy.spi.factories
Provides Jakarta EE Product Vendor deployment factory implementation classes.
javax.enterprise.deploy.spi.status - package javax.enterprise.deploy.spi.status
Provides Jakarta EE Product Vendor deployment status implementation classes.

M

ModuleType - Class in javax.enterprise.deploy.shared
Class ModuleTypes defines enumeration values for the Jakarta EE module types.
ModuleType(int) - Constructor for class javax.enterprise.deploy.shared.ModuleType
Construct a new enumeration value with the given integer value.

N

notifyDDChange(XpathEvent) - Method in interface javax.enterprise.deploy.spi.DConfigBean
A notification that the DDBean provided in the event has changed and this bean or its child beans need to reevaluate themselves.

O

OperationUnsupportedException - Exception in javax.enterprise.deploy.spi.exceptions
This exception is to report that the method called is not supported by this implementation.
OperationUnsupportedException(String) - Constructor for exception javax.enterprise.deploy.spi.exceptions.OperationUnsupportedException
Creates an new OperationUnsupportedException object.

P

ProgressEvent - Class in javax.enterprise.deploy.spi.status
An event which indicates that a deployment status change has occurred.
ProgressEvent(Object, TargetModuleID, DeploymentStatus) - Constructor for class javax.enterprise.deploy.spi.status.ProgressEvent
Creates a new object representing a deployment progress event.
ProgressListener - Interface in javax.enterprise.deploy.spi.status
The listener interface for receiving deployment progress events.
ProgressObject - Interface in javax.enterprise.deploy.spi.status
The ProgressObject interface tracks and reports the progress of the deployment activities, distribute, start, stop, undeploy.

R

RAR - Static variable in class javax.enterprise.deploy.shared.ModuleType
The module is an Connector archive.
REDEPLOY - Static variable in class javax.enterprise.deploy.shared.CommandType
The DeploymentManger action operation being processed is redeploy.
redeploy(TargetModuleID[], File, File) - Method in interface javax.enterprise.deploy.spi.DeploymentManager
(optional) The redeploy method provides a means for updating currently deployed Jakarta EE applications.
redeploy(TargetModuleID[], InputStream, InputStream) - Method in interface javax.enterprise.deploy.spi.DeploymentManager
(optional) The redeploy method provides a means for updating currently deployed Jakarta EE applications.
registerDeploymentFactory(DeploymentFactory) - Method in class javax.enterprise.deploy.shared.factories.DeploymentFactoryManager
Registers a DeploymentFactory so it will be able to handle requests.
release() - Method in interface javax.enterprise.deploy.spi.DeploymentManager
The release method is the mechanism by which the tool signals to the DeploymentManager that the tool does not need it to continue running connected to the platform.
RELEASED - Static variable in class javax.enterprise.deploy.shared.StateType
The DeploymentManager is running in discommected mode.
removeDConfigBean(DConfigBean) - Method in interface javax.enterprise.deploy.spi.DConfigBean
Remove a child DConfigBean from this bean.
removeDConfigBean(DConfigBeanRoot) - Method in interface javax.enterprise.deploy.spi.DeploymentConfiguration
Remove the root DConfigBean and all its children.
removeProgressListener(ProgressListener) - Method in interface javax.enterprise.deploy.spi.status.ProgressObject
Remove a ProgressObject listener.
removePropertyChangeListener(PropertyChangeListener) - Method in interface javax.enterprise.deploy.spi.DConfigBean
Unregister a property listener for this bean.
removeXpathListener(String, XpathListener) - Method in interface javax.enterprise.deploy.model.DDBean
Unregister a listener for a specific XPath.
removeXpathListener(ModuleType, String, XpathListener) - Method in interface javax.enterprise.deploy.model.J2eeApplicationObject
Unregister the listener for an XPath.
restore(InputStream) - Method in interface javax.enterprise.deploy.spi.DeploymentConfiguration
Restore from disk to a full set of configuration beans previously stored.
restoreDConfigBean(InputStream, DDBeanRoot) - Method in interface javax.enterprise.deploy.spi.DeploymentConfiguration
Restore from disk to instantated objects all the DConfigBeans associated with a specific deployment descriptor.
RUNNING - Static variable in class javax.enterprise.deploy.shared.StateType
The action operation is running normally.

S

save(OutputStream) - Method in interface javax.enterprise.deploy.spi.DeploymentConfiguration
Save to disk the current set configuration beans created for this deployable module.
saveDConfigBean(OutputStream, DConfigBeanRoot) - Method in interface javax.enterprise.deploy.spi.DeploymentConfiguration
Save to disk all the configuration beans associated with a particular deployment descriptor file.
setChangeEvent(PropertyChangeEvent) - Method in class javax.enterprise.deploy.model.XpathEvent
 
setDConfigBeanVersion(DConfigBeanVersionType) - Method in interface javax.enterprise.deploy.spi.DeploymentManager
Set the configuration beans to be used to the Jakarta EE platform version specificed.
setLocale(Locale) - Method in interface javax.enterprise.deploy.spi.DeploymentManager
Set the active locale for this implementation of javax.enterprise.deploy.spi subpackages to run.
START - Static variable in class javax.enterprise.deploy.shared.CommandType
The DeploymentManger action operation being processed is start.
start(TargetModuleID[]) - Method in interface javax.enterprise.deploy.spi.DeploymentManager
Start the application running.
StateType - Class in javax.enterprise.deploy.shared
Class StateTypes defines enumeration values for the DeploymentStatus object.
StateType(int) - Constructor for class javax.enterprise.deploy.shared.StateType
Construct a new enumeration value with the given integer value.
STOP - Static variable in class javax.enterprise.deploy.shared.ActionType
A stop operation is being preformed on the DeploymentManager action command.
STOP - Static variable in class javax.enterprise.deploy.shared.CommandType
The DeploymentManger action operation being processed is stop.
stop(TargetModuleID[]) - Method in interface javax.enterprise.deploy.spi.DeploymentManager
Stop the application running.
stop() - Method in interface javax.enterprise.deploy.spi.status.ProgressObject
(optional) A stop request on an in-process operation allows the operation on the current TargetModuleID to run to completion but does not process any of the remaining unprocessed TargetModuleID objects.

T

Target - Interface in javax.enterprise.deploy.spi
A Target interface represents a single logical core server of one instance of a Jakarta EE platform product.
TargetException - Exception in javax.enterprise.deploy.spi.exceptions
This exception is to report bad target designators.
TargetException(String) - Constructor for exception javax.enterprise.deploy.spi.exceptions.TargetException
Creates an new TargetException object.
TargetModuleID - Interface in javax.enterprise.deploy.spi
A TargetModuleID interface represents a unique identifier for a deployed application module.
toString() - Method in class javax.enterprise.deploy.shared.ActionType
Return the string name of this ActionType or the integer value if outside the bounds of the table
toString() - Method in class javax.enterprise.deploy.shared.CommandType
Return the string name of this CommandType or the integer value if outside the bounds of the table
toString() - Method in class javax.enterprise.deploy.shared.DConfigBeanVersionType
Return the string name of this DConfigBeanVersionType or the integer value if outside the bounds of the table
toString() - Method in class javax.enterprise.deploy.shared.ModuleType
Return the string name of this ModuleType or the integer value if outside the bounds of the table
toString() - Method in class javax.enterprise.deploy.shared.StateType
Return the string name of this StateType or the integer value if outside the bounds of the table
toString() - Method in interface javax.enterprise.deploy.spi.TargetModuleID
Retrieve the identifier representing the deployed module.

U

UNDEPLOY - Static variable in class javax.enterprise.deploy.shared.CommandType
The DeploymentManger action operation being processed is undeploy.
undeploy(TargetModuleID[]) - Method in interface javax.enterprise.deploy.spi.DeploymentManager
Remove the application from the target server.

V

V1_3 - Static variable in class javax.enterprise.deploy.shared.DConfigBeanVersionType
J2EE Platform version 1.3
V1_3_1 - Static variable in class javax.enterprise.deploy.shared.DConfigBeanVersionType
J2EE Platform version 1.3.1 THIS CONSTANT SHOULD NEVER BE USED.
V1_4 - Static variable in class javax.enterprise.deploy.shared.DConfigBeanVersionType
J2EE Platform version 1.4
V5 - Static variable in class javax.enterprise.deploy.shared.DConfigBeanVersionType
Java EE Platform version 5

W

WAR - Static variable in class javax.enterprise.deploy.shared.ModuleType
The module is an Web Application archive.

X

XpathEvent - Class in javax.enterprise.deploy.model
An Event class describing ConfigBeans being added/subtracted from a server configuration.
XpathEvent(DDBean, Object) - Constructor for class javax.enterprise.deploy.model.XpathEvent
A description of a change in the ConfigBean tree.
XpathListener - Interface in javax.enterprise.deploy.model
The listener interface for receiving XpathEvents
A B C D E F G H I J M N O P R S T U V W X 
Skip navigation links

Jakarta Deployment API v1.7.2

Copyright © 2019 Eclipse Foundation. All rights reserved.
Use is subject to license terms.