apollo
Class PageManager

java.lang.Object
  |
  +--apollo.PageManager

All Implemented Interfaces:

PageHandler, java.io.Serializable

public class PageManager

extends java.lang.Object

implements java.io.Serializable, PageHandler

This is the PageManager. PageBrokers and TemplatePages will be registered here. TemplatePages are kept here for persistent store, and global availablity. TemplatePages can be retrived using their registered name. Only be be created once per servlet Copyright Joe Kislo, All Rights Reserved.

See Also:

Serialized Form

Constructor Summary

PageManager(ManagerTracker MT, java.lang.String templateDirectoryPrefix)

PageManager(ManagerTracker MT, java.lang.String templateDirectoryPrefix, boolean pageLoadCacheActive, java.lang.String pageLoadCacheFile, boolean pageLoadCacheStrictCompare)

Method Summary

void	addBadGZIPBrowserMatch(java.lang.String s) Adds a substring match to the BadGZIPBrowserMatch vector
void	clearTemplatePages() Clears the list of registered TemplatePages
void	destroy()
java.util.Vector	getBadGZIPBrowserMatch() Returns the vector for substring matches for no GZIP
boolean	getDefaultGZIPEncoding()
FQUIDPermissionsAuthority	getDefaultPermissionsAuthority()
java.lang.String	getFQUID() Return the Fully Qualified Name for this Handler
TemplatePage	getPage(java.lang.String UID) Returns the TemplatePage assosciated with UID
TemplatePage	getPageCacheID(java.lang.String cacheID) Returns the HTMLTemplate loaded from the disk cache.
boolean	getPageLoadCacheActive() Returns if the PageLoadCache is active
boolean	getPageLoadCacheStrictCompare()
java.lang.String	getPermissionsAuthorityName()
java.lang.String	getTemplateDirectoryPrefix() Gets the template directory prefix
java.lang.Object	getTemplatePageConstant(java.lang.String name) return a single page constant
java.util.Hashtable	getTemplatePageConstants() Returns a hastable with the TemplatePage Constants
HTTPResponse	handleRequest(ManagerTracker MT, java.lang.String UID, HTTPRequest req, WebSession thisSession)
HTTPResponse	handleRequest(TransactionTracker TT, java.lang.String UID, HTTPRequest req, WebSession thisSession) Handles a request for UID.
void	loadPageCache()
void	registerRootPageBroker(PageHandler PH) Registers a PageBroker with the UID it will respond to.
void	registerTemplatePage(java.lang.String UID, TemplatePage TP) Registers a TemplatePage with the UID it will respond to.
void	setBadGZIPBrowserMatch(java.util.Vector v) A vector of substrings for which if a browser's Agent tag matches, GZIP will not be used
void	setDefaultGZIPEncoding(boolean b)
void	setDefaultPermissionsAuthority(FQUIDPermissionsAuthority PA)
void	setPermissionsAuthorityName(java.lang.String permissionsAuthorityName)
void	setTemplateDirectoryPrefix(java.lang.String tdp) Sets the template directory prefix
void	setTemplatePageConstant(java.lang.String name, java.lang.Object value) Sets a single page constant to a value
void	setTemplatePageConstants(java.util.Hashtable templatePageConstants) Sets the hashtable for the TemplatePage Constants These constants are merged with the local hashtables for TemplatePage Merging
void	unregisterTemplatePage(java.lang.String UID) Unregisters the assosciated PageTemplate of a particular UID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PageManager

public PageManager(ManagerTracker MT,
                   java.lang.String templateDirectoryPrefix)

PageManager

public PageManager(ManagerTracker MT,
                   java.lang.String templateDirectoryPrefix,
                   boolean pageLoadCacheActive,
                   java.lang.String pageLoadCacheFile,
                   boolean pageLoadCacheStrictCompare)

Method Detail

setDefaultGZIPEncoding

public void setDefaultGZIPEncoding(boolean b)

getDefaultGZIPEncoding

public boolean getDefaultGZIPEncoding()

setBadGZIPBrowserMatch

public void setBadGZIPBrowserMatch(java.util.Vector v)

