com.ibm.workplace.wcm.api.pagecontext
Interface PortalWcmPageContextServiceHome

public interface PortalWcmPageContextServiceHome

Home interface of the WcmPageContextService. An instance can be obtained as follows:

 Context ctx = new InitialContext();
 PortalWcmPageContextServiceHome myHome = (PortalWcmPageContextServiceHome) ctx
       .lookup(PortalWcmPageContextServiceHome.JNDI_NAME);
 

Field Summary

static java.lang.String

JNDI_NAME The JNDI name used to bind the PortalWcmPageContextServiceHome singleton.

Method Summary

WcmPageContextService	getWcmPageContextService(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Gets an instance of the WcmPageContextService.
WcmPageContextService	getWcmPageContextService(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Workspace workspace) Gets an instance of the WcmPageContextService.

Field Detail

JNDI_NAME

static final java.lang.String JNDI_NAME

The JNDI name used to bind the PortalWcmPageContextServiceHome singleton.

See Also:

Constant Field Values

Method Detail

getWcmPageContextService

WcmPageContextService getWcmPageContextService(javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response)
                                               throws com.ibm.workplace.wcm.api.pagecontext.exception.PageContextServiceNotAvailableException

Gets an instance of the WcmPageContextService. When calling this method a new WCM workspace is created. The workspace is ended when calling WcmPageContextService.dispose().

Parameters:

request - HttpServletRequest

response - HttpServletResponse

Returns:

WcmPageContextService

Throws:

com.ibm.workplace.wcm.api.pagecontext.exception.PageContextServiceNotAvailableException

getWcmPageContextService

WcmPageContextService getWcmPageContextService(javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response,
                                               Workspace workspace)
                                               throws com.ibm.workplace.wcm.api.pagecontext.exception.PageContextServiceNotAvailableException

Gets an instance of the WcmPageContextService.

Parameters:

request - HttpServletRequest

response - HttpServletResponse

workspace - WCM workspace to be used by the service.

Returns:

WcmPageContextService

Throws:

com.ibm.workplace.wcm.api.pagecontext.exception.PageContextServiceNotAvailableException