atg.epub

Class PublishingWorkflowAutomator

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.epub.PublishingWorkflowAutomator

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.epub.PublishingWorkflowSession, 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 PublishingWorkflowAutomator
extends GenericService
implements atg.epub.PublishingWorkflowSession

This class wraps the CA API.

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
PublishingWorkflowAutomator()

Method Summary

Modifier and Type	Method and Description
void	abandonWorkflowSession(atg.epub.PublishingSession pSession) abandonWorkflowSession This method is called in order to abandon the publishing workflow session (i.e.
void	bindThreadToWorkflowSession(atg.epub.PublishingSession pSession) bindThreadToWorkflowSession This method is called when some repository work is carried out in a thread, which is separate from the main thread (i.e.
void	doStartService() doStartService This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.
void	doStopService() doStopService This is called when a Service is required to shut down.
void	endWorkflowSession(atg.epub.PublishingSession pSession) endWorkflowSession This method is called after the completion of the repository work, in order to complete the CA project.
java.lang.String	getActivityId() Gets the optional activity id to set on the project.
java.lang.String	getPersonaPrefix() Get the PersonaPrefix which is supplied for login.
protected java.lang.String	getProjectName(java.lang.String pSessionId) Method to build a project name to use.
java.lang.String	getProjectNameStub() Get the projectNameStub.
java.lang.String	getTaskOutcomeId() Get the taskOutcomeId.
javax.transaction.TransactionManager	getTransactionManager() Set the transaction manager.
UserDirectoryUserAuthority	getUserAuthority() Set the UserAuthority
java.lang.String	getUserName() Get the UserName which is supplied upon check-in and for logging in.
VersionManager	getVersionManager() Get the versionManager.
WorkflowManager	getWorkflowManager() Set the workflowManager.
java.lang.String	getWorkflowName() Get the workflowName property
void	setActivityId(java.lang.String pActivityId) Sets the optional activity id to set on the project.
void	setPersonaPrefix(java.lang.String pPersonaPrefix) Set the PersonaPrefix
void	setProjectNameStub(java.lang.String pProjectNameStub) Set the projectNameStub.
void	setTaskOutcomeId(java.lang.String pTaskOutcomeId) Set the taskOutcomeId.
void	setTransactionManager(javax.transaction.TransactionManager pTransactionManager) Get the transaction manager.
void	setUserAuthority(UserDirectoryUserAuthority pUserAuthority) Get the UserAuthority
void	setUserName(java.lang.String pUserName) Set the UserName
void	setVersionManager(VersionManager pVersionManager) Set the versionManager.
void	setWorkflowManager(WorkflowManager pWorkflowManager) Get the workflowManager.
void	setWorkflowName(java.lang.String string) Set the workflowName property
atg.epub.PublishingSession	startWorkflowSession(java.lang.String pSessionId) startWorkflowSession This method is called to set up a publishing workflow session and to set up a CA project context for the current thread.

Methods inherited from class atg.nucleus.GenericService

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

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, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

PublishingWorkflowAutomator

public PublishingWorkflowAutomator()

Method Detail

getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()

Set the transaction manager.

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)

Get the transaction manager.

getVersionManager

public VersionManager getVersionManager()

Get the versionManager.

setVersionManager

public void setVersionManager(VersionManager pVersionManager)

Set the versionManager.

getWorkflowManager

public WorkflowManager getWorkflowManager()

Set the workflowManager.

setWorkflowManager

public void setWorkflowManager(WorkflowManager pWorkflowManager)

Get the workflowManager.

getUserAuthority

public UserDirectoryUserAuthority getUserAuthority()

Set the UserAuthority

setUserAuthority

public void setUserAuthority(UserDirectoryUserAuthority pUserAuthority)

Get the UserAuthority

getPersonaPrefix

public java.lang.String getPersonaPrefix()

Get the PersonaPrefix which is supplied for login.

setPersonaPrefix

public void setPersonaPrefix(java.lang.String pPersonaPrefix)

Set the PersonaPrefix

getUserName

public java.lang.String getUserName()

Get the UserName which is supplied upon check-in and for logging in.

setUserName

public void setUserName(java.lang.String pUserName)

Set the UserName

getWorkflowName

public java.lang.String getWorkflowName()

Get the workflowName property

setWorkflowName

public void setWorkflowName(java.lang.String string)

Set the workflowName property

getTaskOutcomeId

public java.lang.String getTaskOutcomeId()

Get the taskOutcomeId.

setTaskOutcomeId

public void setTaskOutcomeId(java.lang.String pTaskOutcomeId)

Set the taskOutcomeId.

getProjectNameStub

public java.lang.String getProjectNameStub()

Get the projectNameStub.

setProjectNameStub

public void setProjectNameStub(java.lang.String pProjectNameStub)

Set the projectNameStub.

getActivityId

public java.lang.String getActivityId()

Gets the optional activity id to set on the project.

Returns:

The activity id.

setActivityId

public void setActivityId(java.lang.String pActivityId)

Sets the optional activity id to set on the project.

Parameters:

pActivityId - The activity id.

startWorkflowSession

public atg.epub.PublishingSession startWorkflowSession(java.lang.String pSessionId)
                                                throws atg.epub.PublishingWorkflowException

startWorkflowSession This method is called to set up a publishing workflow session and to set up a CA project context for the current thread.

Specified by:

startWorkflowSession in interface atg.epub.PublishingWorkflowSession

Parameters:

pSessionId - - a unique session id, which is used to create the CA project name.

Returns:

- the PublishingWorkflowSession object.

Throws:

atg.epub.PublishingWorkflowException

getProjectName

protected java.lang.String getProjectName(java.lang.String pSessionId)

Method to build a project name to use.

bindThreadToWorkflowSession

public void bindThreadToWorkflowSession(atg.epub.PublishingSession pSession)
                                 throws atg.epub.PublishingWorkflowException

bindThreadToWorkflowSession This method is called when some repository work is carried out in a thread, which is separate from the main thread (i.e. the thread which called the startWorkflowSession method). This method is called for each child thread so that they are all tied to the workspace / project.

Specified by:

bindThreadToWorkflowSession in interface atg.epub.PublishingWorkflowSession

Parameters:

pSession - - the publishing workflow session.

Throws:

atg.epub.PublishingWorkflowException

abandonWorkflowSession

public void abandonWorkflowSession(atg.epub.PublishingSession pSession)
                            throws atg.epub.PublishingWorkflowException

abandonWorkflowSession This method is called in order to abandon the publishing workflow session (i.e. project and workflow), at any point in between the startWorkflowSession and endWorkflowSession calls.

Specified by:

abandonWorkflowSession in interface atg.epub.PublishingWorkflowSession

Parameters:

pSession - - the publishing workflow session.

Throws:

atg.epub.PublishingWorkflowException

endWorkflowSession

public void endWorkflowSession(atg.epub.PublishingSession pSession)
                        throws atg.epub.PublishingWorkflowException

endWorkflowSession This method is called after the completion of the repository work, in order to complete the CA project.

Specified by:

endWorkflowSession in interface atg.epub.PublishingWorkflowSession

Parameters:

pSession - - the publishing workflow session.

Throws:

atg.epub.PublishingWorkflowException

doStartService

public void doStartService()

doStartService This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.

Overrides:

doStartService in class GenericService

doStopService

public void doStopService()

doStopService This is called when a Service is required to shut down.

Overrides:

doStopService in class GenericService