com.cassinidivision.oce.rendering
Class OCESession

java.lang.Object
  com.webobjects.appserver.WOSession
      com.cassinidivision.oce.rendering.OCESession

All Implemented Interfaces:

Cloneable, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, PageExpiringSession, PersistentSession, RenderingSession, Serializable

public class OCESession

extends WOSession

implements RenderingSession, PageExpiringSession, PersistentSession

Provides extended session functionality, including persistent session storage handling.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding._BooleanFieldBinding, NSKeyValueCoding._BooleanMethodBinding, NSKeyValueCoding._FieldBinding, NSKeyValueCoding._ForwardingBinding, NSKeyValueCoding._KeyBinding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._MethodBinding, NSKeyValueCoding._NumberFieldBinding, NSKeyValueCoding._NumberMethodBinding, NSKeyValueCoding._ReflectionKeyBindingCreation, NSKeyValueCoding.DefaultImplementation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.Null, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.Utility, NSKeyValueCoding.ValueAccessor

Nested classes inherited from class com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Field Summary

Fields inherited from class com.webobjects.appserver.WOSession

SessionDidCreateNotification, SessionDidRestoreNotification, SessionDidTimeOutNotification

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

_CLASS, NullValue

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Constructor Summary

OCESession()

Method Summary

void	awake()
void	doNotCachePage() Report in responses that the page being generated should not be cached (written to disk, or similar).
NSMutableDictionary	getStateDictionaryForRequest(WORequest r) Restore persistent information for the current session.
static String	persistentSessionPageKey() Retrieve the persistent session key used to access/retrieve the current page version being rendered.
static String	persistentSessionServerNameKey() Retrieve the persistent session key used to access/retrieve the current server name.
static String	persistentSessionStore() Retrieve the filesystem location of the persistent session store.
String	previewTemplate() Retrieve the current previewing component name.
void	reducePageExpiryDurationMinutesTo(int minutes) Reduce the current page expiry period (that will be reported in the response) by the number of minutes requested.
RenderingContext	renderingContext() Supply the publishing system a rendering context set up with necessary publishing information.
RenderingFormatter	renderingFormatter() Provide a default top-level rendering formatter, to be used when required by publishing components.
void	saveStateDictionaryForRequest(WORequest request, WOResponse response) Save current state information to the persistent session store.
static void	setPersistentSessionStore(String storePath) Change the filesystem location of the persistent session store directory.
void	setPreviewTemplate(String woTemplateName) Set the current previewing template to use (by name).
void	setRenderingFormatter(RenderingFormatter aFormatter) Change the current top-level rendering formatter.
NSKeyValueCoding	stateDictionary() Retrieve the persistent state info dictionary for the current session.
String	woTemplateName() Retrieve the current top-level component name.

Methods inherited from class com.webobjects.appserver.WOSession

_appendCookieToResponse, _awakeInContext, _clearCookieFromResponse, _contextCounter, _contextIDMatchingIDs, _keyEnumerator, _requestCounter, _saveCurrentPage, _setContext, _setHttpSession, _setHttpSessionWatcher, _setSessionID, _sleepInContext, _terminateByJ2EE, _terminateByTimeout, allowedToViewEvents, allowedToViewStatistics, appendToResponse, canAccessFieldsDirectly, clone, context, debugString, defaultEditingContext, domainForIDCookies, expirationDateForIDCookies, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, invokeAction, isDistributionEnabled, isTerminating, languages, logString, objectForKey, removeObjectForKey, restorePageForContextID, savePage, savePageInPermanentCache, sessionID, setDefaultEditingContext, setDistributionEnabled, setLanguages, setObjectForKey, setStoresIDsInCookies, setStoresIDsInURLs, setTimeOut, sleep, statistics, storesIDsInCookies, storesIDsInURLs, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, terminate, timeOut, timeOutForIDCookies, timeOutMillis, toString, unableToSetNullForKey, validateEventsLogin, validateStatisticsLogin, validationFailedWithException, valueForKey, valueForKeyPath

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OCESession

public OCESession()

Method Detail

stateDictionary

public NSKeyValueCoding stateDictionary()

Description copied from interface: PersistentSession

Retrieve the persistent state info dictionary for the current session.

Specified by:

stateDictionary in interface PersistentSession

Returns:

The persistent state dictionary.

persistentSessionStore

public static String persistentSessionStore()

Retrieve the filesystem location of the persistent session store.

Returns:

String describing the path to the session store directory.

setPersistentSessionStore

public static void setPersistentSessionStore(String storePath)

Change the filesystem location of the persistent session store directory.

Parameters:

storePath - String describing the path to the session store directory.

awake

public void awake()

persistentSessionPageKey

public static String persistentSessionPageKey()

Retrieve the persistent session key used to access/retrieve the current page version being rendered.

Returns:

String indicating the persistent session key name.

persistentSessionServerNameKey

public static String persistentSessionServerNameKey()

Retrieve the persistent session key used to access/retrieve the current server name.

Returns:

String indicating the persistent session key name.

setPreviewTemplate

public void setPreviewTemplate(String woTemplateName)

Set the current previewing template to use (by name).

Parameters:

woTemplateName - The name of a suitable WOComponent.

previewTemplate

public String previewTemplate()

Retrieve the current previewing component name.

Returns:

The name of a WOComponent.

woTemplateName

public String woTemplateName()

Retrieve the current top-level component name.

Returns:

The name of a WOComponent.

doNotCachePage

public void doNotCachePage()

Description copied from interface: PageExpiringSession

Report in responses that the page being generated should not be cached (written to disk, or similar).

Specified by:

doNotCachePage in interface PageExpiringSession

reducePageExpiryDurationMinutesTo

public void reducePageExpiryDurationMinutesTo(int minutes)

Description copied from interface: PageExpiringSession

Reduce the current page expiry period (that will be reported in the response) by the number of minutes requested.

Specified by:

reducePageExpiryDurationMinutesTo in interface PageExpiringSession

Parameters:

minutes - Integer stating the number of minutes.

getStateDictionaryForRequest

public NSMutableDictionary getStateDictionaryForRequest(WORequest r)

Restore persistent information for the current session.

Parameters:

r - The current WORequest.

Returns:

Dictionary containing the persistent information.

saveStateDictionaryForRequest

public void saveStateDictionaryForRequest(WORequest request,
                                          WOResponse response)

Save current state information to the persistent session store.

Parameters:

request - The current request.

response - The current response being generated.

renderingFormatter

public RenderingFormatter renderingFormatter()

Description copied from interface: RenderingSession

Provide a default top-level rendering formatter, to be used when required by publishing components.

Specified by:

renderingFormatter in interface RenderingSession

Returns:

An appropriate rendering formatter.

setRenderingFormatter

public void setRenderingFormatter(RenderingFormatter aFormatter)

Change the current top-level rendering formatter.

Parameters:

aFormatter - A rendering formatter class instance.

renderingContext

public RenderingContext renderingContext()

Description copied from interface: RenderingSession

Supply the publishing system a rendering context set up with necessary publishing information.

Specified by:

renderingContext in interface RenderingSession

Returns:

A rendering context instance.