com.jboss.jbossnetwork.product.jbpm.handlers

Class UnzipActionHandler

java.lang.Object

com.jboss.jbossnetwork.product.jbpm.handlers.BaseHandler

com.jboss.jbossnetwork.product.jbpm.handlers.UnzipActionHandler

All Implemented Interfaces:

Serializable, org.jbpm.graph.def.ActionHandler

public class UnzipActionHandler
extends BaseHandler

JBPM handler that is responsible for unzipping a file.

Author:

Jason Dobies

See Also:

Serialized Form

Field Summary

Fields inherited from class com.jboss.jbossnetwork.product.jbpm.handlers.BaseHandler

logger, MESSAGE_NO_CHANGES, TRANSITION_ERROR, TRANSITION_SUCCESS

Constructor Summary

Constructors

Constructor and Description
UnzipActionHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkProperties() Ensures the property values that were set in BaseHandler.substituteVariables(org.jbpm.graph.exe.ExecutionContext) are valid.
String	getDescription() Returns a user readable description of what the step in the workflow entails.
String	getDestinationDirectoryLocation()
String	getFileToBeUnzippedLocation()
void	run(org.jbpm.graph.exe.ExecutionContext executionContext) Tells the handle implementation to actually perform the step indicated.
void	setDestinationDirectoryLocation(String destinationDirectoryLocation)
void	setFileToBeUnzippedLocation(String fileToBeUnzippedLocation)
void	substituteVariables(org.jbpm.graph.exe.ExecutionContext executionContext) Requests the action handler substitute into its node any variables necessary, taking the values for these from the provided execution context.

Methods inherited from class com.jboss.jbossnetwork.product.jbpm.handlers.BaseHandler

complete, error, execute, notRun, setPropertyDefaults, skip, substituteVariable

Methods inherited from class java.lang.Object

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

Constructor Detail

UnzipActionHandler

public UnzipActionHandler()

Method Detail

run

public void run(org.jbpm.graph.exe.ExecutionContext executionContext)

Description copied from class: BaseHandler

Tells the handle implementation to actually perform the step indicated.

Specified by:

run in class BaseHandler

Parameters:

executionContext - cannot be null

getDescription

public String getDescription()

Description copied from class: BaseHandler

Returns a user readable description of what the step in the workflow entails.

Specified by:

getDescription in class BaseHandler

Returns:

should not be null

checkProperties

protected void checkProperties()
                        throws ActionHandlerException

Description copied from class: BaseHandler

Ensures the property values that were set in BaseHandler.substituteVariables(org.jbpm.graph.exe.ExecutionContext) are valid. This may optionally be overridden by action handler implementations if necessary.

Overrides:

checkProperties in class BaseHandler

Throws:

ActionHandlerException - if any of the properties are invalid

substituteVariables

public void substituteVariables(org.jbpm.graph.exe.ExecutionContext executionContext)
                         throws ActionHandlerException

Description copied from class: BaseHandler

Requests the action handler substitute into its node any variables necessary, taking the values for these from the provided execution context. This may optionally be overridden by action handler implementations if necessary.

Overrides:

substituteVariables in class BaseHandler

Parameters:

executionContext - JBPM execution context from which the property values should be extracted

Throws:

ActionHandlerException - if there is an error extraction or substituting the variables

getFileToBeUnzippedLocation

public String getFileToBeUnzippedLocation()

setFileToBeUnzippedLocation

public void setFileToBeUnzippedLocation(String fileToBeUnzippedLocation)

getDestinationDirectoryLocation

public String getDestinationDirectoryLocation()

setDestinationDirectoryLocation

public void setDestinationDirectoryLocation(String destinationDirectoryLocation)