org.apache.pluto.descriptors.common
Class SecurityRoleRefDD

java.lang.Object
  extended by org.apache.pluto.descriptors.common.SecurityRoleRefDD

public class SecurityRoleRefDD
extends java.lang.Object

Security Role Reference Configuration.

Since:
Feb 28, 2005 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://www.w3.org/2001/XMLSchema}string" />
     </restriction>
   </complexContent>
 </complexType>
 
Version:
$Id: SecurityRoleRefDD.java 157038 2005-03-11 03:44:40Z ddewolf $

Constructor Summary
SecurityRoleRefDD()
          Default Constructor.
 
Method Summary
 java.lang.String getDescription()
          Retrieve the description of the role reference.
 java.util.List getDescriptions()
          Retrieve the description list.
 java.lang.String getRoleLink()
          Retrieve then role to which the reference is linked.
 java.lang.String getRoleName()
          Retrieve the name of the role reference.
 void setDescription(java.lang.String description)
          Set the description of the role reference.
 void setDescriptions(java.util.List<java.lang.String> descriptions)
          Set the description list.
 void setRoleLink(java.lang.String roleLink)
          Set the role to which the reference is linked.
 void setRoleName(java.lang.String roleName)
          Set the name of the role reference.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SecurityRoleRefDD

public SecurityRoleRefDD()
Default Constructor.

Method Detail

getRoleName

public java.lang.String getRoleName()
Retrieve the name of the role reference.

Returns:

setRoleName

public void setRoleName(java.lang.String roleName)
Set the name of the role reference.

Parameters:
roleName -

getRoleLink

public java.lang.String getRoleLink()
Retrieve then role to which the reference is linked.

Returns:

setRoleLink

public void setRoleLink(java.lang.String roleLink)
Set the role to which the reference is linked.

Parameters:
roleLink -

getDescription

public java.lang.String getDescription()
Retrieve the description of the role reference.

Returns:

setDescription

public void setDescription(java.lang.String description)
Set the description of the role reference.

Parameters:
description -

getDescriptions

public java.util.List getDescriptions()
Retrieve the description list.

Returns:

setDescriptions

public void setDescriptions(java.util.List<java.lang.String> descriptions)
Set the description list.

Parameters:
description -


Copyright © 2003-2009 Apache Software Foundation. All Rights Reserved.