com.cloupia.service.cIM.inframgr.customactions

Class CustomActionTriggerContext

java.lang.Object

com.cloupia.service.cIM.inframgr.customactions.CustomActionTriggerContext

public class CustomActionTriggerContext
extends java.lang.Object

This class represents context under which an Orchestration task being executed. It provides utility methods typically used in this context

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CustomActionTriggerContext.testPrimitiveTypes

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTIVATION_TYPE_EVENT
static int	ACTIVATION_TYPE_PROVISION_WORKFLOW
static int	ACTIVATION_TYPE_TRIGGER
static int	ACTIVATION_TYPE_USER
static int	DEF_CONTEXT
static int	REST_CONTEXT
static java.lang.String[]	severityString
static int	STATUS_CANCELLED
static int	STATUS_COMPLETED
static int	STATUS_FAILED
static int	STATUS_INPROGRESS
static int	STATUS_INVALID
static int	STATUS_TIMEDOUT
static int	WFT_CONTEXT

Constructor Summary

Constructors

Constructor and Description
CustomActionTriggerContext()
CustomActionTriggerContext(int srId, CustomActionDefinition actionDef, CustomActionConfigEntry configEntry)
CustomActionTriggerContext(int srId, CustomActionDefinition actionDef, CustomActionConfigEntry configEntry, VMDataView selectedVM)

Method Summary

Modifier and Type	Method and Description
void	addLog(java.lang.String message, int severity)
InnerTaskContext	createInnerTaskContext(java.lang.String innerTaskHandler)
void	exit()
CustomActionDefinition	getActionDef()
java.util.List<java.lang.String>	getActionLog()
java.lang.String	getActionResult(java.lang.String name)
java.util.Map<java.lang.String,java.lang.String>	getActionResultMap()
int	getActivationType()
InfraManagerIf	getAPI() Provides API handle to UCSD which can be used to invoke APIs from Cloupia Script
java.lang.Object	getAPI(java.lang.String namespace)
ChangeTracker	getChangeTracker() Provides handle to the ChangeTracker which can be used to update CMDB and register Undoable resources etc
java.lang.String	getComment()
CustomActionConfigEntry	getConfigEntry()
MoResourceIf	getConfigObject()
java.lang.String	getErrorMessae()
int	getExternalContext()
static java.util.Map<java.lang.String,java.lang.Object>	getFieldNamesAndValues(java.lang.Object valueObj)
static <T> T	getFormManagedObject(java.lang.Class<T> classOfT, long objId)
java.lang.String	getInput(java.lang.String inputLabel)
int	getNewPriority()
CustomActionTriggerContext.testPrimitiveTypes	getNewTestObj()
java.lang.String	getOutput(java.lang.String outputLabel, int srId)
java.lang.String	getReplacedWorkflowTaskTitle()
ReportContext	getReportContext() get the report context under which the workflow is launched (may be null if not associated with any report context)
ServiceRequest	getSR()
int	getSrId()
long	getStartTaskAfter()
java.util.Map<java.lang.String,WorkflowOutputFieldDefinition>	getTaskOutputsMap()
java.lang.String	getTaskStatusMessage() Gets them message shown below the task name in Task Details window
java.util.List<java.lang.String>	getTraceMessages()
int	getUserGroup()
java.lang.String	getUserId()
java.lang.Object	getWizardSessionObject()
boolean	isEndUserType()
boolean	isInnerTask()
boolean	isRESTContext()
boolean	isSuccessful()
java.lang.Object	loadConfigObject()
java.util.List<RemoteWFTaskEntry>	loadRemoteConfigObject()
static void	main(java.lang.String[] args)
java.lang.String	processTemplateString(int vmId, java.lang.String inputString)
java.lang.String	processTemplateStringToMask(int vmId, java.lang.String inputString, java.util.Set<java.lang.String> labelValuesToBeHidden)
void	resetContext(int srId)
void	saveOutputValue(java.lang.String name, java.lang.String value)
void	saveOutputValueForCustomApprovalTask(java.lang.String name, java.lang.String value)
void	saveValueToUserMappedOutput(long actionId, long configEntryId, java.lang.String fldName, long inputSetId, java.lang.String inputFldValue, boolean addNew)
void	setActionDef(CustomActionDefinition actionDef)
void	setActivationType(int activationType)
void	setChangeTracker(ChangeTracker tracker)
void	setComment(java.lang.String comment)
void	setConfigEntry(CustomActionConfigEntry configEntry)
void	setConfigObject(MoResourceIf moResource)
void	setExternalContext(int externalContext)
void	setFailed(java.lang.String errorMessage) Used in Cloupia Script to mark the section as faield before calling this.exit()
void	setIsInnerTask(boolean inner, java.lang.Object innerInvocationConfigObject) Sets the inner object to a work flow task which is reference in this context Is used to invoke a task from Cloupia Script
void	setNewPriority(int newPriority)
void	setReplacedWorkflowTaskTitle(java.lang.String replacedWorkflowTaskTitle)
void	setRestContext()
void	setSrId(int srId)
void	setStartTaskAfter(long startTaskAfter)
void	setSuccessful() Used in Cloupia Script to mark the section as successfully executed before calling this.exit()
void	setTarget(CustomActionTarget target)
void	setTaskStatusMessage(java.lang.String taskStatusMessage) each task handler may set this message to indicate what meesage to be shown below the task name in Task Details window
void	setUserId(java.lang.String userId)
void	setWizardSessionObject(java.lang.Object sessionObject)
boolean	updateInput(java.lang.String inputLabel, java.lang.String value) // Save into workflow variables as needed.
int	waitForCompletion(int serviceRequestId, long maxWaitTime) Waits for the give service request to complete for it to be completed or failed