A vector of substrings for which if a browser's Agent tag matches, GZIP will not be used

addBadGZIPBrowserMatch

public void addBadGZIPBrowserMatch(java.lang.String s)

Adds a substring match to the BadGZIPBrowserMatch vector

getBadGZIPBrowserMatch

public java.util.Vector getBadGZIPBrowserMatch()

Returns the vector for substring matches for no GZIP

getPageLoadCacheActive

public boolean getPageLoadCacheActive()

Returns if the PageLoadCache is active

getPageLoadCacheStrictCompare

public boolean getPageLoadCacheStrictCompare()

loadPageCache

public void loadPageCache()

destroy

public void destroy()

getPageCacheID

public TemplatePage getPageCacheID(java.lang.String cacheID)

Returns the HTMLTemplate loaded from the disk cache. Null if not present

getTemplatePageConstants

public java.util.Hashtable getTemplatePageConstants()

Returns a hastable with the TemplatePage Constants

setTemplatePageConstants

public void setTemplatePageConstants(java.util.Hashtable templatePageConstants)

Sets the hashtable for the TemplatePage Constants These constants are merged with the local hashtables for TemplatePage Merging

setTemplatePageConstant

public void setTemplatePageConstant(java.lang.String name,
                                    java.lang.Object value)

Sets a single page constant to a value

Parameters:

name - The key to set

value - The value of the key

getTemplatePageConstant

public java.lang.Object getTemplatePageConstant(java.lang.String name)

return a single page constant

Parameters:

name - The key to get

registerRootPageBroker

public void registerRootPageBroker(PageHandler PH)

Registers a PageBroker with the UID it will respond to. Only register top level PageHandlers at this level.

Parameters:

PB - The PageHandler to be registered

getFQUID

public java.lang.String getFQUID()

Description copied from interface: PageHandler

Return the Fully Qualified Name for this Handler

Specified by:

getFQUID in interface PageHandler

setTemplateDirectoryPrefix

public void setTemplateDirectoryPrefix(java.lang.String tdp)

Sets the template directory prefix

Parameters:

tdp - The Template Directory Prefix

getTemplateDirectoryPrefix

public java.lang.String getTemplateDirectoryPrefix()

Gets the template directory prefix

registerTemplatePage

public void registerTemplatePage(java.lang.String UID,
                                 TemplatePage TP)

Registers a TemplatePage with the UID it will respond to. Register all TemplatePages at this level using dotted class seperated form.

Parameters:

UID - The Unique ID for this Broker, in dotted class seperated form

TP - The TemplatePage to be registered

unregisterTemplatePage

public void unregisterTemplatePage(java.lang.String UID)

Unregisters the assosciated PageTemplate of a particular UID

Parameters:

UID - The Unique ID for this PageTemplate

getPage

public TemplatePage getPage(java.lang.String UID)

Returns the TemplatePage assosciated with UID

Parameters:

UID - The Unique ID

handleRequest

public HTTPResponse handleRequest(ManagerTracker MT,
                                  java.lang.String UID,
                                  HTTPRequest req,
                                  WebSession thisSession)
                           throws ApolloException

handleRequest

public HTTPResponse handleRequest(TransactionTracker TT,
                                  java.lang.String UID,
                                  HTTPRequest req,
                                  WebSession thisSession)
                           throws ApolloException

Handles a request for UID. Will return special output object soon.

Specified by:

handleRequest in interface PageHandler

Parameters:

UID - The Unique ID for this request

req - The HttpServletRequest

thisSession - The session object for this request (optional)

clearTemplatePages

public void clearTemplatePages()

Clears the list of registered TemplatePages

setPermissionsAuthorityName

public void setPermissionsAuthorityName(java.lang.String permissionsAuthorityName)

getPermissionsAuthorityName

public java.lang.String getPermissionsAuthorityName()

setDefaultPermissionsAuthority

public void setDefaultPermissionsAuthority(FQUIDPermissionsAuthority PA)

getDefaultPermissionsAuthority

public FQUIDPermissionsAuthority getDefaultPermissionsAuthority()