org.crsh.plugin
Class CRaSHPlugin<P>

java.lang.Object
  org.crsh.plugin.CRaSHPlugin<P>

Type Parameters:

P - the plugin type

Direct Known Subclasses:

CommandPlugin, JCRPlugin, ProcessorIOHandler, SSHPlugin, TelnetPlugin

public abstract class CRaSHPlugin<P>
extends Object

Base class for a plugin, that consist of a subclass of this class and the implementation of the business interface of the plugin. The business interface of the plugin is simply represented by the P generic parameter and its associated class Class<P>>.

Version:

$Revision$

Author:

Julien Viet

Field Summary

private List<PropertyDescriptor<?>>	configurationCapabilities .
(package private) static int	CONSTRUCTED .
(package private) PluginContext	context .
(package private) static int	FAILED .
(package private) static int	INITIALIZED .
(package private) static int	INITIALIZING .
protected org.slf4j.Logger	log .
(package private) int	status .
private Class<P>	type .

Constructor Summary

protected

CRaSHPlugin()

Method Summary

protected Iterable<PropertyDescriptor<?>>	createConfigurationCapabilities() Returns a list of PropertyDescriptor this plugin requires for its configuration.
void	destroy()
Iterable<PropertyDescriptor<?>>	getConfigurationCapabilities() Returns a list of PropertyDescriptor this plugin requires for its configuration.
protected PluginContext	getContext()
abstract P	getImplementation() Returns the implementation.
Class<P>	getType()
void	init()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

.

FAILED

static final int FAILED

.

See Also:

Constant Field Values

CONSTRUCTED

static final int CONSTRUCTED

.

See Also:

Constant Field Values

INITIALIZING

static final int INITIALIZING

.

See Also:

Constant Field Values

INITIALIZED

static final int INITIALIZED

.

See Also:

Constant Field Values

context

PluginContext context

.

status

int status

.

type

private final Class<P> type

.

configurationCapabilities

private List<PropertyDescriptor<?>> configurationCapabilities

.

Constructor Detail

CRaSHPlugin

protected CRaSHPlugin()

Method Detail

getContext

protected final PluginContext getContext()

getType

public final Class<P> getType()

createConfigurationCapabilities

protected Iterable<PropertyDescriptor<?>> createConfigurationCapabilities()

Returns a list of PropertyDescriptor this plugin requires for its configuration.

Returns:

the configuration capabilities

getConfigurationCapabilities

public final Iterable<PropertyDescriptor<?>> getConfigurationCapabilities()

Returns a list of PropertyDescriptor this plugin requires for its configuration.

Returns:

the configuration capabilities

getImplementation

public abstract P getImplementation()

Returns the implementation.

Returns:

the implementation

init

public void init()

destroy

public void destroy()

toString

public String toString()

Overrides:

toString in class Object