com.asakusafw.yaess.core

Class ExecutionLockProvider

java.lang.Object

com.asakusafw.yaess.core.ExecutionLockProvider

All Implemented Interfaces:

Service

Direct Known Subclasses:

BasicLockProvider

public abstract class ExecutionLockProvider
extends Object
implements Service

Provides lock feature. This feature should be used only for controlling simultaneous executions. Ordinally, locks are released when the JVM is terminated.

Since:

0.2.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_SCOPE The configuration key name of the lock scope.

Constructor Summary

Constructors

Constructor and Description
ExecutionLockProvider()

Method Summary

Modifier and Type	Method and Description
void	configure(ServiceProfile<?> profile) Configures this service.
protected abstract void	doConfigure(ServiceProfile<?> profile) Configures this provider internally (extention point).
protected abstract ExecutionLock	newInstance(ExecutionLock.Scope lockScope, String batchId) Creates a new lock manager.
ExecutionLock	newInstance(String batchId) Creates a new lock manager.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_SCOPE

public static final String KEY_SCOPE

The configuration key name of the lock scope. This must be one of ExecutionLock.Scope. If this key is not specified, a default scope is selected.

See Also:

Constant Field Values

Constructor Detail

ExecutionLockProvider

public ExecutionLockProvider()

Method Detail

configure

public final void configure(ServiceProfile<?> profile)
                     throws InterruptedException,
                            IOException

Description copied from interface: Service

Configures this service. This method will be invoked only once when this instance is created from the profile.

Specified by:

configure in interface Service

Parameters:

profile - the profile of this service

Throws:

InterruptedException - if interrupted in configuration

IOException - if failed to configure this service

doConfigure

protected abstract void doConfigure(ServiceProfile<?> profile)
                             throws InterruptedException,
                                    IOException

Configures this provider internally (extention point).

Parameters:

profile - the profile of this service

Throws:

InterruptedException - if interrupted in configuration

IOException - if failed to configure this service

newInstance

public final ExecutionLock newInstance(String batchId)
                                throws IOException

Creates a new lock manager. This operation may acquire a lock for the specified batch (only if the configured scope is supported).

Parameters:

batchId - the current batch ID

Returns:

the created instance

Throws:

IOException - if failed to acquire the lock

IllegalArgumentException - if some parameters were null

newInstance

protected abstract ExecutionLock newInstance(ExecutionLock.Scope lockScope,
                                             String batchId)
                                      throws IOException

Creates a new lock manager.

Parameters:

lockScope - target scope

batchId - the current batch ID

Returns:

the created instance

Throws:

IOException - if failed to acquire the lock