com.crossingchannels.portal.websphere.specification.jsr286.dom

Class SecurityRoleRefType

java.lang.Object

com.crossingchannels.portal.websphere.specification.jsr286.dom.SecurityRoleRefType

public class SecurityRoleRefType
extends java.lang.Object

The security-role-ref element contains the declaration of a security role reference in the code of the web application. 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 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. Used in: portlet

Java class for security-role-refType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="security-role-refType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="description" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}descriptionType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="role-name" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}role-nameType"/>
         <element name="role-link" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}role-linkType" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}string" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<DescriptionType>	description
protected java.lang.String	id
protected RoleLinkType	roleLink
protected java.lang.String	roleName

Constructor Summary

Constructors

Constructor and Description
SecurityRoleRefType()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<DescriptionType>	getDescription() Gets the value of the description property.
java.lang.String	getId() Gets the value of the id property.
RoleLinkType	getRoleLink() Gets the value of the roleLink property.
java.lang.String	getRoleName() Gets the value of the roleName property.
void	setId(java.lang.String value) Sets the value of the id property.
void	setRoleLink(RoleLinkType value) Sets the value of the roleLink property.
void	setRoleName(java.lang.String value) Sets the value of the roleName property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

description

protected java.util.List<DescriptionType> description

roleName

protected java.lang.String roleName

roleLink

protected RoleLinkType roleLink

id

protected java.lang.String id

Constructor Detail

SecurityRoleRefType

public SecurityRoleRefType()

Method Detail

getDescription

public java.util.List<DescriptionType> getDescription()

Gets the value of the description property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the description property.

For example, to add a new item, do as follows:

    getDescription().add(newItem);
 

Objects of the following type(s) are allowed in the list DescriptionType

getRoleName

public java.lang.String getRoleName()

Gets the value of the roleName property.

Returns:

possible object is String

setRoleName

public void setRoleName(java.lang.String value)

Sets the value of the roleName property.

Parameters:

value - allowed object is String

getRoleLink

public RoleLinkType getRoleLink()

Gets the value of the roleLink property.

Returns:

possible object is RoleLinkType

setRoleLink

public void setRoleLink(RoleLinkType value)

Sets the value of the roleLink property.

Parameters:

value - allowed object is RoleLinkType

getId

public java.lang.String getId()

Gets the value of the id property.

Returns:

possible object is String

setId

public void setId(java.lang.String value)

Sets the value of the id property.

Parameters:

value - allowed object is String