atg.epub.servlet
Class VersioningLayerTools

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.epub.servlet.VersioningLayerTools

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 VersioningLayerTools
extends GenericService

Field Summary

static java.lang.String	ACTIVITY_PARAMETER
static java.lang.String	CLASS_VERSION
static java.lang.String	CLEAR_ACTIVITY_VALUE
static java.lang.String	CLEAR_PROJECT_VALUE
static java.lang.String	CLEAR_TASK_VALUE
static java.lang.String	CLEAR_WORKFLOW_VALUE
static java.lang.String	PROJECT_PARAMETER
protected static java.util.ResourceBundle	sLicenseResourceBundle
static java.lang.String	TASK_PARAMETER
static java.lang.String	WORKFLOW_PARAMETER

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

VersioningLayerTools()
Constructor

Method Summary

void	clearPrevProjectInSession(DynamoHttpServletRequest request)
void	clearSuspendedProjectInSession(DynamoHttpServletRequest request)
void	doStartService() This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.
java.lang.String	getActivityInSession(DynamoHttpServletRequest request)
PublishingConfiguration	getConfiguration() Returns the configuration
java.lang.String	getPrevProjectInSession(DynamoHttpServletRequest request)
ProcessHome	getProcessHome()
int	getProjectCacheSize()
atg.epub.servlet.ProjectContext	getProjectContext(DynamoHttpServletRequest request)
Project	getProjectInSession(DynamoHttpServletRequest request)
protected java.lang.String	getResource(java.lang.String pName) Returns the specified resource string
protected java.lang.String	getResource(java.lang.String pName, java.lang.Object[] pArgs) Returns the specified resource string with the substituted args
java.lang.String	getSuspendedProjectInSession(DynamoHttpServletRequest request)
TaskInfo	getTaskInSession(DynamoHttpServletRequest request)
VersionManager	getVersionManager() Returns the versionManager
RepositoryItem	getWorkflowInSession(DynamoHttpServletRequest request)
boolean	isProjectAccessible(Project pProject) Returns true if the underlying object has been removed.
void	resumeProjectContext()
void	setConfiguration(PublishingConfiguration pConfiguration) Sets the configuration
void	setPrevProjectInSession(DynamoHttpServletRequest request, java.lang.String pProjectId)
void	setProjectCacheSize(int i)
boolean	setProjectContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	setProjectContext(java.lang.String pProjectId)
void	setProjectContext(java.lang.String pProjectId, RepositoryItem pWorkflow, java.lang.String pTaskId)
void	setProjectContext(java.lang.String pProjectId, java.lang.String pWorkflowId, java.lang.String pTaskId)
Project	setProjectInSession(DynamoHttpServletRequest request, java.lang.String pProjectId)
void	setSuspendedProjectInSession(DynamoHttpServletRequest request, java.lang.String pProjectId)
void	setVersionManager(VersionManager pVersionManager) Sets the versionManager
void	suspendProjectContext()
void	unsetProjectContext()
void	updatePreviewUrlInSession(java.lang.String pProjectId, DynamoHttpServletRequest pReq) This method updates the preview URL stored in the session if the project changes.
void	updateProjectHistoryInUserProfile(java.lang.String pProjectId)

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, 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

sLicenseResourceBundle

protected static java.util.ResourceBundle sLicenseResourceBundle

PROJECT_PARAMETER

public static final java.lang.String PROJECT_PARAMETER

See Also:

Constant Field Values

TASK_PARAMETER

public static final java.lang.String TASK_PARAMETER

See Also:

Constant Field Values

WORKFLOW_PARAMETER

public static final java.lang.String WORKFLOW_PARAMETER

See Also:

Constant Field Values

ACTIVITY_PARAMETER

public static final java.lang.String ACTIVITY_PARAMETER

See Also:

Constant Field Values

CLEAR_PROJECT_VALUE

public static final java.lang.String CLEAR_PROJECT_VALUE

See Also:

Constant Field Values

CLEAR_WORKFLOW_VALUE

