All Packages Class Hierarchy This Package Previous Next Index
Class javax.ejb.deployment.DeploymentDescriptor
java.lang.Object
|
+----javax.ejb.deployment.DeploymentDescriptor
- public class DeploymentDescriptor
- extends Object
- implements Serializable
The DeploymentDescriptor class is the common baseclass for the
SessionDescriptor and EntityDescriptor deployment descriptor classes.
The class is designed as a JavaBean component.
A serialized instance of a deployment descriptor class is used as the
standard format for passing the enterprise bean's declarative deployment
attributes in the ejb-jar file. The deployment descriptor setter functions
are used by the enterprise bean provider's tools to create the deployment
descriptor before it is put into the ejb-jar file, and the getter functions
are used by the container provider's tools to read the deployment descriptor
from the ejb-jar file when the enterprise bean is installed into the
container.
After an enterprise bean has been installed into a container, the
container's tools can be then used to view and change the setting of
the deployment attributes.
-
DeploymentDescriptor()
- Create an instance of the deployment descriptor.
-
getEnterpriseBeanClass()
- Get the enterprise bean's class.
-
getEnvironmentProperties()
- Get enterprise bean's environment properties.
-
getHomeInterface()
- Get the enterprise bean's home interface.
-
getJNDIName()
- Get the name to associate with the enterprise bean in the JNDI name
space.
-
getMethodDescriptor(int)
- Get the method descriptor by an index.
-
getMethodDescriptors()
- Get the array of the enterprise bean's method descriptors.
-
getRemoteInterface()
- Get the enterprise bean's remote interface.
-
getSecurityDescriptor()
- Get the enterprise bean's security descriptor.
-
getTransactionAttribute()
- Get the enterprise bean's transaction attribute.
-
setEnterpriseBeanClass(Class)
- Set the enterprise bean's class.
-
setEnvironmentProperties(Properties)
- Set enterprise bean's environment properties.
-
setHomeInterface(Class)
- Set the enterprise bean's home interface.
-
setJNDIName(Name)
- Set the name to associate with the enterprise bean in the JNDI name
space.
-
setMethodDescriptor(int, MethodDescriptor)
- Set the method descriptor by an index.
-
setMethodDescriptors(MethodDescriptor[])
- Set the array of the enterprise bean's method descriptors.
-
setRemoteInterface(Class)
- Set the enterprise bean's remote interface.
-
setSecurityDescriptor(SecurityDescriptor)
- Set the enterprise bean's security descriptor.
-
setTransactionAttribute(int)
- Set the enterprise bean's transaction attribute.
DeploymentDescriptor
public DeploymentDescriptor()
- Create an instance of the deployment descriptor.
getEnterpriseBeanClass
public Class getEnterpriseBeanClass()
- Get the enterprise bean's class.
- Returns:
- The Class object for the enterprise bean's class.
setEnterpriseBeanClass
public void setEnterpriseBeanClass(Class value)
- Set the enterprise bean's class.
- Parameters:
- value - The Class object for the enterprise bean's class.
getHomeInterface
public Class getHomeInterface()
- Get the enterprise bean's home interface.
- Returns:
- The Class object for the enterprise bean's home.
setHomeInterface
public void setHomeInterface(Class value)
- Set the enterprise bean's home interface.
- Parameters:
- value - The Class object for the enterprise beans home.
getRemoteInterface
public Class getRemoteInterface()
- Get the enterprise bean's remote interface.
- Returns:
- The Class object for the enterprise bean's remote interface.
setRemoteInterface
public void setRemoteInterface(Class value)
- Set the enterprise bean's remote interface.
- Parameters:
- value - The Class object for the enterprise bean's remote interface.
getJNDIName
public Name getJNDIName()
- Get the name to associate with the enterprise bean in the JNDI name
space. The cointainer will make the enterprise bean's home interface
available at a JNDI name that ends with this relative path.
For example, if getJNDIName() returns "bank/Account", the container
must make the bean's home interface available under the JNDI name
"/prefix/bank/Account", where "prefix" can be an arbitrary
composite JNDI name, e.g. "/x/y/z/bank/Account". The "prefix" part can
also be empty.
- Returns:
- A JNDI name for this enterprise bean.
setJNDIName
public void setJNDIName(Name value)
- Set the name to associate with the enterprise bean in the JNDI name
space. The cointainer will make the enterprise bean's home interface
available at a JNDI name that ends with this relative path.
- Parameters:
- value - A JNDI name for this enterprise bean.
getTransactionAttribute
public int getTransactionAttribute()
- Get the enterprise bean's transaction attribute. The values of the
transaction attribute are defined in the class TransactionAttribute.
- Returns:
- The enterprise bean's transaction attribute.
setTransactionAttribute
public void setTransactionAttribute(int value)
- Set the enterprise bean's transaction attribute. The values of the
transaction attribute are defined in the class TransactionAttribute.
The transaction attribute applies to all methods of the enterprise
bean, unless it is overridden by a MethodDescriptor.
- Parameters:
- value - The enterprise bean's transaction attribute.
getSecurityDescriptor
public SecurityDescriptor getSecurityDescriptor()
- Get the enterprise bean's security descriptor.
- Returns:
- The enterprise bean's security descriptor.
setSecurityDescriptor
public void setSecurityDescriptor(SecurityDescriptor value)
- Set the enterprise bean's security descriptor.
The SecurityDescriptor applies to all methods of the enterprise
bean, unless it is overridden by a MethodDescriptor.
- Parameters:
- value - The enterprise bean's security descriptor.
getEnvironmentProperties
public Properties getEnvironmentProperties()
- Get enterprise bean's environment properties.
- Returns:
- Enterprise bean's environment properties.
setEnvironmentProperties
public void setEnvironmentProperties(Properties value)
- Set enterprise bean's environment properties.
- Parameters:
- value - Enterprise bean's environment properties.
getMethodDescriptors
public MethodDescriptor[] getMethodDescriptors()
- Get the array of the enterprise bean's method descriptors.
- Returns:
- An array of enterprise bean's method descriptors, or
null of the enterprise bean does not provide method-level
descriptors.
setMethodDescriptors
public void setMethodDescriptors(MethodDescriptor value[])
- Set the array of the enterprise bean's method descriptors.
A deployment descriptor may define zero or several
MethodDescriptors. If a MethodDescriptor is defined for a method,
the MethodDescriptor overrides the values of the transactionAttribute
and securityDescriptor set at the bean level.
A MethodDescriptor can be provided for the methods defined
in the enterprise bean's remote interface, home interface,
- Parameters:
- value - An array of the enterprise bean's method descriptors.
getMethodDescriptor
public MethodDescriptor getMethodDescriptor(int index)
- Get the method descriptor by an index.
- Parameters:
- index - The index of the method descriptor.
- Returns:
- The method descriptor at the specified index.
setMethodDescriptor
public void setMethodDescriptor(int index,
MethodDescriptor value)
- Set the method descriptor by an index.
- Parameters:
- index - The index of the method descriptor.
- value - The method descriptor to be set at the specified index.
All Packages Class Hierarchy This Package Previous Next Index