com.ibm.portal.resolver.service
Interface PortalPocServiceHome

All Superinterfaces:

CacheFactory, ContentHandlerURIParserFactory, PocServiceHome, PocURIFactory, PooledTransformerFactory

public interface PortalPocServiceHome
extends PocServiceHome

Home interface that can be looked up in JNDI and that provides access to the POC services from the context of a portal request.
Example:

      PortalPocServiceHome psh;
      javax.naming.Context ctx = new javax.naming.InitialContext();
      try {
           psh = (PortalPocServiceHome) 
              ctx.lookup("portal:service/resolver/PocService");
      } catch(javax.naming.NameNotFoundException ex) {
           ... error handling ...
      }
      ...
      // request the service via the home interface
      PortalPocService service = psh.getPortalPocService(request, response);
      ...
      service.dispose();
 
 

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:

6.0.1

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.portal.resolver.service.PocServiceHome

PocServiceHome.FilterType

Field Summary

static java.lang.String	ATTR_CLASS name of the class attribute used for instantiation
static java.lang.String	DEFAULT_EXTENSION_ID ID of the default implementation of the PortalPocServiceHome
static java.lang.String	EXTENSION_POINT_ID ID of the PortalPocServiceHome extension point
static java.lang.String	JNDI_NAME JNDI name of this service

Fields inherited from interface com.ibm.portal.resolver.service.PocServiceHome

CACHED, UNCACHED

Method Summary

ServletContext	createContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Constructs the COR context for request and response
PortalPocService	getPortalPocService(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Returns a PortalPocService instance which is valid within the scope of one request.
void	invalidate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Invalidate cached information in the request or response, e.g.

Methods inherited from interface com.ibm.portal.resolver.service.PocServiceHome

convert, convert, createDigestURI, createDigestURI, createURI, createURI, createURI, getContext, getDataSinkFactory, getDataSinkFactory, getDataSourceFactory, getFileTypeMap, getIdentityTemplates, getInvalidationEventListener, getLookupService, getObjectPoolFactory, getResolutionService, newFilter

Methods inherited from interface com.ibm.portal.resolver.xml.PooledTransformerFactory

newPooledTemplates, newPooledTemplates, newPooledTemplates

Methods inherited from interface com.ibm.portal.resolver.xml.ContentHandlerURIParserFactory

createContentHandlerURIParser

Methods inherited from interface com.ibm.portal.resolver.cache.CacheFactory

getCachedDataSourceFactory, getCachedDataSourceFactory

Field Detail

ATTR_CLASS

static final java.lang.String ATTR_CLASS

name of the class attribute used for instantiation

See Also:

Constant Field Values

DEFAULT_EXTENSION_ID

static final java.lang.String DEFAULT_EXTENSION_ID

ID of the default implementation of the PortalPocServiceHome

See Also:

Constant Field Values

EXTENSION_POINT_ID

static final java.lang.String EXTENSION_POINT_ID

ID of the PortalPocServiceHome extension point

See Also:

Constant Field Values

JNDI_NAME

static final java.lang.String JNDI_NAME

JNDI name of this service

See Also:

Constant Field Values

Method Detail

createContext

ServletContext createContext(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)

Constructs the COR context for request and response

Parameters:

request - the request, not null

response - the response, not null

Returns:

the COR context, not null

Since:

6.1.0.3

getPortalPocService

PortalPocService getPortalPocService(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)
                                     throws StateManagerException

Returns a PortalPocService instance which is valid within the scope of one request. Storing the instance across requests causes errors. Make sure to call Disposable.dispose() on the PortalPocService instance before it leaves scope.

Parameters:

request - The current portal servlet request. Must not be null.

response - The current portal servlet response. Must not be null.

Returns:

A configured PortalPocService instance. Not null.

Throws:

StateManagerException - In case that the service cannot be retrieved.

invalidate

void invalidate(javax.servlet.http.HttpServletRequest request,
                javax.servlet.http.HttpServletResponse response)

Invalidate cached information in the request or response, e.g. because the request or response information changed internally.

Parameters:

request - the request

response - the response

Since:

8.0