Top Description Fields Constructors Methods
javax.portlet

public Class PortletSessionUtil

extends Object
Class Inheritance
The PortletSessionUtil class helps identify and decode attributes in the PORTLET_SCOPE scope of the PortletSession when accessed through the HttpSession an from within calls to methods of the HttpSessionBindingListener interface.

Field Summary

Modifier and TypeField and Description
private static final String
PORTLET_SCOPE_NAMESPACE

Constructor Summary

AccessConstructor and Description
public
PortletSessionUtil()

Method Summary

Modifier and TypeMethod and Description
public static String

Returns:

the decoded attribute name
decodeAttributeName(String
a string specifying the name of the encoded portlet attribute
name)

Returns the attribute name of an attribute in the PORTLET_SCOPE.

public static int

Returns:

the decoded attribute scope
decodeScope(String
a string specifying the name of the encoded portlet attribute
name)

Returns the portlet attribute scope from an encoded portlet attribute.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

PORTLET_SCOPE_NAMESPACEback to summary
private static final String PORTLET_SCOPE_NAMESPACE

Constructor Detail

PortletSessionUtilback to summary
public PortletSessionUtil()

Method Detail

decodeAttributeNameback to summary
public static String decodeAttributeName(String name)

Returns the attribute name of an attribute in the PORTLET_SCOPE. If the attribute is in the APPLICATION_SCOPE it returns the attribute name unchanged.

Parameters
name:String

a string specifying the name of the encoded portlet attribute

Returns:String

the decoded attribute name

decodeScopeback to summary
public static int decodeScope(String name)

Returns the portlet attribute scope from an encoded portlet attribute.
Possible return values are:

  • PortletSession.APPLICATION_SCOPE
  • PortletSession.PORTLET_SCOPE
Parameters
name:String

a string specifying the name of the encoded portlet attribute

Returns:int

the decoded attribute scope

See Also
PortletSession