com.asakusafw.workflow.executor

Class TaskExecutors

java.lang.Object

com.asakusafw.workflow.executor.TaskExecutors

public final class TaskExecutors
extends Object

Utilities for TaskExecutor.

Since:

0.10.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TaskExecutors.IoConsumer<T> Represents an action.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENV_BATCHAPPS_PATH The environment variable of application installation path.
static String	ENV_FRAMEWORK_PATH The environment variable of framework installation path.
static String	LOCATION_APPLICATION_WORKFLOW_DEFINITION The workflow information file path (relative from each application directory).

Method Summary

Modifier and Type	Method and Description
static Optional<Path>	findApplicationFile(TaskExecutionContext context, String location) Returns a file in the current batch application package.
static Optional<Path>	findApplicationHome(ExecutionContext context) Returns the batch application installation base path.
static Optional<Path>	findApplicationHome(Map<String,String> environmentVariables) Returns the batch application installation base path.
static Optional<Path>	findApplicationWorkflowDefinitionFile(TaskExecutionContext context) Returns an application workflow definition file.
static Set<Path>	findAttachedLibraries(TaskExecutionContext context) Returns the attached library files.
static Optional<Path>	findCoreConfigurationFile(ExecutionContext context) Returns the core configuration file.
static Optional<URL>	findCoreConfigurationUrl(ExecutionContext context) Returns the core configuration URL only if it exists.
static Set<Path>	findCoreLibraries(ExecutionContext context) Returns the framework core library files.
static Set<Path>	findExtensionLibraries(ExecutionContext context) Returns the framework extension library files.
static Optional<Path>	findFrameworkFile(ExecutionContext context, String location) Returns a framework file.
static Optional<Path>	findFrameworkHome(ExecutionContext context) Returns the framework installation path.
static Optional<Path>	findFrameworkHome(Map<String,String> environmentVariables) Returns the framework installation path.
static Set<Path>	findFrameworkLibraries(ExecutionContext context, String location) Returns the library files on the framework directory.
static Set<Path>	findHadoopEmbeddedLibraries(ExecutionContext context) Returns the Hadoop embedded library files.
static Optional<Path>	findJobflowLibrary(TaskExecutionContext context) Returns the jobflow library file.
static Path	getUserHome(ExecutionContext context) Returns the current user home directory.
static String	getUserName(ExecutionContext context) Returns the current user name.
static Collection<TaskExecutor>	loadDefaults(ClassLoader serviceLoader) Returns the default task executor objects via SPI.
static String	resolveCommandToken(TaskExecutionContext context, CommandToken token) Resolves a CommandToken for the current execution context.
static List<String>	resolveCommandTokens(TaskExecutionContext context, List<? extends CommandToken> tokens) Resolves a list of CommandToken for the current execution context.
static String	resolvePath(TaskExecutionContext context, String path) Resolves a path string using the current context.
static void	withLibraries(TaskExecutionContext context, List<? extends Path> libraries, TaskExecutors.IoConsumer<? super ClassLoader> action) Loads the libraries and performs the given action.
static void	withLibraries(TaskExecutionContext context, TaskExecutors.IoConsumer<? super ClassLoader> action) Loads the current batch libraries and performs the given action.

Methods inherited from class java.lang.Object

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

Field Detail

ENV_FRAMEWORK_PATH

public static final String ENV_FRAMEWORK_PATH

The environment variable of framework installation path.

See Also:

Constant Field Values

ENV_BATCHAPPS_PATH

public static final String ENV_BATCHAPPS_PATH

The environment variable of application installation path.

See Also:

Constant Field Values

LOCATION_APPLICATION_WORKFLOW_DEFINITION

public static final String LOCATION_APPLICATION_WORKFLOW_DEFINITION

The workflow information file path (relative from each application directory).

See Also:

Constant Field Values

Method Detail

loadDefaults

public static Collection<TaskExecutor> loadDefaults(ClassLoader serviceLoader)

Returns the default task executor objects via SPI.

Parameters:

serviceLoader - the service loader

Returns:

the default task executors

findFrameworkHome

public static Optional<Path> findFrameworkHome(Map<String,String> environmentVariables)

Returns the framework installation path.

Parameters:

environmentVariables - the environment variables

Returns:

the framework installation path

findApplicationHome

public static Optional<Path> findApplicationHome(Map<String,String> environmentVariables)

Returns the batch application installation base path.

Parameters:

environmentVariables - the environment variables

Returns:

the batch application installation base path

getUserName

public static String getUserName(ExecutionContext context)

Returns the current user name.

Parameters:

context - the current context

Returns:

the current user name

getUserHome

public static Path getUserHome(ExecutionContext context)

