com.webmethods.portal.framework

Interface IPresentationManager

All Superinterfaces:

IComponent, IComponentProvider, IInitializable, IThingComponentProvider, IURIResolver

public interface IPresentationManager
extends IThingComponentProvider

Handles presentation responsibilites for the portal

Field Summary

Fields

Modifier and Type	Field and Description
static String	_PREFIX
static String	CONTENT_PREFIX
static String	CURRENT_REQUEST_URL
static String	CURRENT_REQUEST_URL_KEY
static String	HIDDEN_REQUEST_PARAM
static String	HIDDEN_REQUEST_PARAM_PAIR
static String	PARAM_DYN_RETURN_URL
static String	PARAM_RETURN_URL
static String	PREVIOUS_PREVIOUS_REQUEST_URL
static String	PREVIOUS_PREVIOUS_REQUEST_URL_KEY
static String	PREVIOUS_REQUEST_URL
static String	PREVIOUS_REQUEST_URL_KEY
static String	RENDERER_RULE_FOLDER

Fields inherited from interface com.webmethods.portal.system.IComponentProvider

ATTR_APP_NAME, ATTR_BEG_QUERY, ATTR_END_QUERY, ATTR_MID_QUERY, BIZPOLICY_MANAGER, CACHE_PROVIDER, COMMAND_PROVIDER, COMPONENTS_QUERY, INSTALL_PROVIDER, MECH_PROVIDER, METACONTEXT_PROVIDER, PHASE_PROVIDER, POLICY_PROVIDER, SEARCH_PROVIDER

Method Summary

Modifier and Type	Method and Description
IBrowserBean	getBrowserBean(HttpServletRequest request) Factory to get or create a browser bean instance for the supplied request
IPresentationData	getPresentationData(HttpServletRequest request) Obtain an appropriate presentation data bean
IPresentationData	getPresentationData(HttpServletRequest request, HttpServletResponse response) Deprecated.
void	handlePres(HttpServletRequest request, HttpServletResponse response) Delegate to the appropriate IPresentationHandler
void	overrideLayout(HttpServletRequest request, String layout) Override the default layout for the IPresentationData with the layout parameter
IPresentationData	preparePresentationData(IPresentationData presentationData, HttpServletRequest request, HttpServletResponse response) This method prepares a com.webmethods.portal.framework.presentation.impl.PresentationData for subsequent handling throughout the request.
ISubRenderer	resolveDefaultSubRenderer(IContext context, IURI currentResource) Calculates the default subrenderer for the resource
boolean	setContentType(HttpServletResponse response, IPresentationData pdo) Sets the content-type response header appropriately for the mime-type of the content stream and the charset of the zone.

Methods inherited from interface com.webmethods.portal.system.IThingComponentProvider

getComponentDataXTypeName, getDefaultCategoryName, getRootStorageFolder

Methods inherited from interface com.webmethods.portal.system.IComponentProvider

exists, getComponent, getComponent, getComponent, getComponentQueryString, getComponents, getDefaultComponent, getLogger, initDeferredWebAppComponents, lookup, registerComponent, reloadComponent, reloadComponent, unregisterComponent, upgradeComponentDataFromBootstrapComponentData

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Methods inherited from interface com.webmethods.portal.system.IURIResolver

acquireURI, acquireURI

Field Detail

_PREFIX

static final String _PREFIX

See Also:

Constant Field Values

CURRENT_REQUEST_URL_KEY

static final String CURRENT_REQUEST_URL_KEY

See Also:

Constant Field Values

PREVIOUS_REQUEST_URL_KEY

static final String PREVIOUS_REQUEST_URL_KEY

See Also:

Constant Field Values

PREVIOUS_PREVIOUS_REQUEST_URL_KEY

static final String PREVIOUS_PREVIOUS_REQUEST_URL_KEY

See Also:

Constant Field Values

HIDDEN_REQUEST_PARAM

static final String HIDDEN_REQUEST_PARAM

See Also:

Constant Field Values

HIDDEN_REQUEST_PARAM_PAIR

static final String HIDDEN_REQUEST_PARAM_PAIR

See Also:

Constant Field Values

CURRENT_REQUEST_URL

static final String CURRENT_REQUEST_URL

See Also:

Constant Field Values

PREVIOUS_REQUEST_URL

static final String PREVIOUS_REQUEST_URL

See Also:

Constant Field Values

PREVIOUS_PREVIOUS_REQUEST_URL

static final String PREVIOUS_PREVIOUS_REQUEST_URL

See Also:

Constant Field Values

CONTENT_PREFIX

static final String CONTENT_PREFIX

See Also:

Constant Field Values

PARAM_RETURN_URL

static final String PARAM_RETURN_URL

See Also:

Constant Field Values

PARAM_DYN_RETURN_URL

static final String PARAM_DYN_RETURN_URL

See Also:

Constant Field Values

RENDERER_RULE_FOLDER

static final String RENDERER_RULE_FOLDER

See Also:

Constant Field Values

Method Detail

getPresentationData

@Deprecated
IPresentationData getPresentationData(HttpServletRequest request,
                                                  HttpServletResponse response)
                                           throws PortalException

Deprecated.

Obtain an appropriate presentation data bean

Parameters:

request -

response -

Returns:

Throws:

PortalException

getPresentationData

IPresentationData getPresentationData(HttpServletRequest request)
                               throws PortalException

Obtain an appropriate presentation data bean

Parameters:

request -

response -

Returns:

Throws:

PortalException

preparePresentationData

IPresentationData preparePresentationData(IPresentationData presentationData,
                                          HttpServletRequest request,
                                          HttpServletResponse response)
                                   throws PortalException

This method prepares a com.webmethods.portal.framework.presentation.impl.PresentationData for subsequent handling throughout the request.

Parameters:

request -

response -

Returns:

the IPresentationData

Throws:

PortalException

overrideLayout

void overrideLayout(HttpServletRequest request,
                    String layout)

Override the default layout for the IPresentationData with the layout parameter

setContentType

boolean setContentType(HttpServletResponse response,
                       IPresentationData pdo)

Sets the content-type response header appropriately for the mime-type of the content stream and the charset of the zone.

Returns:

true if the contentType is Compressed, false otherwise

handlePres

void handlePres(HttpServletRequest request,
                HttpServletResponse response)
         throws PortalException

Delegate to the appropriate IPresentationHandler

Parameters:

request -

response -

Throws:

PortalException

resolveDefaultSubRenderer

ISubRenderer resolveDefaultSubRenderer(IContext context,
                                       IURI currentResource)
                                throws PortalException

Calculates the default subrenderer for the resource

Parameters:

context -

currentResource -

Returns:

Throws:

PortalException

getBrowserBean

IBrowserBean getBrowserBean(HttpServletRequest request)

Factory to get or create a browser bean instance for the supplied request

Parameters:

request - the http request to process

Returns:

a browser bean object that describes the details about the supplied request