net.sourceforge.ccxjc.it.model.prot.indexed.valueclass.portlet.app100
Class SecurityRoleRefType

java.lang.Object
  net.sourceforge.ccxjc.it.model.prot.indexed.valueclass.portlet.app100.SecurityRoleRefType

All Implemented Interfaces:

Serializable, Cloneable

public class SecurityRoleRefType
extends Object
implements Serializable, Cloneable

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_1_0.xsd}descriptionType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="role-name" type="{http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd}role-nameType"/>
         <element name="role-link" type="{http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd}role-linkType" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}string" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Field Summary

protected DescriptionType[]	description
protected String	id
protected RoleLinkType	roleLink
protected String	roleName

Constructor Summary

SecurityRoleRefType()
Creates a new net.sourceforge.ccxjc.it.model.prot.indexed.valueclass.portlet.app100.SecurityRoleRefType instance.

SecurityRoleRefType(SecurityRoleRefType o)
Creates a new net.sourceforge.ccxjc.it.model.prot.indexed.valueclass.portlet.app100.SecurityRoleRefType instance by copying a given instance.

Method Summary

SecurityRoleRefType	clone() Creates and returns a copy of this object.
protected void	copyDescription(DescriptionType[] source) Copies all values of property Description.
DescriptionType[]	getDescription()
DescriptionType	getDescription(int idx)
int	getDescriptionLength()
String	getId() Gets the value of the id property.
RoleLinkType	getRoleLink() Gets the value of the roleLink property.
String	getRoleName() Gets the value of the roleName property.
void	setDescription(DescriptionType[] values)
DescriptionType	setDescription(int idx, DescriptionType value)
void	setId(String value) Sets the value of the id property.
void	setRoleLink(RoleLinkType value) Sets the value of the roleLink property.
void	setRoleName(String value) Sets the value of the roleName property.

Methods inherited from class java.lang.Object

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

Field Detail

description

protected DescriptionType[] description

roleName

protected String roleName

roleLink

protected RoleLinkType roleLink

id

protected String id

Constructor Detail

SecurityRoleRefType

public SecurityRoleRefType()

Creates a new net.sourceforge.ccxjc.it.model.prot.indexed.valueclass.portlet.app100.SecurityRoleRefType instance.

SecurityRoleRefType

public SecurityRoleRefType(SecurityRoleRefType o)

Creates a new net.sourceforge.ccxjc.it.model.prot.indexed.valueclass.portlet.app100.SecurityRoleRefType instance by copying a given instance.

Parameters:

o - The instance to copy or null.

Method Detail

getDescription

public DescriptionType[] getDescription()

Returns:

array of DescriptionType

getDescription

public DescriptionType getDescription(int idx)

Returns:

one of DescriptionType

getDescriptionLength

public int getDescriptionLength()

setDescription

public void setDescription(DescriptionType[] values)

Parameters:

values - allowed objects are DescriptionType

setDescription

public DescriptionType setDescription(int idx,
                                      DescriptionType value)

Parameters:

value - allowed object is DescriptionType

getRoleName

public String getRoleName()

Gets the value of the roleName property.

Returns:

possible object is String

setRoleName

public void setRoleName(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 String getId()

Gets the value of the id property.

Returns:

possible object is String

setId

public void setId(String value)

Sets the value of the id property.

Parameters:

value - allowed object is String

copyDescription

protected void copyDescription(DescriptionType[] source)

Copies all values of property Description.

Parameters:

source - The source to copy from.

Throws:

NullPointerException - if source is null.

clone

public SecurityRoleRefType clone()

Creates and returns a copy of this object.

Overrides:

clone in class Object

Returns:

A clone of this instance.