# com.bea.jsptools.portal
PortalEntitlementServlet Class

public abstract class PortalEntitlementServlet
extends `EntitlementServlet`

Hierarchy
  `Object`
  `JspBase`
  `EntitlementServlet`
  `PortalEntitlementServlet`

All Implemented Interfaces
  `HttpJspPage`, `JspPage`, `Servlet`

## Nested Class Summary

`protected class` | `PortalEntitlementServlet.ResourceComposer`

## Field Summary

Fields from com.bea.jsptools.common`.`EntitlementServlet``
`ADD_ACTION, ADD_ALL_ACTION, CAPABILITY_DEPENDENCIES, CAPABILITY_PREFIX, GET_DEFINITION_POLICIES, POLICIES, REMOVE_ACTION, REQUEST_ROLES, ROLE_PRESENT, UPDATE_ACTION, UPDATE_POLICIES, VALUE_DELIMETER`

Fields from weblogic.servlet.jsp`.`JspBase``
`_servletConfig`

## Constructor Summary

PortalEntitlementServlet()

## Method Summary

`public `String`` | `getCapabilityConstant`(`HttpServletRequest` request, `String` capability) Get the constant for the capability
`protected `String`[]` | `getCapabilityDisplayNames`(`HttpServletRequest` request) get the capability names used for display
`protected `String`[]` | `getCapabilityNames`(`HttpServletRequest` request) get the capability names
`protected `String`` | `getDesktopId`(`HttpServletRequest` request) Get the desktop id
`protected `List`` | `getEntitlementPolicyViews`(`HttpServletRequest` request) Gets all security Policies from LDAP.
`public `String`` | `getEntitlementResourceName`(`HttpServletRequest` request, `String` capability, int mode) Over-ridden method from super class.
`protected `String`` | `getLabel`(`HttpServletRequest` request) Get the label
`protected `String`` | `getResourceType`(`HttpServletRequest` request) Get the resource type of the selected resource
`public boolean` | `isValidResource`(`HttpServletRequest` request) Over-ridden method from super class

Methods from `com.bea.jsptools.common.`EntitlementServlet``
`createCheckAllJS, createCheckAllRolesJS, getCapabilityNamesForView, getCapabilityViews, getCheckAllCapabilities, getDefinitionPolicies, getFederatedRoles, getRemainingRoles, getRequestPolicyViews, processAction, unselectAll, updatePolicies`

Methods from `weblogic.servlet.jsp.`JspBase``
`_jspService, destroy, getServletConfig, getServletInfo, init, jspDestroy, jspInit, service`

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods from interface `javax.servlet.jsp.`HttpJspPage``
`_jspService`

Methods from interface `javax.servlet.jsp.`JspPage``
`jspDestroy, jspInit`

Methods from interface `javax.servlet.`Servlet``
`destroy, getServletConfig, getServletInfo, init, service`

## Constructor Detail

### PortalEntitlementServlet

    public PortalEntitlementServlet()

## Method Detail

### getCapabilityConstant(HttpServletRequest, String) Method

    public String getCapabilityConstant(HttpServletRequest request,
                                        String capability)

Get the constant for the capability

Overrides
  EntitlementServlet.getCapabilityConstant(HttpServletRequest, String)

#### Parameters

request
  The http request object

capability

### getCapabilityDisplayNames(HttpServletRequest) Method

    protected String[] getCapabilityDisplayNames(HttpServletRequest request)

get the capability names used for display

### getCapabilityNames(HttpServletRequest) Method

    protected String[] getCapabilityNames(HttpServletRequest request)

get the capability names

### getDesktopId(HttpServletRequest) Method

    protected String getDesktopId(HttpServletRequest request)

Get the desktop id

### getEntitlementPolicyViews(HttpServletRequest) Method

    protected List getEntitlementPolicyViews(HttpServletRequest request)

Description copied from EntitlementServlet.getEntitlementPolicyViews(HttpServletRequest)
Gets all security Policies from LDAP. This stores the results in the request.

Overrides
  EntitlementServlet.getEntitlementPolicyViews(HttpServletRequest)

#### Parameters

request
  HttpServletRequest object

#### Returns

a Sorted list stored within a HashMap that contains all the policies for this container in the form of PolicyByRole object

### getEntitlementResourceName(HttpServletRequest, String, int) Method

    public String getEntitlementResourceName(HttpServletRequest request,
                                             String capability,
                                             int mode)

Over-ridden method from super class.

Overrides
  EntitlementServlet.getEntitlementResourceName(HttpServletRequest, String, int)

#### Parameters

request
  HttpServletRequest object representing the current request

capability
  The capability of the resource

mode
  The implementation class might want to return a different resource name based on the mode. The mode is either GET_DEFINITION_POLICIES or UPDATE_POLICIES

### getLabel(HttpServletRequest) Method

    protected String getLabel(HttpServletRequest request)

Get the label

### getResourceType(HttpServletRequest) Method

    protected String getResourceType(HttpServletRequest request)

Get the resource type of the selected resource

### isValidResource(HttpServletRequest) Method

    public boolean isValidResource(HttpServletRequest request)

Over-ridden method from super class

Overrides
  EntitlementServlet.isValidResource(HttpServletRequest)