Package de.xima.fc.workflow.processor.logic

Class WorkflowProviderHelper

java.lang.Object

de.xima.fc.workflow.processor.logic.WorkflowProviderHelper

public class WorkflowProviderHelper
extends Object

Helper methods for implementing a IWorkflowProvider.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
WorkflowProviderHelper()

Method Summary

Modifier and Type	Method	Description
static List<EAttachmentSource>	computeAllAttachmentSources()
static List<EntityRef>	computeAllClientCounterRefs(IEntityContext ec, Mandant client)
static List<ClientCounter>	computeAllClientCounters(IEntityContext ec, Mandant client)
static List<MandantRessource>	computeAllClientResources(IEntityContext ec, Mandant client)
static List<DatenbankZugriff>	computeAllDatabaseConnections(IEntityContext ec, Mandant currentClient)
static List<Datenquelle>	computeAllDatabaseQueries(IEntityContext ec, Mandant client)
static List<String>	computeAllFormElements(IEntityContext ec, Projekt project)
static List<Postfach>	computeAllInboxes(IEntityContext ec, Mandant currentClient)
static List<LDAPZugriff>	computeAllLdapConnections(IEntityContext ec, Mandant client)
static List<LDAPAbfrage>	computeAllLdapQueries(IEntityContext ec, Mandant client)
static List<INodeWithName>	computeAllNodesOfType(IWorkflowValidationEnvironmentData envData, WorkflowElementIndex elementIndex, String type)
static List<ProjektRessource>	computeAllProjectResources(IEntityContext ec, Projekt project)
static List<IWorkflowQualifiedSubmitButton>	computeAllQualifiedSubmitButtons(IEntityContext ec, Mandant client, Projekt project, Locale locale, FormPersist persistOverride)
static List<WorkflowStateModel>	computeAllStateModels(IEntityContext ec, WorkflowVersion workflowVersion, Locale locale)
static List<IWorkflowSubmitButton>	computeAllSubmitButtons(IEntityContext ec, Mandant client, Projekt project, Locale locale, FormPersist persistOverride)
static List<ITaskWithName>	computeAllTasks(IWorkflowValidationEnvironmentData envData, WorkflowElementIndex elementIndex, UUID taskToExclude)
static List<ITriggerWithName>	computeAllTriggersOfType(IWorkflowValidationEnvironmentData envData, WorkflowElementIndex elementIndex, String type, UUID taskToExclude)
static List<String>	computeAllUploadElements(IEntityContext ec, Projekt project)
static List<BenutzerGruppe>	computeAllUserGroups(IEntityContext ec, Mandant currentClient)
static List<Benutzer>	computeAllUsers(IEntityContext ec, Mandant currentClient)
static List<? extends de.xima.cmn.validation.spec.IChoiceEntry<ResourceItem>>	computeAvailableResources(List<ProjektRessource> projectResources, List<MandantRessource> clientResources, List<String> uploadElements, List<INodeWithName> providingActions, boolean includeForm, boolean includeClient, boolean includeExternal, boolean includeAttachmentSearch, boolean includeUpload, boolean includeProvidingAction, String[] extensions, Locale locale)
static Set<NodeKey>	computeDeadNodes(WorkflowFlowAnalysis analysis, ProcessModel processModel)
static <TElement extends IWorkflowNodeTypeProviding & IActiveFlagProviding> WorkflowFlowAnalysis	computeFlowAnalysis(List<IElementWithTask<TElement>> rootNodes, ITreeAccessor<TElement,UUID> accessor, Mandant client)
static List<Charset>	computeInstalledCharsets()
static List<String>	computeInstalledFontNames()
static <T extends IWorkflowElementTypeProviding> List<INodeWithName>	computeNodeNames(Mandant client, FlowchartElementIndex elementIndex, Map<ElementKey,com.alibaba.fastjson.JSONObject> paramsMap, Iterable<NodeKey> nodeKeys)
static List<BaseConfigViewModel>	computeNonOrderableAuthenticatorConfigs(IEntityContext ec, Mandant client, Locale locale, boolean kerberosActive, boolean ntlmActive)
static List<BaseConfigViewModel>	computeOrderableAuthenticatorConfigs(IEntityContext ec, Mandant client, Locale locale, boolean kerberosActive, boolean ntlmActive)
static List<INodeWithName>	computePredecessors(IBaseEnvironmentData environmentData, IWorkflowFlowAnalysis analysis, NodeKey target, Map<NodeKey,IWorkflowElementWithDeserializedModel<?,WorkflowNode>> index)	Finds all previous nodes for the given target node.
static List<INodeWithName>	computeProvidingNodes(Mandant client, Iterable<IWorkflowElementWithDeserializedModel<?,WorkflowNode>> wrappers)
static List<INodeWithName>	computeProvidingNodes(Mandant client, Map<NodeKey,NodeModel> nodeMap, Function<Map.Entry<NodeKey,NodeModel>,?> getData)
static List<NodeKey>	computeProvidingPredecessors(Mandant client, IWorkflowFlowAnalysis analysis, NodeKey target, Map<NodeKey,NodeModel> index)	Finds all previous nodes that can provide files for the given target node.
static List<INodeWithName>	computeProvidingPredecessors(IBaseEnvironmentData environmentData, IWorkflowFlowAnalysis analysis, NodeKey target, Map<NodeKey,IWorkflowElementWithDeserializedModel<?,WorkflowNode>> index)	Finds all previous nodes that can provide files for the given target node.
static List<Charset>	computeStandardSupportedCharsets()
static List<Textbaustein>	computeTextTemplatesByCategory(IEntityContext ec, Mandant client, ETextbausteinKategorie cat)
static <T extends IWorkflowElementTypeProviding> ITriggerWithName	computeTriggerName(UUID taskUuid, TriggerModel trigger, Map<ElementKey,com.alibaba.fastjson.JSONObject> paramsMap, Mandant client)
static <T extends IWorkflowElementTypeProviding> List<ITriggerWithName>	computeTriggerNames(Mandant client, FlowchartElementIndex elementIndex, Map<ElementKey,com.alibaba.fastjson.JSONObject> paramsMap, Iterable<TriggerKey> triggerKeys)
static <T extends IUUIDEntity & INameProviding & IDescriptionProviding> List<EntityRef>	createEntityRefsWithName(List<T> entities)	Creates a list of EntityRefs with one entry for each entity, and an additional entry for a EntityRef.forNameValue(String).
static <T extends IUUIDEntity & INameProviding & IDescriptionProviding> List<? extends de.xima.cmn.validation.spec.IChoiceEntry<EntityRef>>	createEntityRefsWithNameSelectItems(List<T> entities, String labelEntities, String labelOthers, String labelName)	Creates a list of choice entries with an EntityRef for each entity, and an additional entry for a EntityRef.forNameValue(String).
static List<? extends de.xima.cmn.validation.spec.IChoiceEntry<NodeKey>>	createNodeSelectItems(List<INodeWithName> nodes)
static List<? extends de.xima.cmn.validation.spec.IChoiceEntry<QualifiedSubmitButton>>	createQualifiedSubmitButtonSelectItems(List<IWorkflowQualifiedSubmitButton> submitButtons, Locale locale)
static <T extends IUUIDEntity & INameProviding & IDescriptionProviding> List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>>	createSelectItems(List<T> entities)
static List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>>	createStateSelectItems(List<WorkflowStateModel> states, Locale locale)
static List<? extends de.xima.cmn.validation.spec.IChoiceEntry<String>>	createSubmitButtonSelectItems(List<IWorkflowSubmitButton> submitButtons, Locale locale)
static List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UUID>>	createTaskSelectItems(List<ITaskWithName> tasks)
static List<? extends de.xima.cmn.validation.spec.IChoiceEntry<TriggerKey>>	createTriggerSelectItems(List<ITriggerWithName> triggers)
static List<? extends de.xima.cmn.validation.spec.IChoiceEntry<String>>	createUploadElementSelectItems(List<String> uploadElements)

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowProviderHelper

