Package de.xima.fc.bl.fdv

Class WorkflowProcessingContext

java.lang.Object

de.xima.fc.bl.fdv.WorkflowProcessingContext

All Implemented Interfaces:

IWorkflowProcessingContext, IBaseWorkflowExecutionContext, Closeable, AutoCloseable

public class WorkflowProcessingContext
extends Object
implements IWorkflowProcessingContext

Diese Klasse bildet einen Container, um Objekte, die bei der Verarbeitung einer Aktion erzeugt wurden, einer anderen Aktion zur Verfügung zu stellen, wobei diese beiden Aktionen innerhalb einer Verarbeitung (eines Statuswechsels) sein müssen. Alle Ergebnisse einer Aktion werden als Key-Value-Paare in einer Map abgelegt. Diese Map befindet sich wiederum in einer Map, welche die Zuordnung der Aktion, welche die Ergebnismenge erzeugt hat, abbildet. Das Ablegen von Ergebnismengen sieht also wie folgt aus:

 

 
AktionsId=1
 

 
"key1":"value1"
 
"key2":"value2"
 
"key3":"value3"
 
 
AktionsId=2
 

 
"key1":"value1"
 
"key2":"value2"
 
"key3":"value3"
 
 
 Die Keys sind Zeichenkettenwerte und die Values vom Typ Object. Beim Auslesen könnte ein Type-Cast
 notwendig werden. Zum Ermitteln eines Wertes muss folgende Objekt-Kette ausgebaut werden:
 

 WorkflowProcessingContextManager --(Vorgang.getProzessId())--> WorkflowProcessingContext --(
 Aktion.getId())--> Aktionsergebnisobjekt(Key:Value)
 
 

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	LOG	Beinhaltet die Zuordnung zwischen Aktion und Aktionsergebnisobjekten Die Aktionsergebnisobjekte sind Key-Value-Paare, die in Form einer Map in einer dieser Map abgelegt werden und anhand der AktionsId zugreifbar sind.

Constructor Summary

Constructors

Constructor	Description
WorkflowProcessingContext(Vorgang process, IWorkflowProcessing processing, IXForm xForm, IXFormRenderConfig xformConfig, IFormDataAdapter formDataAdapter, IEntityContext entityContext, Map<String,Serializable> sessionAttributes)

Method Summary

Modifier and Type	Method	Description
void	addProcessingResult(long aktionsId, IProcessingResult value)	neues Aktionsergebnisobjekt hinzuzufügen
void	addProcessingResult(Integer aktionsId, IProcessingResult value)	neues Aktionsergebnisobjekt hinzuzufügen
void	close()
IWorkflowExecutionEnvironmentData	env()
HashMap<Long,IProcessingResult>	getAktionsErgebnisse()
IConsumingFileHandler	getConsumingFileHandler()
IEntityContext	getEntityContext()
String	getFilename(String targetName)
IFormDataAdapter	getFormDataAdapter()
IWorkflowProcessing	getProcessing()
IProvidingFileHandler	getProvidingFileHandler()
Map<String,Serializable>	getSessionAttributeMap()
SessionAttributes	getSessionAttributes()	Deprecated.
File	getSourceDir(Aktion aktion)	Path to the temporary source directory.
String	getSourceDirPath(Aktion aktion)	Path to the temporary source directory.
<E extends IFileDataEntity<?>> File	getSourceFile(Aktion aktion, IFileProviding<?,E> file)	Methode zum Ermitteln und temporären Ablegen von Dateien aus der Datenbank.
File	getTargetDir(Aktion aktion)	Path to the temporary target directory.
String	getTargetDirPath(Aktion aktion)	Path to the temporary target directory.
String	getTempDirPath(Aktion aktion)	Deprecated. use getTargetDirPath(Aktion)
Vorgang	getVorgang()
IXForm	getXForm()
IXFormRenderConfig	getXFormRenderConfig()
boolean	hasKey(long aktionsId)	ermitteln, ob ein Eintrag zu einer Aktions-ID vorhanden ist
IProcessingResult	instanceFor(long aktionsId)	spezifisches Aktionsergebnisobjekt anhand des Keys ermitteln
String	latestValueFor(Set<Long> actionIds, EProcessingResult processingResult, int index, String key)	Checks whether a processing result is available for the given actions, and returns the result for the action that was executed most recently.
IWorkflowPlaceholderHandler	placeholder()
void	setAktionsErgebnisse(HashMap<Long,IProcessingResult> aktionsErgebnisse)
void	setEntityContext(IEntityContext entityContext)
void	setFormDataAdapter(IFormDataAdapter formDataAdapter)
void	setSessionAttributes(SessionAttributes sessionAttributes)	Deprecated.
void	setSessionAttributes(Map<String,Serializable> sessionAttributes)
void	setVorgang(Vorgang vorgang)
void	setxForm(IXForm xForm)	Deprecated. use setXForm(IXForm)
void	setXForm(IXForm xForm)
void	shutdown()	alle geöffneten Referenzen des Kontexts schließen und temporär angelegte Dateien löschen (sollte erst passieren, wenn der Statuswechsel vollzogen ist und kein Kontext mehr benötigt wird)
IProcessingResult	valueFor(long aktionsId)	Find the processing result for a given action.
String	valueFor(long aktionId, EProcessingResult processingResult, int index, String key)	In general, a workflow action returns a List of Maps as the result.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Beinhaltet die Zuordnung zwischen Aktion und Aktionsergebnisobjekten Die Aktionsergebnisobjekte sind Key-Value-Paare, die in Form einer Map in einer dieser Map abgelegt werden und anhand der AktionsId zugreifbar sind.