Methods inherited from class java.lang.Object

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

Field Detail

severityString

public static java.lang.String[] severityString

ACTIVATION_TYPE_PROVISION_WORKFLOW

public static final int ACTIVATION_TYPE_PROVISION_WORKFLOW

See Also:

Constant Field Values

ACTIVATION_TYPE_TRIGGER

public static final int ACTIVATION_TYPE_TRIGGER

See Also:

Constant Field Values

ACTIVATION_TYPE_USER

public static final int ACTIVATION_TYPE_USER

See Also:

Constant Field Values

ACTIVATION_TYPE_EVENT

public static final int ACTIVATION_TYPE_EVENT

See Also:

Constant Field Values

STATUS_INVALID

public static final int STATUS_INVALID

See Also:

Constant Field Values

STATUS_COMPLETED

public static final int STATUS_COMPLETED

See Also:

Constant Field Values

STATUS_FAILED

public static final int STATUS_FAILED

See Also:

Constant Field Values

STATUS_TIMEDOUT

public static final int STATUS_TIMEDOUT

See Also:

Constant Field Values

STATUS_INPROGRESS

public static final int STATUS_INPROGRESS

See Also:

Constant Field Values

STATUS_CANCELLED

public static final int STATUS_CANCELLED

See Also:

Constant Field Values

REST_CONTEXT

public static final int REST_CONTEXT

See Also:

Constant Field Values

WFT_CONTEXT

public static final int WFT_CONTEXT

See Also:

Constant Field Values

DEF_CONTEXT

public static final int DEF_CONTEXT

See Also:

Constant Field Values

Constructor Detail

CustomActionTriggerContext

public CustomActionTriggerContext()

CustomActionTriggerContext

public CustomActionTriggerContext(int srId,
                                  CustomActionDefinition actionDef,
                                  CustomActionConfigEntry configEntry)

CustomActionTriggerContext

public CustomActionTriggerContext(int srId,
                                  CustomActionDefinition actionDef,
                                  CustomActionConfigEntry configEntry,
                                  VMDataView selectedVM)

Method Detail

getChangeTracker

public ChangeTracker getChangeTracker()

Provides handle to the ChangeTracker which can be used to update CMDB and register Undoable resources etc

Returns:

ChangeTracker

setChangeTracker

public void setChangeTracker(ChangeTracker tracker)

getTraceMessages

public java.util.List<java.lang.String> getTraceMessages()

getTaskStatusMessage

public java.lang.String getTaskStatusMessage()

Gets them message shown below the task name in Task Details window

getStartTaskAfter

public long getStartTaskAfter()

Returns:

the time in milliseconds after which the task gets executed

setStartTaskAfter

public void setStartTaskAfter(long startTaskAfter)

setTaskStatusMessage

public void setTaskStatusMessage(java.lang.String taskStatusMessage)

each task handler may set this message to indicate what meesage to be shown below the task name in Task Details window

getReportContext

public ReportContext getReportContext()

get the report context under which the workflow is launched (may be null if not associated with any report context)

loadConfigObject

public java.lang.Object loadConfigObject()
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getTaskOutputsMap

public java.util.Map<java.lang.String,WorkflowOutputFieldDefinition> getTaskOutputsMap()

getFieldNamesAndValues

public static java.util.Map<java.lang.String,java.lang.Object> getFieldNamesAndValues(java.lang.Object valueObj)
                                                                               throws java.lang.IllegalArgumentException,
                                                                                      java.lang.IllegalAccessException

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalAccessException

getActivationType

public int getActivationType()

Returns:

the activationType

getSrId

public int getSrId()

Returns:

the Service Request Id

setSrId

public void setSrId(int srId)

getUserId

public java.lang.String getUserId()

Returns:

the userId for the current session

setActivationType

public void setActivationType(int activationType)

Parameters:

activationType - the activationType to set

setUserId

public void setUserId(java.lang.String userId)

Parameters:

userId - the userId to set

setComment

public void setComment(java.lang.String comment)

getComment

public java.lang.String getComment()

setActionDef

public void setActionDef(CustomActionDefinition actionDef)

getActionDef

public CustomActionDefinition getActionDef()

Returns:

the workflow definition

getConfigEntry

public CustomActionConfigEntry getConfigEntry()

Returns:

the workflow task metadata

setConfigEntry

public void setConfigEntry(CustomActionConfigEntry configEntry)

getSR

public ServiceRequest getSR()

setTarget

public void setTarget(CustomActionTarget target)

