ServletAttributeUtil (Oracle WebCenter Content Site Studio for External Applications Java API Reference)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle® WebCenter Content Site Studio for External Applications Java API Reference
11g Release 1 (11.1.1)
E17273-03

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.stellent.wcm.common.servlet
Class ServletAttributeUtil

java.lang.Object oracle.stellent.wcm.common.servlet.ServletAttributeUtil

public abstract class ServletAttributeUtil

extends java.lang.Object

Utility methods for servlet attributes.

Constructor Summary
`ServletAttributeUtil()`

Method Summary
`static java.lang.Object`	`findAttribute(javax.servlet.http.HttpServletRequest request, java.lang.String name)` Find an attribute value; looks first in request scope, then session, then application.
`static java.lang.Object`	`getAttribute(javax.servlet.http.HttpServletRequest request, java.lang.String name, int scope)` Get an attribute value at the given scope
`static void`	`removeAttribute(javax.servlet.http.HttpServletRequest request, java.lang.String name, int scope)` Remove an attribute value at the given scope
`static void`	`setAttribute(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.Object value, int scope)` Set an attribute value at the given scope

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

Constructor Detail

ServletAttributeUtil

public ServletAttributeUtil()

Method Detail

setAttribute

public static void setAttribute(javax.servlet.http.HttpServletRequest request,
                                java.lang.String name,
                                java.lang.Object value,
                                int scope)

Set an attribute value at the given scope

Parameters:: request - the request; name - the attribute name; value - the attribute value; scope - the scope (from PageContext constants)

getAttribute

public static java.lang.Object getAttribute(javax.servlet.http.HttpServletRequest request,
                                            java.lang.String name,
                                            int scope)

Get an attribute value at the given scope

Parameters:: request - the request; name - the attribute name; scope - the scope (from PageContext constants)
Returns:: the value or null if not found

removeAttribute

public static void removeAttribute(javax.servlet.http.HttpServletRequest request,
                                   java.lang.String name,
                                   int scope)

Remove an attribute value at the given scope

Parameters:: request - the request; name - the attribute name; scope - the scope (from PageContext constants)

findAttribute

public static java.lang.Object findAttribute(javax.servlet.http.HttpServletRequest request,
                                             java.lang.String name)

Find an attribute value; looks first in request scope, then session, then application.

Parameters:: request - the request; name - the attribute name
Returns:: the first value found or null if not found