org.eclipse.modisco.jee.ejbjar.EjbJar21
Interface SecurityRoleRefType


public interface SecurityRoleRefType

A representation of the model object 'Security Role Ref Type'. The security-role-refType contains the declaration of a security role reference in a component's or a Deployment Component's code. The declaration consists of an optional description, the security role name used in the code, and an optional link to a security role. If the security role is not specified, the Deployer must choose an appropriate security role.

The following features are supported:

See Also:
EjbJar21Package.getSecurityRoleRefType()
Generated:
Model:
extendedMetaData="name='security-role-refType' kind='elementOnly'"

Method Summary
  getDescription()
          Returns the value of the 'Description' containment reference list.
 java.lang.String getId()
          Returns the value of the 'Id' attribute.
 RoleNameType getRoleLink()
          Returns the value of the 'Role Link' containment reference.
 RoleNameType getRoleName()
          Returns the value of the 'Role Name' containment reference.
 void setId(java.lang.String value)
          Sets the value of the 'Id' attribute.
 void setRoleLink(RoleNameType value)
          Sets the value of the 'Role Link' containment reference.
 void setRoleName(RoleNameType value)
          Sets the value of the 'Role Name' containment reference.
 

Method Detail

getDescription

 getDescription()
Returns the value of the 'Description' containment reference list. The list contents are of type DescriptionType.

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

Returns:
the value of the 'Description' containment reference list.
See Also:
EjbJar21Package.getSecurityRoleRefType_Description()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='description' namespace='http://java.sun.com/xml/ns/j2ee'"

getRoleName

RoleNameType getRoleName()
Returns the value of the 'Role Name' containment reference. The value of the role-name element must be the String used as the parameter to the EJBContext.isCallerInRole(String roleName) method or the HttpServletRequest.isUserInRole(String role) method.

Returns:
the value of the 'Role Name' containment reference.
See Also:
setRoleName(RoleNameType), EjbJar21Package.getSecurityRoleRefType_RoleName()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='role-name' namespace='http://java.sun.com/xml/ns/j2ee'"

setRoleName

void setRoleName(RoleNameType value)
Sets the value of the 'Role Name' containment reference.

Parameters:
value - the new value of the 'Role Name' containment reference.
See Also:
getRoleName()
Generated:

getRoleLink

RoleNameType getRoleLink()
Returns the value of the 'Role Link' containment reference. The role-link element is a reference to a defined security role. The role-link element must contain the name of one of the security roles defined in the security-role elements.

Returns:
the value of the 'Role Link' containment reference.
See Also:
setRoleLink(RoleNameType), EjbJar21Package.getSecurityRoleRefType_RoleLink()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='role-link' namespace='http://java.sun.com/xml/ns/j2ee'"

setRoleLink

void setRoleLink(RoleNameType value)
Sets the value of the 'Role Link' containment reference.

Parameters:
value - the new value of the 'Role Link' containment reference.
See Also:
getRoleLink()
Generated:

getId

java.lang.String getId()
Returns the value of the 'Id' attribute.

If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Id' attribute.
See Also:
setId(String), EjbJar21Package.getSecurityRoleRefType_Id()
Generated:
Model:
id="true" dataType="org.eclipse.emf.ecore.xml.type.ID" extendedMetaData="kind='attribute' name='id'"

setId

void setId(java.lang.String value)
Sets the value of the 'Id' attribute.

Parameters:
value - the new value of the 'Id' attribute.
See Also:
getId()
Generated: