atg.rest
Class SessionConfirmation

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.rest.SessionConfirmation

All Implemented Interfaces:

atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class SessionConfirmation
extends GenericService

A class to expose the session confirmation number via a nucleus component.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

SessionConfirmation()
Constructor

Method Summary

long	getSessionConfirmationNumber() Returns the session confirmation number
boolean	isEnforceReadOnce() If set to true, only allow the session confirmation number to be read once per session, throwing an IllegalStateException on subsequent reads.
boolean	isRead() Initially set to false, this property reflects whether or not the session confirmation number has already been read for the current session.
void	setEnforceReadOnce(boolean pEnforceReadOnce)

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

SessionConfirmation

public SessionConfirmation()

Constructor

Method Detail

isEnforceReadOnce

public boolean isEnforceReadOnce()

If set to true, only allow the session confirmation number to be read once per session, throwing an IllegalStateException on subsequent reads. If false, does not throw an exception and allows the SCN to be read multiple times. Defaults to true.

Returns:

true if enforcing read once for the session confirmation number

setEnforceReadOnce

public void setEnforceReadOnce(boolean pEnforceReadOnce)

Parameters:

pEnforceReadOnce - the value of enforceReadOnce

isRead

public boolean isRead()

Initially set to false, this property reflects whether or not the session confirmation number has already been read for the current session. The session confirmation number can only be read once per session, usually at login.

Returns:

true if the value has been read for the current session, false otherwise

getSessionConfirmationNumber

public long getSessionConfirmationNumber()

Returns the session confirmation number

Returns:

the session confirmation number

Throws:

java.lang.IllegalStateException - if the session confirmation number has already been read for the current session