Parameters:

target - the target to set

processTemplateString

public java.lang.String processTemplateString(int vmId,
                                              java.lang.String inputString)

processTemplateStringToMask

public java.lang.String processTemplateStringToMask(int vmId,
                                                    java.lang.String inputString,
                                                    java.util.Set<java.lang.String> labelValuesToBeHidden)

setIsInnerTask

public void setIsInnerTask(boolean inner,
                           java.lang.Object innerInvocationConfigObject)

Sets the inner object to a work flow task which is reference in this context Is used to invoke a task from Cloupia Script

Parameters:

inner -

innerInvocationConfigObject -

isInnerTask

public boolean isInnerTask()

getActionResult

public java.lang.String getActionResult(java.lang.String name)

saveOutputValue

public void saveOutputValue(java.lang.String name,
                            java.lang.String value)
                     throws java.lang.Exception

Throws:

java.lang.Exception

saveOutputValueForCustomApprovalTask

public void saveOutputValueForCustomApprovalTask(java.lang.String name,
                                                 java.lang.String value)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

saveValueToUserMappedOutput

public void saveValueToUserMappedOutput(long actionId,
                                        long configEntryId,
                                        java.lang.String fldName,
                                        long inputSetId,
                                        java.lang.String inputFldValue,
                                        boolean addNew)

exit

public void exit()

getAPI

public InfraManagerIf getAPI()
                      throws java.lang.Exception

Provides API handle to UCSD which can be used to invoke APIs from Cloupia Script

Returns:

Throws:

java.lang.Exception

getAPI

public java.lang.Object getAPI(java.lang.String namespace)
                        throws java.lang.Exception

Parameters:

namespace -

Returns:

Throws:

java.lang.Exception

getInput

public java.lang.String getInput(java.lang.String inputLabel)

Parameters:

inputLabel - This is the label used when defining the work flow or Task output which can be referenced by using Task Name as prefix ex., TaskName.outputfield

Returns:

the input value for a work flow input field or a task output for the current Service Request

getOutput

public java.lang.String getOutput(java.lang.String outputLabel,
                                  int srId)

updateInput

public boolean updateInput(java.lang.String inputLabel,
                           java.lang.String value)
                    throws java.lang.Exception

// Save into workflow variables as needed. Refer to getInput()

Parameters:

inputLabel -

value -

Returns:

Throws:

java.lang.Exception

getNewPriority

public int getNewPriority()

Returns:

the newPriority

setNewPriority

public void setNewPriority(int newPriority)

Parameters:

newPriority - the newPriority to set

setSuccessful

public void setSuccessful()

Used in Cloupia Script to mark the section as successfully executed before calling this.exit()

setFailed

public void setFailed(java.lang.String errorMessage)

Used in Cloupia Script to mark the section as faield before calling this.exit()

isSuccessful

public boolean isSuccessful()

Returns:

the isSuccessful

getErrorMessae

public java.lang.String getErrorMessae()

Returns:

the errorMessae

getUserGroup

public int getUserGroup()

Returns:

the group id of the current user

isEndUserType

public boolean isEndUserType()

Returns:

true if the user is end user or group admin false if the user is administrator

waitForCompletion

public int waitForCompletion(int serviceRequestId,
                             long maxWaitTime)
                      throws java.lang.Exception

Waits for the give service request to complete for it to be completed or failed

Parameters:

serviceRequestId -

maxWaitTime - maximum time to wait for the status

Returns:

0 Complete 1 Failed -1 Invalid

Throws:

java.lang.Exception

loadRemoteConfigObject

public java.util.List<RemoteWFTaskEntry> loadRemoteConfigObject()
                                                         throws java.lang.Exception

Throws:

java.lang.Exception

resetContext

public void resetContext(int srId)

setRestContext

public void setRestContext()

setExternalContext

public void setExternalContext(int externalContext)

getExternalContext

public int getExternalContext()

setConfigObject

public void setConfigObject(MoResourceIf moResource)

getConfigObject

public MoResourceIf getConfigObject()

getActionResultMap

public java.util.Map<java.lang.String,java.lang.String> getActionResultMap()

isRESTContext

public boolean isRESTContext()

addLog

public void addLog(java.lang.String message,
                   int severity)

getActionLog

public java.util.List<java.lang.String> getActionLog()

createInnerTaskContext

public InnerTaskContext createInnerTaskContext(java.lang.String innerTaskHandler)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getFormManagedObject

public static <T> T getFormManagedObject(java.lang.Class<T> classOfT,
                                         long objId)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getWizardSessionObject

public java.lang.Object getWizardSessionObject()

setWizardSessionObject

public void setWizardSessionObject(java.lang.Object sessionObject)

getReplacedWorkflowTaskTitle

public java.lang.String getReplacedWorkflowTaskTitle()

setReplacedWorkflowTaskTitle

public void setReplacedWorkflowTaskTitle(java.lang.String replacedWorkflowTaskTitle)

getNewTestObj

public CustomActionTriggerContext.testPrimitiveTypes getNewTestObj()

main

public static void main(java.lang.String[] args)