Returns the current user home directory.

Parameters:

context - the current context

Returns:

the current user home directory

findFrameworkHome

public static Optional<Path> findFrameworkHome(ExecutionContext context)

Returns the framework installation path.

Parameters:

context - the current task execution context

Returns:

the framework file path

findFrameworkFile

public static Optional<Path> findFrameworkFile(ExecutionContext context,
                                               String location)

Returns a framework file.

Parameters:

context - the current task execution context

location - the relative location from the framework installation root

Returns:

the framework file path

findApplicationHome

public static Optional<Path> findApplicationHome(ExecutionContext context)

Returns the batch application installation base path.

Parameters:

context - the current context

Returns:

the batch application installation base path

findApplicationFile

public static Optional<Path> findApplicationFile(TaskExecutionContext context,
                                                 String location)

Returns a file in the current batch application package.

Parameters:

context - the current task execution context

location - the relative location from the batch application package root

Returns:

the application file path

findApplicationWorkflowDefinitionFile

public static Optional<Path> findApplicationWorkflowDefinitionFile(TaskExecutionContext context)

Returns an application workflow definition file.

Parameters:

context - the current task execution context

Returns:

the definition file

resolvePath

public static String resolvePath(TaskExecutionContext context,
                                 String path)

Resolves a path string using the current context.

Parameters:

context - the current task execution context

path - the target path expression

Returns:

the resolved path

resolveCommandTokens

public static List<String> resolveCommandTokens(TaskExecutionContext context,
                                                List<? extends CommandToken> tokens)

Resolves a list of CommandToken for the current execution context.

Parameters:

context - the current task execution context

tokens - the target command tokens

Returns:

the resolved tokens

resolveCommandToken

public static String resolveCommandToken(TaskExecutionContext context,
                                         CommandToken token)

Resolves a CommandToken for the current execution context.

Parameters:

context - the current task execution context

token - the target command token

Returns:

the resolved token

findJobflowLibrary

public static Optional<Path> findJobflowLibrary(TaskExecutionContext context)

Returns the jobflow library file.

Parameters:

context - the current task execution context

Returns:

the library file

findCoreConfigurationFile

public static Optional<Path> findCoreConfigurationFile(ExecutionContext context)

Returns the core configuration file.

Parameters:

context - the current task execution context

Returns:

the configuration file (a.k.a. "asakusa-runtime.xml")

findCoreConfigurationUrl

public static Optional<URL> findCoreConfigurationUrl(ExecutionContext context)

Returns the core configuration URL only if it exists.

Parameters:

context - the current task execution context

Returns:

the configuration file (a.k.a. "asakusa-runtime.xml")

findAttachedLibraries

public static Set<Path> findAttachedLibraries(TaskExecutionContext context)

Returns the attached library files.

Parameters:

context - the current task execution context

Returns:

the library files, or an empty set if there are no such files

findFrameworkLibraries

public static Set<Path> findFrameworkLibraries(ExecutionContext context,
                                               String location)

Returns the library files on the framework directory.

Parameters:

context - the current task execution context

location - the directory location (relative from the framework installation path)

Returns:

the library files, or an empty set if there are no such files

findCoreLibraries

public static Set<Path> findCoreLibraries(ExecutionContext context)

Returns the framework core library files.

Parameters:

context - the current task execution context

Returns:

the library files, or an empty set if there are no such files

findHadoopEmbeddedLibraries

public static Set<Path> findHadoopEmbeddedLibraries(ExecutionContext context)

Returns the Hadoop embedded library files.

Parameters:

context - the current task execution context

Returns:

the library files, or an empty set if there are no such files

findExtensionLibraries

public static Set<Path> findExtensionLibraries(ExecutionContext context)

Returns the framework extension library files.

Parameters:

context - the current task execution context

Returns:

the library files, or an empty set if there are no such files

withLibraries

public static void withLibraries(TaskExecutionContext context,
                                 TaskExecutors.IoConsumer<? super ClassLoader> action)
                          throws IOException,
                                 InterruptedException

Loads the current batch libraries and performs the given action.

Parameters:

context - the current context

action - the target action

Throws:

IOException - if I/O error was occurred in this action

InterruptedException - if interrupted while executing this action

withLibraries

public static void withLibraries(TaskExecutionContext context,
                                 List<? extends Path> libraries,
                                 TaskExecutors.IoConsumer<? super ClassLoader> action)
                          throws IOException,
                                 InterruptedException

Loads the libraries and performs the given action.

Parameters:

context - the current context

libraries - the target libraries

action - the target action

Throws:

IOException - if I/O error was occurred in this action

InterruptedException - if interrupted while executing this action