com.sssw.portal.api
Interface EbiURICacheManager

public interface EbiURICacheManager

This provides an interface for the portal page manager.

Field Summary

static String	PORTAL_URI_CACHE_MGR No information available
static String	URI_DOM_CACHE_HOLDER_ID No information available
static String	URI_DTM_CACHE_HOLDER_ID No information available
static String	URI_STR_CACHE_HOLDER_ID No information available

Method Summary

void	cancelSchedule(EbiPortalContext context, String uri) cancel the scheduled refresh
void	dump(EbiPortalContext context) clear the caches
Document	getDomContent(EbiPortalContext context, String URI) Gets the DOM content of the specified xsl style
Document	getDomContent(EbiPortalContext context, String URI, boolean flush) Gets the DOM content of the specified xsl style
org.apache.xalan.templates.StylesheetRoot	getDtmContent(EbiPortalContext context, String URI) Gets the DTM content of the specified xsl style
org.apache.xalan.templates.StylesheetRoot	getDtmContent(EbiPortalContext context, String URI, boolean flush) Gets the DTM content of the specified xsl style
String	getManagerName() Gets the mananger's name
String	getStringContent(EbiPortalContext context, String URI) Gets the String content of the specified xsl style
String	getStringContent(EbiPortalContext context, String URI, boolean flush) Gets the String content of the specified xsl style
void	schedule(EbiPortalContext context, String uri, Date date) register to refresh on the specific date and time
void	schedule(EbiPortalContext context, String uri, long interval, boolean sinceLasstEvent) register to refresh the cache peroidically
void	updateCache(EbiPortalContext context, String uri) update the caches, reget the content from the URI

Field Detail

PORTAL_URI_CACHE_MGR

public static final String PORTAL_URI_CACHE_MGR

No information available

URI_DOM_CACHE_HOLDER_ID

public static final String URI_DOM_CACHE_HOLDER_ID

No information available

URI_DTM_CACHE_HOLDER_ID

public static final String URI_DTM_CACHE_HOLDER_ID

No information available

URI_STR_CACHE_HOLDER_ID

public static final String URI_STR_CACHE_HOLDER_ID

No information available

Method Detail

getManagerName

public String getManagerName()

Gets the mananger's name

Returns:

the name of the manager.

getDomContent

public Document getDomContent(EbiPortalContext context,
                              String URI)
                       throws EboUnrecoverableSystemException

Gets the DOM content of the specified xsl style

Parameters:

context - framework context

URI - the URI string.
If getting the style locally, the URI should start with local://. If getting the style remotely, teh URI should start with http://. If the protocol is missing, the URI will be treated as local address.

Returns:

The document represents the style document

getDtmContent

public org.apache.xalan.templates.StylesheetRoot getDtmContent(EbiPortalContext context,
                                                               String URI)
                                                        throws EboUnrecoverableSystemException

Gets the DTM content of the specified xsl style

Parameters:

context - framework context

URI - the URI string
If getting the style locally, the URI should start with local://. If getting the style remotely, teh URI should start with http://. If the protocol is missing, the URI will be treated as local address.

Returns:

The StylesheetRoot represents the compiled style document

getStringContent

public String getStringContent(EbiPortalContext context,
                               String URI)
                        throws EboUnrecoverableSystemException

Gets the String content of the specified xsl style

Parameters:

context - framework context

URI - the URI string
If getting the style locally, the URI should start with local://. If getting the style remotely, the URI should start with http://. If the protocol is missing, the URI will be treated as local address.

Returns:

The string representation of the style

getDomContent

public Document getDomContent(EbiPortalContext context,
                              String URI,
                              boolean flush)
                       throws EboUnrecoverableSystemException

Gets the DOM content of the specified xsl style

Parameters:

context - framework context

URI - the URI string.
If getting the style locally, the URI should start with local://. If getting the style remotely, teh URI should start with http://. If the protocol is missing, the URI will be treated as local address.

flush - set to true to always get the fresh content

Returns:

The document represents the style document

getDtmContent

public org.apache.xalan.templates.StylesheetRoot getDtmContent(EbiPortalContext context,
                                                               String URI,
                                                               boolean flush)
                                                        throws EboUnrecoverableSystemException

Gets the DTM content of the specified xsl style

Parameters:

context - framework context

URI - the URI string
If getting the style locally, the URI should start with local://. If getting the style remotely, teh URI should start with http://. If the protocol is missing, the URI will be treated as local address.

flush - set to true to always get the fresh content

Returns:

The StylesheetRoot represents the compiled style document

getStringContent

public String getStringContent(EbiPortalContext context,
                               String URI,
                               boolean flush)
                        throws EboUnrecoverableSystemException

Gets the String content of the specified xsl style

Parameters:

context - framework context

URI - the URI string
If getting the style locally, the URI should start with local://. If getting the style remotely, the URI should start with http://. If the protocol is missing, the URI will be treated as local address.

flush - set to true to always get the fresh content

Returns:

The string representation of the style

updateCache

public void updateCache(EbiPortalContext context,
                        String uri)
                 throws EboUnrecoverableSystemException

update the caches, reget the content from the URI

Parameters:

context - framework context

uri - the uri string

dump

public void dump(EbiPortalContext context)
          throws EboUnrecoverableSystemException

clear the caches

Parameters:

context - framework context

schedule

public void schedule(EbiPortalContext context,
                     String uri,
                     long interval,
                     boolean sinceLasstEvent)
              throws EboUnrecoverableSystemException

register to refresh the cache peroidically

Parameters:

context - framework context

uri - the uri string

interval - Delta time in milliseconds

sinceLastEvent - true -- next event happens in a time period since last event, false -- next event happens in a time period from current time

schedule

public void schedule(EbiPortalContext context,
                     String uri,
                     Date date)
              throws EboUnrecoverableSystemException

register to refresh on the specific date and time

Parameters:

context - framework context

uri - the uri string

date - the specific date and time that the cache update will happen

cancelSchedule

public void cancelSchedule(EbiPortalContext context,
                           String uri)
                    throws EboUnrecoverableSystemException

cancel the scheduled refresh

Parameters:

context - framework context

uri - the uri string