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

Class InjectableValidationContext

java.lang.Object

de.xima.fc.workflow.processor.logic.validation.InjectableValidationContext

All Implemented Interfaces:

IBaseEnvironmentData, IWorkflowValidationEnvironmentData, IBaseWorkflowEnvironmentData, IWorkflowLocalBeanValidationContext, IWorkflowLocalValidationContext, IWorkflowValidationContext

@Default
@ApplicationScoped
public class InjectableValidationContext
extends Object
implements IWorkflowLocalBeanValidationContext

A IWorkflowLocalHandlerValidationContext that can be injected via dependency injection. Can be used to access the context during bean validation. Retrieves the context in several ways depending on how bean validation was initiated.

During workflow validation via IWorkflowValidator, the current validation context is set by the workflow validator when validation starts and removed when it ends.

During JSF bean validation, the context is read from the workflow provider bean via the FacesContext.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
InjectableValidationContext()

Method Summary

Modifier and Type	Method	Description
<T> T	associateValue(Object key, Function<IWorkflowLocalValidationContext,T> supplier)	Associates the given value for the duration of the workflow validation process.
Mandant	getClient()
ElementKey	getCurrentElementKey()
IEntityContext	getEntityContext()
Locale	getLocale()
Projekt	getProject()
IWorkflowProvider	getProvider()
Benutzer	getUser()	Deprecated. Use getUserModel() instead.
IUser	getUserModel()
WorkflowVersion	getWorkflowVersion()
IWorkflowElementValidationResultBuilder	resultBuilder()
static void	setBeanValidationContext(Class<? extends IWorkflowValidationContext> context)
static void	setCurrentValidationContext(DefaultWorkflowValidationContext context)	Sets the given context for the current thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

InjectableValidationContext

public InjectableValidationContext()

Method Detail

associateValue

public <T> T associateValue(Object key,
                            Function<IWorkflowLocalValidationContext,T> supplier)

Description copied from interface: IWorkflowLocalValidationContext

Associates the given value for the duration of the workflow validation process. Once validation is done, the values are discarded.

Specified by:

associateValue in interface IWorkflowLocalValidationContext

Type Parameters:

T - Type of the associate value.

Parameters:

key - Key for the association.

supplier - Supplier that produces the value when not yet present.

Returns:

The associated value.

getClient

public Mandant getClient()

Specified by:

getClient in interface IBaseEnvironmentData

Returns:

The Mandant of the current context.

getCurrentElementKey

public ElementKey getCurrentElementKey()

Specified by:

getCurrentElementKey in interface IWorkflowLocalBeanValidationContext

Returns:

The ElementKey of the current workflow node or trigger that is currently being checked in the current workflow process. null when no such element key exists.

getEntityContext

public IEntityContext getEntityContext()

Specified by:

getEntityContext in interface IBaseEnvironmentData

Returns:

The current entity context that may be used for database interactions.

getLocale

public Locale getLocale()

Specified by:

getLocale in interface IBaseEnvironmentData

Returns:

The locale to use for locale-sensitive actions.

getProject

public Projekt getProject()

Specified by:

getProject in interface IBaseWorkflowEnvironmentData

Returns:

The current project to which the workflow belongs.

getProvider

public IWorkflowProvider getProvider()

Specified by:

getProvider in interface IWorkflowValidationContext

Returns:

The provider for accessing various contextual data, such as a list of all users or user groups.

getUserModel

public IUser getUserModel()

Specified by:

getUserModel in interface IBaseEnvironmentData

Returns:

The user of the active context that should be used for protocol entries etc.

getWorkflowVersion

public WorkflowVersion getWorkflowVersion()

Specified by:

getWorkflowVersion in interface IBaseWorkflowEnvironmentData

Returns:

The current workflow version that is being validated.

resultBuilder

public IWorkflowElementValidationResultBuilder resultBuilder()

Specified by:

resultBuilder in interface IWorkflowLocalValidationContext

Returns:

Builder for creating the result that needs to be returned by IElementHandler#validateLocal. This is provided for convenience, you can also create your own implementation of IWorkflowElementValidationResult.

getUser

@Deprecated
public Benutzer getUser()

Deprecated.

Use getUserModel() instead.

Specified by:

getUser in interface IBaseEnvironmentData

Returns:

The user of the active context that should be used for protocol entries etc.

setBeanValidationContext

public static void setBeanValidationContext(Class<? extends IWorkflowValidationContext> context)

Parameters:

context - The bean class to use when performing a bean validation via JSF. The validation context attempts to retrieve a bean of the given class from the current thread-local faces context.

setCurrentValidationContext

public static void setCurrentValidationContext(DefaultWorkflowValidationContext context)

Sets the given context for the current thread. Multiple threads may call this method with different contexts. When set, this context is used. When not set, attempts to find the bean validation context for the class set by setBeanValidationContext(Class).

Parameters:

context - Validation context to use.