public WorkflowProviderHelper()

Method Detail

computeAllAttachmentSources

public static List<EAttachmentSource> computeAllAttachmentSources()

computeAllClientCounterRefs

public static List<EntityRef> computeAllClientCounterRefs(IEntityContext ec,
                                                          Mandant client)

computeAllClientCounters

public static List<ClientCounter> computeAllClientCounters(IEntityContext ec,
                                                           Mandant client)

computeAllClientResources

public static List<MandantRessource> computeAllClientResources(IEntityContext ec,
                                                               Mandant client)

computeAllDatabaseConnections

public static List<DatenbankZugriff> computeAllDatabaseConnections(IEntityContext ec,
                                                                   Mandant currentClient)

computeAllDatabaseQueries

public static List<Datenquelle> computeAllDatabaseQueries(IEntityContext ec,
                                                          Mandant client)

computeAllFormElements

public static List<String> computeAllFormElements(IEntityContext ec,
                                                  Projekt project)

computeAllInboxes

public static List<Postfach> computeAllInboxes(IEntityContext ec,
                                               Mandant currentClient)

computeAllLdapConnections

public static List<LDAPZugriff> computeAllLdapConnections(IEntityContext ec,
                                                          Mandant client)

computeAllLdapQueries

public static List<LDAPAbfrage> computeAllLdapQueries(IEntityContext ec,
                                                      Mandant client)

