com.asakusafw.windgate.core.resource

Class ResourceProvider

java.lang.Object

com.asakusafw.windgate.core.BaseProvider<ResourceProfile>

com.asakusafw.windgate.core.resource.ResourceProvider

Direct Known Subclasses:

FileResourceProvider, FileResourceProvider, HadoopFsProvider, JdbcResourceProvider, JschHadoopFsProvider, VoidResourceProvider

public abstract class ResourceProvider
extends BaseProvider<ResourceProfile>

An abstract super class of resource factory. Clients can inherit this class to provide new data sources. Each subclass must provide a public constructor with no parameters.

Since:

0.2.2

Constructor Summary

Constructors

Constructor and Description
ResourceProvider()

Method Summary

Modifier and Type	Method and Description
void	abort(String sessionId) Aborts the specified session corresponding to this resouce.
void	abortAll() Aborts all sessions corresponding to this resouce.
abstract ResourceMirror	create(String sessionId, ParameterList arguments) Provides a new ResourceMirror.
ResourceManipulator	createManipulator(ParameterList arguments) Provides a new ResourceManipulator.

Methods inherited from class com.asakusafw.windgate.core.BaseProvider

configure

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceProvider

public ResourceProvider()

Method Detail

create

public abstract ResourceMirror create(String sessionId,
                                      ParameterList arguments)
                               throws IOException

Provides a new ResourceMirror.

Parameters:

sessionId - the current session ID

arguments - arguments (key and value pairs)

Returns:

the created ResourceMirror

Throws:

IOException - if failed to create the specified ResourceMirror

abort

public void abort(String sessionId)
           throws IOException

Aborts the specified session corresponding to this resouce. The default implementation does nothing.

Parameters:

sessionId - the target session ID

Throws:

IOException - if failed to abort the resource

abortAll

public void abortAll()
              throws IOException

Aborts all sessions corresponding to this resouce. The default implementation does nothing.

Throws:

IOException - if failed to abort the resource

createManipulator

public ResourceManipulator createManipulator(ParameterList arguments)
                                      throws IOException

Provides a new ResourceManipulator.

Parameters:

arguments - arguments (key and value pairs)

Returns:

the created ResourceManipulator

Throws:

IOException - if failed to create a ResourceManipulator, or this resource does not support manipulation