com.asakusafw.windgate.core.resource

Class ResourceMirror

java.lang.Object

com.asakusafw.windgate.core.resource.ResourceMirror

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

AbstractSshHadoopFsMirror, FileResourceMirror, FileResourceMirror, HadoopFsMirror, JdbcResourceMirror

public abstract class ResourceMirror
extends Object
implements Closeable

An abstract implementation of logical data store resources.

Since:

0.2.2

Constructor Summary

Constructors

Constructor and Description
ResourceMirror()

Method Summary

Modifier and Type	Method and Description
abstract <T> DrainDriver<T>	createDrain(ProcessScript<T> script) Creates a new drain driver for this resource.
abstract <T> SourceDriver<T>	createSource(ProcessScript<T> script) Creates a new source driver for this resource.
abstract String	getName() Returns the name of this resource.
boolean	isTransactional() Returns whether this resource is transactional.
void	onSessionCompleting() Invoke before the session was completed.
void	onSessionCreated() Invoke after the session was created.
abstract void	prepare(GateScript script) Prepares this resource for the specified execution.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

ResourceMirror

public ResourceMirror()

Method Detail

getName

public abstract String getName()

Returns the name of this resource.

Returns:

the name of this resource

isTransactional

public boolean isTransactional()

Returns whether this resource is transactional. Transactional resources must be up to one in the profile. If this is transactional resource, this will be invoked onSessionCreated() before the other resources, and onSessionCompleting() after the other resources. The default implementation always returns false.

Returns:

true if this resource is transactional, otherwise false

onSessionCreated

public void onSessionCreated()
                      throws IOException

Invoke after the session was created. This method will be invoked only once for each instance.

Throws:

IOException - if failed to execute

onSessionCompleting

public void onSessionCompleting()
                         throws IOException

Invoke before the session was completed. This method will be invoked only once for each instance, and only invoked after finished all gate processes corresponding to this resource. If this method raises an exception, the session can not be completed.

Throws:

IOException - if failed to execute

prepare

public abstract void prepare(GateScript script)
                      throws IOException

Prepares this resource for the specified execution. This method will be invoked only once for each instance.

Parameters:

script - target script

Throws:

IOException - if failed to prepare this resource

IllegalArgumentException - if any parameter is null

createSource

public abstract <T> SourceDriver<T> createSource(ProcessScript<T> script)
                                          throws IOException

Creates a new source driver for this resource. This method will be invoked only after prepare(GateScript) was completed.

Type Parameters:

T - target data model type

Parameters:

script - target process

Returns:

the created driver

Throws:

IOException - if failed to open this resource

IllegalArgumentException - if any parameter is null

createDrain

public abstract <T> DrainDriver<T> createDrain(ProcessScript<T> script)
                                        throws IOException

Creates a new drain driver for this resource. This method will be invoked only after prepare(GateScript) was completed.

Type Parameters:

T - target data model type

Parameters:

script - target process

Returns:

the created driver

Throws:

IOException - if failed to open this resource

IllegalArgumentException - if any parameter is null