Package de.uplanet.lucy.server.workflow.eventsource

Class AbstractWorkflowEventSource

java.lang.Object

de.uplanet.lucy.server.workflow.eventsource.AbstractWorkflowEventSource

All Implemented Interfaces:

IActivatableWorkflowObject, de.uplanet.lucy.server.workflow.IImpersonateUser, INamedWorkflowObject, INeedWorkflow, IWorkflowEventSource, IWorkflowObject, Serializable

Direct Known Subclasses:

AbstractSingleThreadedWorkflowEventSource

public abstract class AbstractWorkflowEventSource
extends Object
implements IWorkflowEventSource, INamedWorkflowObject, INeedWorkflow, de.uplanet.lucy.server.workflow.IImpersonateUser

This event source base class provides the ability to create events in an impersonated thread context.

See Also:

Serialized Form

Field Summary

Fields inherited from interface de.uplanet.lucy.server.workflow.IWorkflowObject

GUID_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
AbstractWorkflowEventSource(String p_strGuid)	Create an AbstractWorkflowEventSource.

Method Summary

Modifier and Type	Method	Description
String	getGuid()	Get the GUID of this workflow object.
String	getImpersonateUserGuid()	Get the impersonation user.
String	getName()	Get the name of the workflow object.
de.uplanet.lucy.server.workflow.IWorkflow	getWorkflow()	Get the workflow this object belongs to.
boolean	hasImpersonateUserGuid()	Check if this event source has an impersonation user.
boolean	isActive()	Check if this workflow object is active or inactive.
boolean	isRunWithLocalSystemPrivileges()	Run impersonated code with local system privileges.
void	setActive(boolean p_bActive)	Set this workflow object active or inactive.
void	setImpersonateUserGuid(String p_strImpersonateUserGuid)	Set the impersonation user.
void	setName(String p_strName)	Set the name of the workflow object.
void	setRunWithLocalSystemPrivileges(boolean p_bRunWithLocalSystemPrivileges)	Run impersonated code with local system privileges.
void	setWorkflow(de.uplanet.lucy.server.workflow.IWorkflow p_wf)	Set the workflow this object belongs to.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWorkflowEventSource

public AbstractWorkflowEventSource(String p_strGuid)

Create an AbstractWorkflowEventSource.

Parameters:

p_strGuid - The GUID of the workflow event source.

Throws:

IllegalArgumentException - If the GUID parameter is null or if it does not represent a valid GUID.

Method Detail

getGuid

public String getGuid()

Description copied from interface: IWorkflowObject

Get the GUID of this workflow object.

Note: implementors must ensure that this is never null.

Specified by:

getGuid in interface IWorkflowObject

Returns:

The GUID of this workflow object

isActive

public boolean isActive()

Description copied from interface: IActivatableWorkflowObject

Check if this workflow object is active or inactive.

Specified by:

isActive in interface IActivatableWorkflowObject

Specified by:

isActive in interface IWorkflowEventSource

Returns:

The activation state of this workflow object.

setActive

public void setActive(boolean p_bActive)

Description copied from interface: IActivatableWorkflowObject

Set this workflow object active or inactive.

Specified by:

setActive in interface IActivatableWorkflowObject

Specified by:

setActive in interface IWorkflowEventSource

Parameters:

p_bActive - The new activation state to be set.

getName

public String getName()

Description copied from interface: INamedWorkflowObject

Get the name of the workflow object.

Specified by:

getName in interface INamedWorkflowObject

Returns:

The name of the workflow object.

setName

public void setName(String p_strName)

Description copied from interface: INamedWorkflowObject

Set the name of the workflow object.

Specified by:

setName in interface INamedWorkflowObject

Parameters:

p_strName - The name of the workflow object.

getWorkflow

public de.uplanet.lucy.server.workflow.IWorkflow getWorkflow()

Description copied from interface: INeedWorkflow

Get the workflow this object belongs to.

Specified by:

getWorkflow in interface INeedWorkflow

Returns:

The workflow this object belongs to.

setWorkflow

public void setWorkflow(de.uplanet.lucy.server.workflow.IWorkflow p_wf)

Description copied from interface: INeedWorkflow

Set the workflow this object belongs to.

Specified by:

setWorkflow in interface INeedWorkflow

Parameters:

p_wf - The workflow this object belongs to.

hasImpersonateUserGuid

public boolean hasImpersonateUserGuid()

Check if this event source has an impersonation user.

Specified by:

hasImpersonateUserGuid in interface de.uplanet.lucy.server.workflow.IImpersonateUser

Returns:

true if this event source has an impersonation user, or false otherwise.

getImpersonateUserGuid

public String getImpersonateUserGuid()

Get the impersonation user.

Specified by:

getImpersonateUserGuid in interface de.uplanet.lucy.server.workflow.IImpersonateUser

Returns:

TThe impersonation user, or null.

setImpersonateUserGuid

public void setImpersonateUserGuid(String p_strImpersonateUserGuid)

Set the impersonation user.

Specified by:

setImpersonateUserGuid in interface de.uplanet.lucy.server.workflow.IImpersonateUser

Parameters:

p_strImpersonateUserGuid - This GUID of the impersonation user.

isRunWithLocalSystemPrivileges

public boolean isRunWithLocalSystemPrivileges()

Run impersonated code with local system privileges.

Default is true.

Returns:

true if impersonated code is run with local system privileges, or false otherwise.

setRunWithLocalSystemPrivileges

public void setRunWithLocalSystemPrivileges(boolean p_bRunWithLocalSystemPrivileges)

Run impersonated code with local system privileges.

Default is true.

Parameters:

p_bRunWithLocalSystemPrivileges - true if impersonated code should be run with local system privileges, or false otherwise.

toString

public String toString()

Overrides:

toString in class Object