com.ibm.portal.spa.service
Interface PortalStaticPageServiceHome

All Superinterfaces:

StaticPageServiceHome

public interface PortalStaticPageServiceHome
extends StaticPageServiceHome

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

      PortalStaticPageServiceHome psh;
      javax.naming.Context ctx = new javax.naming.InitialContext();
      try {
           psh = (PortalStaticPageServiceHome) 
              ctx.lookup(PortalStaticPageServiceHome.JNDI_NAME);
      } catch(javax.naming.NameNotFoundException ex) {
           ... error handling ...
      }
      ...
      // request the service via the home interface
      PortalStaticPageService service = psh.getPortalStaticPageService(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.1.0

Field Summary

static java.lang.String

JNDI_NAME JNDI name of this service

Method Summary

LocalizationURIParserFactory	getLocalizationURIParserFactory(java.lang.Boolean bCached) Returns a parser factory to parse localized templates
PortalStaticPageService	getPortalStaticPageService(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates a new instance of the PortalStaticPageService that is valid for one request.
SkinURIParserFactory	getSkinURIParserFactory(java.lang.Boolean bCached) Returns a parser factory to parse skin templates
ThemeURIParserFactory	getThemeURIParserFactory(java.lang.Boolean bCached) Returns a parser factory to parse theme templates

Methods inherited from interface com.ibm.portal.spa.service.StaticPageServiceHome

createStaticPageContentHandler, createStaticPageContentHandler, createStaticPageContentHandler, createStaticPageZipParser, getFilenameParserFactory, getFileTypeMap, getStaticPageParserFactory

Field Detail

JNDI_NAME

static final java.lang.String JNDI_NAME

JNDI name of this service

See Also:

Constant Field Values

Method Detail

getLocalizationURIParserFactory

LocalizationURIParserFactory getLocalizationURIParserFactory(java.lang.Boolean bCached)

Returns a parser factory to parse localized templates

Parameters:

bCached - flag to indicate if the caching version of the parser should be used

Returns:

the parser factory

Since:

7.0

getPortalStaticPageService

PortalStaticPageService getPortalStaticPageService(javax.servlet.http.HttpServletRequest request,
                                                   javax.servlet.http.HttpServletResponse response)

Creates a new instance of the PortalStaticPageService that is valid for one request. Make sure to call Disposable.dispose() when the service is no longer used.

Parameters:

request - the servlet request

response - the servlet response

Returns:

the instance of the service, not null

getSkinURIParserFactory

SkinURIParserFactory getSkinURIParserFactory(java.lang.Boolean bCached)

Returns a parser factory to parse skin templates

Parameters:

bCached - flag to indicate if the caching version of the parser should be used

Returns:

the parser factory

Since:

7.0

getThemeURIParserFactory

ThemeURIParserFactory getThemeURIParserFactory(java.lang.Boolean bCached)

Returns a parser factory to parse theme templates

Parameters:

bCached - flag to indicate if the caching version of the parser should be used

Returns:

the parser factory

Since:

7.0