computeAllNodesOfType

public static List<INodeWithName> computeAllNodesOfType(IWorkflowValidationEnvironmentData envData,
                                                        WorkflowElementIndex elementIndex,
                                                        String type)

computeAllProjectResources

public static List<ProjektRessource> computeAllProjectResources(IEntityContext ec,
                                                                Projekt project)

computeAllQualifiedSubmitButtons

public static List<IWorkflowQualifiedSubmitButton> computeAllQualifiedSubmitButtons(IEntityContext ec,
                                                                                    Mandant client,
                                                                                    Projekt project,
                                                                                    Locale locale,
                                                                                    FormPersist persistOverride)

computeAllStateModels

public static List<WorkflowStateModel> computeAllStateModels(IEntityContext ec,
                                                             WorkflowVersion workflowVersion,
                                                             Locale locale)

computeAllSubmitButtons

public static List<IWorkflowSubmitButton> computeAllSubmitButtons(IEntityContext ec,
                                                                  Mandant client,
                                                                  Projekt project,
                                                                  Locale locale,
                                                                  FormPersist persistOverride)

computeAllTasks

public static List<ITaskWithName> computeAllTasks(IWorkflowValidationEnvironmentData envData,
                                                  WorkflowElementIndex elementIndex,
                                                  UUID taskToExclude)

computeAllTriggersOfType

public static List<ITriggerWithName> computeAllTriggersOfType(IWorkflowValidationEnvironmentData envData,
                                                              WorkflowElementIndex elementIndex,
                                                              String type,
                                                              UUID taskToExclude)

computeAllUploadElements

public static List<String> computeAllUploadElements(IEntityContext ec,
                                                    Projekt project)

computeAllUserGroups

public static List<BenutzerGruppe> computeAllUserGroups(IEntityContext ec,
                                                        Mandant currentClient)

computeAllUsers

public static List<Benutzer> computeAllUsers(IEntityContext ec,
                                             Mandant currentClient)

computeAvailableResources

public static List<? extends de.xima.cmn.validation.spec.IChoiceEntry<ResourceItem>> computeAvailableResources(List<ProjektRessource> projectResources,
                                                                                                               List<MandantRessource> clientResources,
                                                                                                               List<String> uploadElements,
                                                                                                               List<INodeWithName> providingActions,
                                                                                                               boolean includeForm,
                                                                                                               boolean includeClient,
                                                                                                               boolean includeExternal,
                                                                                                               boolean includeAttachmentSearch,
                                                                                                               boolean includeUpload,
                                                                                                               boolean includeProvidingAction,
                                                                                                               String[] extensions,
                                                                                                               Locale locale)

Parameters:

projectResources - a list of form resources

clientResources - a list of client resources

uploadElements - a list of upload element names

providingActions - a list of previous file-providing actions

includeForm - if true, the form resources selection is added to the result list

includeClient - if true, the client resources selection is added to the result list

includeExternal - if true, a selection for an URL resource is added to the result list

includeAttachmentSearch - if true, a selection for an attachment filename search is added to the result list

includeUpload - if true, the file upload elements are added to the result list

includeProvidingAction - if true, the providing file elements from previous action are added to the result list

extensions - an array of allowed file extensions

locale - the current locale

Returns:

