All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class javax.ejb.deployment.DeploymentDescriptor

java.lang.Object
   |
   +----javax.ejb.deployment.DeploymentDescriptor

public abstract class DeploymentDescriptor

extends Object

implements Serializable

The methods of the class conform to the JavaBeans property design pattern.

See Also:

EntityDescriptor, SessionDescriptor

versionNumber

DeploymentDescriptor()

Create an instance of DeploymentDescriptor.

getAccessControlEntries()

Get the AccessControlEntry objects for the enterprise Bean.

getAccessControlEntries(int)

Get the AccessControlEntry object at a specified index.

getBeanHomeName()

Get the name to associate with the enterprise Bean in the JNDI name space.

getControlDescriptors()

Get the array of the enterprise Bean's control descriptors.

getControlDescriptors(int)

Get the control descriptor at the specified index.

getEnterpriseBeanClassName()

Get the enterprise Bean's full class name.

getEnvironmentProperties()

Get enterprise Bean's environment properties.

getHomeInterfaceClassName()

Get the full name of the enterprise Bean's home interface.

getReentrant()

This method returns the same result as isReentrant().

getRemoteInterfaceClassName()

Get the full name of the enterprise Bean's remote interface.

isReentrant()

Test if the enterprise Bean is re-entrant.

setAccessControlEntries(AccessControlEntry[])

Set the AccessControlEntry objects for the enterprise Bean.

setAccessControlEntries(int, AccessControlEntry)

Set the AccessControlEntry object at a specified index.

setBeanHomeName(Name)

Set the name to associate with the enterprise Bean in the JNDI name space.

setControlDescriptors(ControlDescriptor[])

Set the array of the enterprise Bean's control descriptors.

setControlDescriptors(int, ControlDescriptor)

Set the control descriptor at the specified index.

setEnterpriseBeanClassName(String)

Set the enterprise Bean's full class name.

setEnvironmentProperties(Properties)

Set enterprise Bean's environment properties.

setHomeInterfaceClassName(String)

Set the full name of the enterprise Bean's home interface.

setReentrant(boolean)

Specify that the enterprise Bean is re-entrant.

setRemoteInterfaceClassName(String)

Set the full name of the enterprise Bean's remote interface.

 protected int versionNumber

 public DeploymentDescriptor()

Create an instance of DeploymentDescriptor.

 public String getEnterpriseBeanClassName()

Get the enterprise Bean's full class name.

Returns:

The enterprise Bean's class name.

 public void setEnterpriseBeanClassName(String value)

Set the enterprise Bean's full class name.

Parameters:

value - The enterprise Bean's class name.

 public String getHomeInterfaceClassName()

Get the full name of the enterprise Bean's home interface.

Returns:

The name of the enterprise Bean's home interface.

 public void setHomeInterfaceClassName(String value)

Set the full name of the enterprise Bean's home interface.

Parameters:

value - The name of the enterprise Bean's home interface.

 public String getRemoteInterfaceClassName()

Get the full name of the enterprise Bean's remote interface.

Returns:

The name of the enterprise Bean's remote interface.

 public void setRemoteInterfaceClassName(String value)

Set the full name of the enterprise Bean's remote interface.

Parameters:

value - The name of the enterprise Bean's remote interface.

 public Name getBeanHomeName()

Get the name to associate with the enterprise Bean in the JNDI name space. The container will bind the enterprise Bean's home interface with a JNDI name that includes this name as its trailing part. This means that the container can prefix the name returned by getBeanName() with an arbitrary JNDI path.

For example, if getBeanHomeName() returns "bank/Account", the container can bind the Bean's home interface in the JNDI name space with the name "mis/ejb-components/bank/Account".

Returns:

A JNDI name for this enterprise Bean.

 public void setBeanHomeName(Name value)

Set the name to associate with the enterprise Bean in the JNDI name space. The container will bind the enterprise Bean's home interface with a JNDI name that includes this name as its trailing part. This means that the container can prefix the name returned by getBeanName() with an arbitrary JNDI path.

Note that using the type java.naming.Name makes the format of the name independent of the syntax used by the actual naming system.

Parameters:

value - A JNDI name for this enterprise Bean.

 public Properties getEnvironmentProperties()

Get enterprise Bean's environment properties.

Returns:

Enterprise Bean's environment properties.

 public void setEnvironmentProperties(Properties value)

Set enterprise Bean's environment properties.

Parameters:

value - Enterprise Bean's environment properties.

 public AccessControlEntry[] getAccessControlEntries()

Get the AccessControlEntry objects for the enterprise Bean. An AccessControlEntry object associates an enterprise Bean's method with a list of security Identities that are allowed to invoke the method.

Returns:

An array of AccessControlEntry objects.

 public void setAccessControlEntries(AccessControlEntry values[])

Set the AccessControlEntry objects for the enterprise Bean. An AccessControlEntry object associates an enterprise Bean's method with a list of security Identities that are allowed to invoke the method.

Parameters:

values - An array of AccessControlEntry objects.

 public AccessControlEntry getAccessControlEntries(int index)

Get the AccessControlEntry object at a specified index. An AccessControlEntry object associates an enterprise Bean's method with a list of security Identities that are allowed to invoke the method.

Parameters:

index - An index in the array of Identities.

Returns:

The AccessControlEntry at the index.

 public void setAccessControlEntries(int index,
                                     AccessControlEntry value)

Set the AccessControlEntry object at a specified index. An AccessControlEntry object associates an enterprise Bean's method with a list of security Identities that are allowed to invoke the method.

Parameters:

index - An index in the array of Identities.

value - The AccessControlEntry to set at the index.

 public ControlDescriptor[] getControlDescriptors()

Get the array of the enterprise Bean's control descriptors.

Returns:

An array of enterprise Bean's control descriptors.

 public void setControlDescriptors(ControlDescriptor value[])

Set the array of the enterprise Bean's control descriptors.

Parameters:

value - An array of the enterprise Bean's control descriptors.

 public ControlDescriptor getControlDescriptors(int index)

Get the control descriptor at the specified index.

Parameters:

index - The index of the control descriptor.

Returns:

The control descriptor at the specified index.

 public void setControlDescriptors(int index,
                                   ControlDescriptor value)

Set the control descriptor at the specified index.

Parameters:

index - The index of the control descriptor.

value - The control descriptor to be set at the specified index.

 public boolean isReentrant()

Test if the enterprise Bean is re-entrant. Only entity Beans can be defined as re-entrant, and it is an error for a session Bean deployment descriptor to return true.

Returns:

True if the Bean is reentrant, false otherwise.

 public boolean getReentrant()

This method returns the same result as isReentrant(). It is included for compatibility with the JavaBeans design-pattern.

 public void setReentrant(boolean value)

Specify that the enterprise Bean is re-entrant. Only entity Beans can be defined as re-entrant, and it is an error for a session Bean deployment descriptor to attempt to specify that the Bean is re-entrant.

Returns:

True if the Bean is reentrant, false otherwise.

All Packages  Class Hierarchy  This Package  Previous  Next  Index