com.ibm.portal.state.accessors.url
Interface ResolvedUrlAccessFactory

All Superinterfaces:

AccessorFactory

public interface ResolvedUrlAccessFactory
extends AccessorFactory

The ResolvedUrlAccessFactory provides means to create EngineURL objects based on alias names to predefined URLs.

The alias names need to be stored under the JNDI root context portal/url/template.

NOTE: This API may only be used in the scope of an HTTP request in WebSphere Portal, i.e. within a theme. The API can not be invoked directly by a custom servlet.

Since:

5.1

Field Summary

static java.lang.String

JNDI_ROOT_CONTEXT define the context root for the JNDI lookup

Method Summary

EngineURL	newURL(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, java.lang.String aliasName, Constants.Merge mergeType) This method takes the provided request and fills the state holder based on the state associated with this request.
EngineURL	newURL(javax.servlet.http.HttpServletRequest req, java.lang.String aliasName, Constants.Merge mergeType) Deprecated. This method takes the provided request and fills the state holder based on the state associated with this request. Then the state that is provided via the alias name is retrieved and merged into the state of the current request.

Methods inherited from interface com.ibm.portal.state.accessors.AccessorFactory

compact

Field Detail

JNDI_ROOT_CONTEXT

static final java.lang.String JNDI_ROOT_CONTEXT

define the context root for the JNDI lookup

See Also:

Constant Field Values

Method Detail

newURL

EngineURL newURL(javax.servlet.http.HttpServletRequest req,
                 javax.servlet.http.HttpServletResponse resp,
                 java.lang.String aliasName,
                 Constants.Merge mergeType)
                 throws AliasNameNotFoundException,
                        InputMediatorException,
                        StateNotInRequestException,
                        DocumentModelException,
                        java.io.IOException

This method takes the provided request and fills the state holder based on the state associated with this request. Then the state that is provided via the alias name is retrieved and merged into the state of the current request.

Parameters:

req - servlet request to retrieve server, portal and context information from

resp - servlet response, required to perform encodeURL

aliasName - alias name for retriving the state

mergeType - defines the algorithm to use for the merging

Returns:

engine URL object

Throws:

AliasNameNotFoundException - - if the aliasName cannot be resolved

InputMediatorException - - if the state could not be decoded

StateNotInRequestException - - if the base could not be found in the request

DocumentModelException - - if the state handling went wrong

java.io.IOException - - if an error occurred during state transfer

newURL

EngineURL newURL(javax.servlet.http.HttpServletRequest req,
                 java.lang.String aliasName,
                 Constants.Merge mergeType)
                 throws AliasNameNotFoundException,
                        InputMediatorException,
                        StateNotInRequestException,
                        DocumentModelException,
                        java.io.IOException

Deprecated. This method takes the provided request and fills the state holder based on the state associated with this request. Then the state that is provided via the alias name is retrieved and merged into the state of the current request.

Parameters:

req - servlet request to retrieve server, portal and context information from

aliasName - alias name for retriving the state

mergeType - defines the algorithm to use for the merging

Returns:

engine URL object

Throws:

AliasNameNotFoundException - - if the aliasName cannot be resolved

InputMediatorException - - if the state could not be decoded

StateNotInRequestException - - if the base could not be found in the request

DocumentModelException - - if the state handling went wrong

java.io.IOException - - if an error occurred during state transfer