a list of computed SelectItems

computeDeadNodes

public static Set<NodeKey> computeDeadNodes(WorkflowFlowAnalysis analysis,
                                            ProcessModel processModel)

computeFlowAnalysis

public static <TElement extends IWorkflowNodeTypeProviding & IActiveFlagProviding> WorkflowFlowAnalysis computeFlowAnalysis(List<IElementWithTask<TElement>> rootNodes,
                                                                                                                            ITreeAccessor<TElement,UUID> accessor,
                                                                                                                            Mandant client)

computeInstalledCharsets

public static List<Charset> computeInstalledCharsets()

computeInstalledFontNames

public static List<String> computeInstalledFontNames()

computeNodeNames

public static <T extends IWorkflowElementTypeProviding> List<INodeWithName> computeNodeNames(Mandant client,
                                                                                             FlowchartElementIndex elementIndex,
                                                                                             Map<ElementKey,com.alibaba.fastjson.JSONObject> paramsMap,
                                                                                             Iterable<NodeKey> nodeKeys)

computeNonOrderableAuthenticatorConfigs

public static List<BaseConfigViewModel> computeNonOrderableAuthenticatorConfigs(IEntityContext ec,
                                                                                Mandant client,
                                                                                Locale locale,
                                                                                boolean kerberosActive,
                                                                                boolean ntlmActive)

Parameters:

ec - Current entity context for accessing the database.

client - Client for which to compute the authenticators.

locale - Locale for the authenticator names.

kerberosActive - Whether Kerberos is available. Affects whether Kerberos-based authenticators are added.

ntlmActive - Whether NTLM is available. Affects whether NTLM-based authenticators are added.

Returns:

All non-orderable authenticators available to the given client.

computeOrderableAuthenticatorConfigs

public static List<BaseConfigViewModel> computeOrderableAuthenticatorConfigs(IEntityContext ec,
                                                                             Mandant client,
                                                                             Locale locale,
                                                                             boolean kerberosActive,
                                                                             boolean ntlmActive)

Parameters:

ec - Current entity context for accessing the database.

client - Client for which to compute the authenticators.

locale - Locale for the authenticator names.

kerberosActive - Whether Kerberos is available. Affects whether Kerberos-based authenticators are added.

ntlmActive - Whether NTLM is available. Affects whether NTLM-based authenticators are added.

Returns:

All orderable authenticators available to the given client.

computePredecessors

public static List<INodeWithName> computePredecessors(IBaseEnvironmentData environmentData,
                                                      IWorkflowFlowAnalysis analysis,
                                                      NodeKey target,
                                                      Map<NodeKey,IWorkflowElementWithDeserializedModel<?,WorkflowNode>> index)

Finds all previous nodes for the given target node.

Parameters:

environmentData - Data with the client, entity context etc.

analysis - Execution analysis that was performed on the model

target - Node for which to find previous nodes.

index - Index mapping node keys to nodes.

Returns:

All previous nodes for the given target node.

computeProvidingNodes

public static List<INodeWithName> computeProvidingNodes(Mandant client,
                                                        Iterable<IWorkflowElementWithDeserializedModel<?,WorkflowNode>> wrappers)

computeProvidingNodes

public static List<INodeWithName> computeProvidingNodes(Mandant client,
                                                        Map<NodeKey,NodeModel> nodeMap,
                                                        Function<Map.Entry<NodeKey,NodeModel>,?> getData)

computeProvidingPredecessors

public static List<INodeWithName> computeProvidingPredecessors(IBaseEnvironmentData environmentData,
                                                               IWorkflowFlowAnalysis analysis,
                                                               NodeKey target,
                                                               Map<NodeKey,IWorkflowElementWithDeserializedModel<?,WorkflowNode>> index)

Finds all previous nodes that can provide files for the given target node.

Parameters:

environmentData - Data with the client, entity context etc.

analysis - Execution analysis that was performed on the model

target - Node for which to find previous file providing nodes.

index - Index mapping node keys to nodes.

Returns:

All previous nodes that can provide files for the given target node.

computeProvidingPredecessors

public static List<NodeKey> computeProvidingPredecessors(Mandant client,
                                                         IWorkflowFlowAnalysis analysis,
                                                         NodeKey target,
                                                         Map<NodeKey,NodeModel> index)