public static final java.lang.String CLEAR_WORKFLOW_VALUE

See Also:

Constant Field Values

CLEAR_TASK_VALUE

public static final java.lang.String CLEAR_TASK_VALUE

See Also:

Constant Field Values

CLEAR_ACTIVITY_VALUE

public static final java.lang.String CLEAR_ACTIVITY_VALUE

See Also:

Constant Field Values

Constructor Detail

VersioningLayerTools

public VersioningLayerTools()

Constructor

Method Detail

getProcessHome

public ProcessHome getProcessHome()

getConfiguration

public PublishingConfiguration getConfiguration()

Returns the configuration

setConfiguration

public void setConfiguration(PublishingConfiguration pConfiguration)

Sets the configuration

getVersionManager

public VersionManager getVersionManager()

Returns the versionManager

setVersionManager

public void setVersionManager(VersionManager pVersionManager)

Sets the versionManager

getProjectCacheSize

public int getProjectCacheSize()

setProjectCacheSize

public void setProjectCacheSize(int i)

doStartService

public void doStartService()
                    throws ServiceException

Description copied from class: GenericService

This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values. The Service should override this method to start any processes it requires.

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if the Service had a problem starting up

getProjectContext

public atg.epub.servlet.ProjectContext getProjectContext(DynamoHttpServletRequest request)

setProjectContext

public boolean setProjectContext(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

setProjectContext

public void setProjectContext(java.lang.String pProjectId)
                       throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

setProjectContext

public void setProjectContext(java.lang.String pProjectId,
                              RepositoryItem pWorkflow,
                              java.lang.String pTaskId)
                       throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

setProjectContext

public void setProjectContext(java.lang.String pProjectId,
                              java.lang.String pWorkflowId,
                              java.lang.String pTaskId)
                       throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

suspendProjectContext

public void suspendProjectContext()
                           throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

resumeProjectContext

public void resumeProjectContext()
                          throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

unsetProjectContext

public void unsetProjectContext()

setProjectInSession

public Project setProjectInSession(DynamoHttpServletRequest request,
                                   java.lang.String pProjectId)
                            throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

getProjectInSession

public Project getProjectInSession(DynamoHttpServletRequest request)

setPrevProjectInSession

public void setPrevProjectInSession(DynamoHttpServletRequest request,
                                    java.lang.String pProjectId)

getPrevProjectInSession

public java.lang.String getPrevProjectInSession(DynamoHttpServletRequest request)

clearPrevProjectInSession

public void clearPrevProjectInSession(DynamoHttpServletRequest request)

setSuspendedProjectInSession

public void setSuspendedProjectInSession(DynamoHttpServletRequest request,
                                         java.lang.String pProjectId)

getSuspendedProjectInSession

public java.lang.String getSuspendedProjectInSession(DynamoHttpServletRequest request)

clearSuspendedProjectInSession

public void clearSuspendedProjectInSession(DynamoHttpServletRequest request)

getTaskInSession

public TaskInfo getTaskInSession(DynamoHttpServletRequest request)

getWorkflowInSession

public RepositoryItem getWorkflowInSession(DynamoHttpServletRequest request)

getActivityInSession

public java.lang.String getActivityInSession(DynamoHttpServletRequest request)

updateProjectHistoryInUserProfile

public void updateProjectHistoryInUserProfile(java.lang.String pProjectId)

updatePreviewUrlInSession

public void updatePreviewUrlInSession(java.lang.String pProjectId,
                                      DynamoHttpServletRequest pReq)

This method updates the preview URL stored in the session if the project changes.

getResource

protected java.lang.String getResource(java.lang.String pName)

Returns the specified resource string

getResource

protected java.lang.String getResource(java.lang.String pName,
                                       java.lang.Object[] pArgs)

Returns the specified resource string with the substituted args

isProjectAccessible

public boolean isProjectAccessible(Project pProject)
                            throws javax.ejb.EJBException

Returns true if the underlying object has been removed. False otherwise.

Throws:

javax.ejb.EJBException