Constructor Detail

WorkflowProcessingContext

public WorkflowProcessingContext(Vorgang process,
                                 IWorkflowProcessing processing,
                                 IXForm xForm,
                                 IXFormRenderConfig xformConfig,
                                 IFormDataAdapter formDataAdapter,
                                 IEntityContext entityContext,
                                 Map<String,Serializable> sessionAttributes)

Parameters:

process - the process

processing - the IWorkflowProcessing

xForm - the IXForm

xformConfig - the IXFormRenderConfig

formDataAdapter - the IFormDataAdapter

entityContext - the IEntityContext

sessionAttributes - a map of session attributes

Method Detail

addProcessingResult

public void addProcessingResult(Integer aktionsId,
                                IProcessingResult value)

neues Aktionsergebnisobjekt hinzuzufügen

Specified by:

addProcessingResult in interface IWorkflowProcessingContext

Parameters:

aktionsId - - Id der Aktion zu welcher die Aktionsergebnisobjekte zugeordnet werden

value - - Value das eigentliche Aktionsergebnisobjekt das abgelegt werden soll

addProcessingResult

public void addProcessingResult(long aktionsId,
                                IProcessingResult value)

neues Aktionsergebnisobjekt hinzuzufügen

Specified by:

addProcessingResult in interface IWorkflowProcessingContext

Parameters:

aktionsId - - Id der Aktion zu welcher die Aktionsergebnisobjekte zugeordnet werden

value - - Value das eigentliche Aktionsergebnisobjekt das abgelegt werden soll

instanceFor

public IProcessingResult instanceFor(long aktionsId)

spezifisches Aktionsergebnisobjekt anhand des Keys ermitteln

Parameters:

aktionsId - - die Id der Aktion für die die Ergebnismenge ermittelt werden soll.

Returns:

Objekt, welches das Aktionsergebnis darstellt

placeholder

public IWorkflowPlaceholderHandler placeholder()

Specified by:

placeholder in interface IBaseWorkflowExecutionContext

Returns:

A handler for replacing placeholders in strings, using the current workflow execution context. This is a shortcut for the methods provided by {code de.xima.fc.placeholder.PlaceholderReplacer} that supplies the required parameters automatically.

valueFor

public IProcessingResult valueFor(long aktionsId)

Description copied from interface: IWorkflowProcessingContext

Find the processing result for a given action.

Specified by:

valueFor in interface IWorkflowProcessingContext

Parameters:

aktionsId - The ID of the Aktion

Returns:

The processing result for the given action, if present, or null otherwise.

getTempDirPath

@Deprecated
public String getTempDirPath(Aktion aktion)
                      throws IOException

Deprecated.

use getTargetDirPath(Aktion)

Specified by:

getTempDirPath in interface IWorkflowProcessingContext

Parameters:

aktion - A workflow action for which to find the temporary path.

Returns:

A unique temporary path for the given action that is guaranteed to be different from the path for other actions. The returned directory is guaranteed to exist.

Throws:

IOException - When the temporary directory does not exist and could not be created.

getTargetDirPath

public String getTargetDirPath(Aktion aktion)
                        throws IOException

Description copied from interface: IWorkflowProcessingContext

Path to the temporary target directory. This directory may be used to store files created by an action. The directory path that is returned will refer to a directory that exists on the file system (if necessary, it is created when calling this method). The directory will be deleted once workflow processing finishes.

Specified by:

getTargetDirPath in interface IWorkflowProcessingContext

Parameters:

aktion - The Aktion for which the target directory should be returned.

Returns:

The path to the directory for the given action.

Throws:

IOException - When the the target directory could not be acquired or created.

See Also:

IWorkflowProcessingContext.getTargetDir(Aktion)

getTargetDir

public File getTargetDir(Aktion aktion)
                  throws IOException

Description copied from interface: IWorkflowProcessingContext

Path to the temporary target directory. This directory may be used to store files created by an action. The directory path that is returned will refer to a directory that exists on the file system (if necessary, it is created when calling this method). The directory will be deleted once workflow processing finishes.

Specified by:

getTargetDir in interface IWorkflowProcessingContext

Parameters:

aktion - The Aktion for which the target directory should be returned.

Returns:

The file for the directory for the given action.

Throws:

IOException - When the the target directory could not be acquired or created.

See Also:

IWorkflowProcessingContext.getTargetDirPath(Aktion)

getSourceDir

public File getSourceDir(Aktion aktion)
                  throws IOException

Description copied from interface: IWorkflowProcessingContext

Path to the temporary source directory. This directory contains files that were created for this action. It may be read from, but you should not create new files from this directory. If you want to create new files for the action, use IWorkflowProcessingContext.getTargetDir(Aktion). The directory path that is returned will refer to a directory that exists on the file system (if necessary, it is created when calling this method). The directory will be deleted once workflow processing finishes.

Specified by:

getSourceDir in interface IWorkflowProcessingContext

Parameters:

aktion - The Aktion for which the source directory should be returned.

Returns:

The file for the source directory for the given action.

Throws:

IOException - When the the source directory could not be acquired or created.

See Also:

IWorkflowProcessingContext.getSourceDirPath(Aktion)

getSourceDirPath

public String getSourceDirPath(Aktion aktion)
                        throws IOException

Description copied from interface: IWorkflowProcessingContext

Path to the temporary source directory. This directory contains files that were created for this action. It may be read from, but you should not create new files from this directory. If you want to create new files for the action, use IWorkflowProcessingContext.getTargetDirPath(Aktion). The directory path that is returned will refer to a directory that exists on the file system (if necessary, it is created when calling this method). The directory will be deleted once workflow processing finishes.

Specified by:

getSourceDirPath in interface IWorkflowProcessingContext

Parameters:

aktion - The Aktion for which the source directory should be returned.

Returns:

The path to the source directory for the given action.

Throws:

IOException - When the the source directory could not be acquired or created.

See Also:

IWorkflowProcessingContext.getSourceDir(Aktion)

getConsumingFileHandler

public IConsumingFileHandler getConsumingFileHandler()

Specified by:

getConsumingFileHandler in interface IWorkflowProcessingContext

Returns:

Utility methods for working with files and file consuming actions, ie. actions that require or read files.

getProvidingFileHandler

public IProvidingFileHandler getProvidingFileHandler()

Specified by:

getProvidingFileHandler in interface IWorkflowProcessingContext

Returns:

Utility methods for working with files and file providing actions, ie. actions create files.

getSourceFile

public <E extends IFileDataEntity<?>> File getSourceFile(Aktion aktion,
                                                         IFileProviding<?,E> file)
                                                  throws IOException

Description copied from interface: IWorkflowProcessingContext

Methode zum Ermitteln und temporären Ablegen von Dateien aus der Datenbank. Diese werden in das Verzeichnis IWorkflowProcessingContext.getSourceDir(Aktion) abgelegt und werden entsprechend beim Schließen des Kontextes mit gelöscht.

Specified by:

getSourceFile in interface IWorkflowProcessingContext

Type Parameters:

E - Type of a file providing entity, such as a client or project resource.

Parameters:

aktion - Aktion die Aktion in welcher die Datei zur Verfügung gestellt werden soll

file - IFileProviding Die Entität dessen Datei ausgelesen werden soll

Returns:

File die temporär abgelegte Datei

Throws:

IOException - wenn Fehler beim Anlegen der Datei auftreten

getFilename

public String getFilename(String targetName)

Specified by:

getFilename in interface IWorkflowProcessingContext

Parameters:

targetName - A possibly unsafe name (user input) that you would like to use a a filename.

Returns:

A safe filename that can be used to create a new file on the file system. It is only a file name without a directory.

See Also:

IWorkflowProcessingContext.getTargetDir(Aktion), IWorkflowProcessingContext.getTargetDirPath(Aktion)

shutdown

public void shutdown()
              throws IOException

alle geöffneten Referenzen des Kontexts schließen und temporär angelegte Dateien löschen (sollte erst passieren, wenn der Statuswechsel vollzogen ist und kein Kontext mehr benötigt wird)

Specified by:

shutdown in interface IWorkflowProcessingContext

Throws:

IOException - - wenn ein Fehler beim Löschen des temporären Verzeichnisses auftritt

hasKey

public boolean hasKey(long aktionsId)

ermitteln, ob ein Eintrag zu einer Aktions-ID vorhanden ist

Specified by:

hasKey in interface IWorkflowProcessingContext

Parameters:

aktionsId - - ID der Aktion, deren Existenz geprüft werden soll

Returns:

true wenn element vorhanden, ansonsten false

valueFor

public String valueFor(long aktionId,
                       EProcessingResult processingResult,
                       int index,
                       String key)

Description copied from interface: IWorkflowProcessingContext

In general, a workflow action returns a List of Maps as the result. This method find the result value at a given index and key.

Specified by:

valueFor in interface IWorkflowProcessingContext

Parameters:

aktionId - The ID of an Aktion for which to find the processing value.

processingResult - The type of expected processing result.

index - Zero-based index indicating which processing value to return. Ignored unless the processingResult is set to EProcessingResult.RESULT.

key - Key indicating which value to return.

Returns:

The processing result value for the given action, at the given index and key.

latestValueFor

public String latestValueFor(Set<Long> actionIds,
                             EProcessingResult processingResult,
                             int index,
                             String key)

Description copied from interface: IWorkflowProcessingContext

Checks whether a processing result is available for the given actions, and returns the result for the action that was executed most recently.

Specified by:

latestValueFor in interface IWorkflowProcessingContext

Parameters:

actionIds - Collection of IDs of Aktions for which to find the processing value.

processingResult - The type of expected processing result.

index - Zero-based index indicating which processing value to return. Ignored unless the processingResult is set to EProcessingResult.RESULT.

key - indicating which value to return.

Returns:

The processing result value for the given action, at the given index and key.

getXForm

public IXForm getXForm()

Specified by:

getXForm in interface IWorkflowProcessingContext

Returns:

The IXForm for the current form record.

getXFormRenderConfig

public IXFormRenderConfig getXFormRenderConfig()

Specified by:

getXFormRenderConfig in interface IWorkflowProcessingContext

Returns:

The configuration that was used for rendering the form for the current form record.

getVorgang

public Vorgang getVorgang()

Specified by:

getVorgang in interface IWorkflowProcessingContext

Returns:

The current Vorgang for which workflow processing is executed.

setVorgang

public void setVorgang(Vorgang vorgang)

Specified by:

setVorgang in interface IWorkflowProcessingContext

getFormDataAdapter

public IFormDataAdapter getFormDataAdapter()

Specified by:

getFormDataAdapter in interface IWorkflowProcessingContext

Returns:

The IFormDataAdapter for the current form record that can be used to access the current form data.

setFormDataAdapter

public void setFormDataAdapter(IFormDataAdapter formDataAdapter)

getEntityContext

public IEntityContext getEntityContext()

Specified by:

getEntityContext in interface IWorkflowProcessingContext

Returns:

The current IEntityContext that can be used to access the database.

getAktionsErgebnisse

public HashMap<Long,IProcessingResult> getAktionsErgebnisse()

setAktionsErgebnisse

public void setAktionsErgebnisse(HashMap<Long,IProcessingResult> aktionsErgebnisse)

setXForm

public void setXForm(IXForm xForm)

setEntityContext

public void setEntityContext(IEntityContext entityContext)

getProcessing

public IWorkflowProcessing getProcessing()

Specified by:

getProcessing in interface IWorkflowProcessingContext

Returns:

The workflow action handler for the action that is current being executed.

getSessionAttributeMap

public Map<String,Serializable> getSessionAttributeMap()

Specified by:

getSessionAttributeMap in interface IWorkflowProcessingContext

Returns:

A map that contains the session attributes of the current HttpSession. Changes to this map will not be reflected or apply to the HttpSession.

setSessionAttributes

public void setSessionAttributes(Map<String,Serializable> sessionAttributes)

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

setSessionAttributes

@Deprecated
public void setSessionAttributes(SessionAttributes sessionAttributes)

Deprecated.

getSessionAttributes

@Deprecated
public SessionAttributes getSessionAttributes()

Deprecated.

Specified by:

getSessionAttributes in interface IWorkflowProcessingContext

setxForm

@Deprecated
public void setxForm(IXForm xForm)

Deprecated.

use setXForm(IXForm)

env

public IWorkflowExecutionEnvironmentData env()

Specified by:

env in interface IBaseWorkflowExecutionContext

Returns:

Data from the current workflow execution, such as the form for which the workflow is executed, and the current client.