Finds all previous nodes that can provide files for the given target node.

Parameters:

client - Current client.

analysis - Execution analysis that was performed on the model

target - Node for which to find previous file providing nodes.

index - Map between a node key and the corresponding node.

Returns:

All previous nodes that can provide files for the given target node.

computeStandardSupportedCharsets

public static List<Charset> computeStandardSupportedCharsets()

computeTextTemplatesByCategory

public static List<Textbaustein> computeTextTemplatesByCategory(IEntityContext ec,
                                                                Mandant client,
                                                                ETextbausteinKategorie cat)

computeTriggerName

public static <T extends IWorkflowElementTypeProviding> ITriggerWithName computeTriggerName(UUID taskUuid,
                                                                                            TriggerModel trigger,
                                                                                            Map<ElementKey,com.alibaba.fastjson.JSONObject> paramsMap,
                                                                                            Mandant client)

computeTriggerNames

public static <T extends IWorkflowElementTypeProviding> List<ITriggerWithName> computeTriggerNames(Mandant client,
                                                                                                   FlowchartElementIndex elementIndex,
                                                                                                   Map<ElementKey,com.alibaba.fastjson.JSONObject> paramsMap,
                                                                                                   Iterable<TriggerKey> triggerKeys)

createEntityRefsWithNameSelectItems

public static <T extends IUUIDEntity & INameProviding & IDescriptionProviding> List<? extends de.xima.cmn.validation.spec.IChoiceEntry<EntityRef>> createEntityRefsWithNameSelectItems(List<T> entities,
                                                                                                                                                                                       String labelEntities,
                                                                                                                                                                                       String labelOthers,
                                                                                                                                                                                       String labelName)

Creates a list of choice entries with an EntityRef for each entity, and an additional entry for a EntityRef.forNameValue(String). The entities are placed in one IChoiceGroup, and the name entry in a separate choice group.

Type Parameters:

T - Type of the entities.

Parameters:

entities - Entities to process.

labelEntities - Localized name for the choice group with the entities.

labelOthers - Localized name for the choice group with the name entry.

labelName - Localized name of the name entry.

Returns:

A list of choice entries with an EntityRef for each entity, and an additional entry for a EntityRef.forNameValue(String).

createEntityRefsWithName

public static <T extends IUUIDEntity & INameProviding & IDescriptionProviding> List<EntityRef> createEntityRefsWithName(List<T> entities)

Creates a list of EntityRefs with one entry for each entity, and an additional entry for a EntityRef.forNameValue(String).

Type Parameters:

T - Type of the entities.

Parameters:

entities - Entities to process.

Returns:

A list of EntityRefs with one entry for each entity, and an additional entry for a EntityRef.forNameValue(String).

createNodeSelectItems

public static List<? extends de.xima.cmn.validation.spec.IChoiceEntry<NodeKey>> createNodeSelectItems(List<INodeWithName> nodes)

createQualifiedSubmitButtonSelectItems

public static List<? extends de.xima.cmn.validation.spec.IChoiceEntry<QualifiedSubmitButton>> createQualifiedSubmitButtonSelectItems(List<IWorkflowQualifiedSubmitButton> submitButtons,
                                                                                                                                     Locale locale)

createSelectItems

public static <T extends IUUIDEntity & INameProviding & IDescriptionProviding> List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> createSelectItems(List<T> entities)

createStateSelectItems

public static List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> createStateSelectItems(List<WorkflowStateModel> states,
                                                                                                             Locale locale)

createSubmitButtonSelectItems

public static List<? extends de.xima.cmn.validation.spec.IChoiceEntry<String>> createSubmitButtonSelectItems(List<IWorkflowSubmitButton> submitButtons,
                                                                                                             Locale locale)

createTaskSelectItems

public static List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UUID>> createTaskSelectItems(List<ITaskWithName> tasks)

createTriggerSelectItems

public static List<? extends de.xima.cmn.validation.spec.IChoiceEntry<TriggerKey>> createTriggerSelectItems(List<ITriggerWithName> triggers)

createUploadElementSelectItems

public static List<? extends de.xima.cmn.validation.spec.IChoiceEntry<String>> createUploadElementSelectItems(List<String> uploadElements)