com.asakusafw.yaess.core

Class YaessProfile

java.lang.Object

com.asakusafw.yaess.core.YaessProfile

public class YaessProfile
extends Object

Profile services for YAESS.

Since:

0.2.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFIX_COMMAND The key prefix of command script handlers profile.
static String	PREFIX_CORE The key prefix of core profile.
static String	PREFIX_HADOOP The key prefix of Hadoop script handler profile.
static String	PREFIX_LOCK The key prefix of lock provider profile.
static String	PREFIX_MONITOR The key prefix of monitor profile.
static String	PREFIX_SCHEDULER The key prefix of job scheduler profile.
static char	QUALIFIER The qualifier delimiter for each property keys.

Constructor Summary

Constructors

Constructor and Description
YaessProfile(ServiceProfile<CoreProfile> core, ServiceProfile<ExecutionMonitorProvider> monitors, ServiceProfile<ExecutionLockProvider> locks, ServiceProfile<JobScheduler> scheduler, ServiceProfile<HadoopScriptHandler> hadoopHandler, Collection<ServiceProfile<CommandScriptHandler>> commandHandlers) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Map<String,ServiceProfile<CommandScriptHandler>>	getCommandHandlers() Returns command script handlers for each target profile name.
ServiceProfile<CoreProfile>	getCore() Returns a core profile.
ServiceProfile<HadoopScriptHandler>	getHadoopHandler() Returns a Hadoop script handler.
ServiceProfile<ExecutionLockProvider>	getLocks() Returns a lock provider.
ServiceProfile<ExecutionMonitorProvider>	getMonitors() Returns a monitor provider.
ServiceProfile<JobScheduler>	getScheduler() Returns a job scheduler.
static YaessProfile	load(Properties properties, ClassLoader classLoader) Deprecated. use load(Properties, ProfileContext) instead
static YaessProfile	load(Properties properties, ProfileContext context) Loads a YAESS profile from the specified properties.

Methods inherited from class java.lang.Object

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

Field Detail

QUALIFIER

public static final char QUALIFIER

The qualifier delimiter for each property keys.

See Also:

Constant Field Values

PREFIX_CORE

public static final String PREFIX_CORE

The key prefix of core profile. This profile must describes CoreProfile service.

See Also:

Constant Field Values

PREFIX_MONITOR

public static final String PREFIX_MONITOR

The key prefix of monitor profile. This profile must describes ExecutionMonitorProvider service.

See Also:

Constant Field Values

PREFIX_LOCK

public static final String PREFIX_LOCK

The key prefix of lock provider profile. This profile must describes ExecutionLockProvider service.

See Also:

Constant Field Values

PREFIX_SCHEDULER

public static final String PREFIX_SCHEDULER

The key prefix of job scheduler profile. This profile must describes JobScheduler service.

See Also:

Constant Field Values

PREFIX_HADOOP

public static final String PREFIX_HADOOP

The key prefix of Hadoop script handler profile. This profile must describes HadoopScriptHandler service.

See Also:

Constant Field Values

PREFIX_COMMAND

public static final String PREFIX_COMMAND

The key prefix of command script handlers profile. Each command script handler must be use "command.<profile-name>" as its prefix. This profile must describes CommandScriptHandler service.

See Also:

Constant Field Values

Constructor Detail

YaessProfile

public YaessProfile(ServiceProfile<CoreProfile> core,
                    ServiceProfile<ExecutionMonitorProvider> monitors,
                    ServiceProfile<ExecutionLockProvider> locks,
                    ServiceProfile<JobScheduler> scheduler,
                    ServiceProfile<HadoopScriptHandler> hadoopHandler,
                    Collection<ServiceProfile<CommandScriptHandler>> commandHandlers)

Creates a new instance.

Parameters:

core - core profile

monitors - monitor profile

locks - lock profile

scheduler - scheduler profile

hadoopHandler - hadoop handler profile

commandHandlers - command handler profiles

Throws:

IllegalArgumentException - if some parameters were null

Method Detail

load

@Deprecated
public static YaessProfile load(Properties properties,
                                            ClassLoader classLoader)

Deprecated. use load(Properties, ProfileContext) instead

Loads a YAESS profile from the specified properties.

Parameters:

properties - source properties

classLoader - the class loader to load the service class

Returns:

the loaded profile

Throws:

IllegalArgumentException - if the target profile is invalid, or parameters contain null

load

public static YaessProfile load(Properties properties,
                                ProfileContext context)

Loads a YAESS profile from the specified properties.

Parameters:

properties - source properties

context - the current profile context

Returns:

the loaded profile

Throws:

IllegalArgumentException - if the target profile is invalid, or parameters contain null

Since:

0.2.4

getCore

public ServiceProfile<CoreProfile> getCore()

Returns a core profile.

Returns:

core profile

getMonitors

public ServiceProfile<ExecutionMonitorProvider> getMonitors()

Returns a monitor provider.

Returns:

monitor provider

getLocks

public ServiceProfile<ExecutionLockProvider> getLocks()

Returns a lock provider.

Returns:

lock provider

getScheduler

public ServiceProfile<JobScheduler> getScheduler()

Returns a job scheduler.

Returns:

the scheduler

getHadoopHandler

public ServiceProfile<HadoopScriptHandler> getHadoopHandler()

Returns a Hadoop script handler.

Returns:

Hadoop script handler

getCommandHandlers

public Map<String,ServiceProfile<CommandScriptHandler>> getCommandHandlers()

Returns command script handlers for each target profile name.

Returns:

the command script handlers