com.bowstreet.adapters
Interface Constants

public interface Constants

Constants for use across portlet adapters and use of those adapters

Field Summary

static java.lang.String	BACKCHANNEL_URL_MAPPER Similar to above: request key for URLMapper instance used to do data-providing (not page-oriented) requests.
static java.lang.String	PARTIAL_PAGE_REFRESH_URL_MAPPER String constant for key of request attribute holding a URLMapper instance that should be used for partial-page refresh access.
static java.lang.String	PORTAL_SERVER_INFO String constant for key of request attribute referencing portal server info.
static java.lang.String	PORTLET_CONFIG String constant for key of request attribute reference to PortletConfig.
static java.lang.String	PORTLET_CONTAINER_JSR168 String constant for JSR168 Portlet Container type
static java.lang.String	PORTLET_CONTAINER_JSR286 String constant for JSR286 Portlet Container type
static java.lang.String	PORTLET_CONTAINER_OP String constant for Oracle Portal JPDK Portlet container type
static java.lang.String	PORTLET_CONTAINER_TYPE String constant for key of request attribute referencing portlet container type.
static java.lang.String	PORTLET_CONTAINER_WP String constant for WebSphere Portal container type
static java.lang.String	PORTLET_REQUEST String constant for key of request attribute reference to PortletRequest.
static java.lang.String	PORTLET_RESPONSE String constant for key of request attribute reference to PortletResponse.
static java.lang.String	PPR_MAPPER_DOES_REFRESH If this request attribute is set, the mapper specified by PARTIAL_PAGE_REFRESH_URL_MAPPER always refreshes the outermost page.
static java.lang.String	REMAIN_IN_CUSTOMIZER_PROPERTY String constant for key of request attribute to specify to the portlet adapter to remain in the customizer after an Update action.
static java.lang.String	RUNTIME_PLATFORM_TYPE_ATTRIBUTE Session attribute that may hold an instance of com.bowstreet.webapp.RuntimePlatformType.

Field Detail

BACKCHANNEL_URL_MAPPER

static final java.lang.String BACKCHANNEL_URL_MAPPER

Similar to above: request key for URLMapper instance used to do data-providing (not page-oriented) requests. May yield a null URLMapper.

See Also:

Constant Field Values

PARTIAL_PAGE_REFRESH_URL_MAPPER

static final java.lang.String PARTIAL_PAGE_REFRESH_URL_MAPPER

String constant for key of request attribute holding a URLMapper instance that should be used for partial-page refresh access. Will be null in many portals - currently only implemented in WebSphere Portal 6.1+.

See Also:

Constant Field Values

PORTAL_SERVER_INFO

static final java.lang.String PORTAL_SERVER_INFO

String constant for key of request attribute referencing portal server info. Portal Server Info, if available from the portlet API (eg, "IBM WebSphere Portal/5.1" ) Set by the portlet adapter per request.

See Also:

Constant Field Values

PORTLET_CONFIG

static final java.lang.String PORTLET_CONFIG

String constant for key of request attribute reference to PortletConfig. The Portlet Adapter saves a reference to the PortletConfig object in the servlet request attributes, so that ref may be retrieved in WebApp methods if necessary to make PortletConfig API calls.

See Also:

Constant Field Values

PORTLET_CONTAINER_JSR168

static final java.lang.String PORTLET_CONTAINER_JSR168

String constant for JSR168 Portlet Container type

See Also:

Constant Field Values

PORTLET_CONTAINER_JSR286

static final java.lang.String PORTLET_CONTAINER_JSR286

String constant for JSR286 Portlet Container type

See Also:

Constant Field Values

PORTLET_CONTAINER_OP

static final java.lang.String PORTLET_CONTAINER_OP

String constant for Oracle Portal JPDK Portlet container type

See Also:

Constant Field Values

PORTLET_CONTAINER_TYPE

static final java.lang.String PORTLET_CONTAINER_TYPE

String constant for key of request attribute referencing portlet container type. Can be used to determine which Portal/Portlet Container you're running under (eg, WP for WebSphere Portal portlet, OP for Oracle Portal JPDK portlet, JSR168 for any JSR168 Portlet Container). Set by the portlet adapter per request.

See Also:

Constant Field Values

PORTLET_CONTAINER_WP

static final java.lang.String PORTLET_CONTAINER_WP

String constant for WebSphere Portal container type

See Also:

Constant Field Values

PORTLET_REQUEST

static final java.lang.String PORTLET_REQUEST

String constant for key of request attribute reference to PortletRequest. The Portlet Adapter saves a reference to the PortletRequest object in the servlet request attributes, so that ref may be retrieved in WebApp methods if necessary to make PortletRequest API calls.

See Also:

Constant Field Values

PORTLET_RESPONSE

static final java.lang.String PORTLET_RESPONSE

String constant for key of request attribute reference to PortletResponse. The Portlet Adapter saves a reference to the PortletResponse object in the servlet request attributes, so that ref may be retrieved in WebApp methods if necessary to make PortletResponse API calls.

See Also:

Constant Field Values

PPR_MAPPER_DOES_REFRESH

static final java.lang.String PPR_MAPPER_DOES_REFRESH

If this request attribute is set, the mapper specified by PARTIAL_PAGE_REFRESH_URL_MAPPER always refreshes the outermost page.

See Also:

Constant Field Values

REMAIN_IN_CUSTOMIZER_PROPERTY

static final java.lang.String REMAIN_IN_CUSTOMIZER_PROPERTY

String constant for key of request attribute to specify to the portlet adapter to remain in the customizer after an Update action. Typically this attribute would be set to "true" if there were errors on an input form (e.g. missing required inputs).

See Also:

Constant Field Values

RUNTIME_PLATFORM_TYPE_ATTRIBUTE

static final java.lang.String RUNTIME_PLATFORM_TYPE_ATTRIBUTE

Session attribute that may hold an instance of com.bowstreet.webapp.RuntimePlatformType.

See Also:

Constant Field Values