org.eclipse.jst.j2ee.ejb
Interface AssemblyDescriptor

All Superinterfaces:
org.eclipse.emf.ecore.EObject, J2EEEObject, org.eclipse.emf.common.notify.Notifier

public interface AssemblyDescriptor
extends J2EEEObject

The assembly-descriptor element contains application-assembly information. The application-assembly information consists of the following parts: the definition of security roles, the definition of method permissions, and the definition of transaction attributes for enterprise beans with container-managed transaction demarcation. All the parts are optional in the sense that they are omitted if the lists represented by them are empty. Providing an assembly-descriptor in the deployment descriptor is optional for the ejb-jar file producer.

Since:
1.0

Method Summary
 EJBJar getEjbJar()
           
 ExcludeList getExcludeList()
           
 org.eclipse.emf.common.util.EList getMessageDestinations()
          Returns the value of the 'Message Destinations' containment reference list.
 MethodPermission getMethodPermission(java.util.List securityRoles)
          Return the first method permission that contains all the roles in securityRoles and is the same size
 java.util.List getMethodPermissionMethodElements(EnterpriseBean anEJB)
          Return a List of MethodElements for @anEJB going through the MethodPermissions.
 org.eclipse.emf.common.util.EList getMethodPermissions()
           
 java.util.List getMethodTransactionMethodElements(EnterpriseBean anEJB)
          Return a List of MethodElements for @anEJB going through the MethodTransactions.
 org.eclipse.emf.common.util.EList getMethodTransactions()
           
 SecurityRole getSecurityRoleNamed(java.lang.String roleName)
          Return the SecurityRole given a roleName
 org.eclipse.emf.common.util.EList getSecurityRoles()
           
 void removeData(EnterpriseBean anEJB)
          Remove the MethodElements that are referencing @anEJB.
 void renameSecurityRole(java.lang.String existingRoleName, java.lang.String newRoleName)
          Rename the security role, if it exists
 void setEjbJar(EJBJar value)
           
 void setExcludeList(ExcludeList value)
           
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getMethodPermission

MethodPermission getMethodPermission(java.util.List securityRoles)
Return the first method permission that contains all the roles in securityRoles and is the same size

Parameters:
securityRoles - the list of SecurityRole
Returns:
The MethodPermission

getMethodPermissionMethodElements

java.util.List getMethodPermissionMethodElements(EnterpriseBean anEJB)
Return a List of MethodElements for @anEJB going through the MethodPermissions.

Parameters:
anEJB - the Enterprise Bean model
Returns:
List of MethodElement

getMethodTransactionMethodElements

java.util.List getMethodTransactionMethodElements(EnterpriseBean anEJB)
Return a List of MethodElements for @anEJB going through the MethodTransactions.

Parameters:
anEJB - the Enterprise Bean model
Returns:
List of MethodElement

getSecurityRoleNamed

SecurityRole getSecurityRoleNamed(java.lang.String roleName)
Return the SecurityRole given a roleName

Parameters:
roleName - the name of the role
Returns:
SecurityRole

renameSecurityRole

void renameSecurityRole(java.lang.String existingRoleName,
                        java.lang.String newRoleName)
Rename the security role, if it exists

Parameters:
existingRoleName - the existing role name
newRoleName - the new role name

getMethodPermissions

org.eclipse.emf.common.util.EList getMethodPermissions()
Returns:
The list of MethodPermissions references

getMethodTransactions

org.eclipse.emf.common.util.EList getMethodTransactions()
Returns:
The list of MethodTransactions references Specifies how the container must manage transaction scopes for the enterprise bean's method invocations. The element consists of an optional description, a list of method elements, and a transaction attribute.The transaction attribute is to be applied to all the specified methods.

getEjbJar

EJBJar getEjbJar()
Returns:
The EjbJar reference

setEjbJar

void setEjbJar(EJBJar value)
Parameters:
value - the new value of the EjbJar reference

getSecurityRoles

org.eclipse.emf.common.util.EList getSecurityRoles()
Returns:
The list of SecurityRoles references

getExcludeList

ExcludeList getExcludeList()
Returns:
The ExcludeList reference

setExcludeList

void setExcludeList(ExcludeList value)
Parameters:
value - the new value of the ExcludeList reference

getMessageDestinations

org.eclipse.emf.common.util.EList getMessageDestinations()
Returns the value of the 'Message Destinations' containment reference list. The list contents are of type MessageDestination.

If the meaning of the 'Message Destinations' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Message Destinations' containment reference list.
See Also:
EjbPackage.getAssemblyDescriptor_MessageDestinations()

removeData

void removeData(EnterpriseBean anEJB)
Remove the MethodElements that are referencing @anEJB.

Parameters:
anEJB - the Enterprise Bean model