CRaSHPlugin (CRaSH Doc API 1.3.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.crsh.plugin
Class CRaSHPlugin<P>

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

Direct Known Subclasses:: CommandPlugin, CRaSHShellFactory, JaasAuthenticationPlugin, JavaLanguage, KeyAuthenticationPlugin, LanguageProxy, ProcessorIOHandler, ScriptLanguage, SimpleAuthenticationPlugin, SSHPlugin, SubsystemFactoryPlugin, TelnetPlugin

public abstract class CRaSHPlugin<P>

extends Object

Field Summary
`private List<PropertyDescriptor<?>>`	`configurationCapabilities` .
`static int`	`CONSTRUCTED` .
`(package private) PluginContext`	`context` .
`static int`	`FAILED` .
`static int`	`INITIALIZED` .
`static int`	`INITIALIZING` .
`protected 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()` Implement this method to know about destroy life cycle callback.
`Iterable<PropertyDescriptor<?>>`	`getConfigurationCapabilities()` Returns a list of `PropertyDescriptor` this plugin requires for its configuration.
`protected PluginContext`	`getContext()`
`abstract P`	`getImplementation()` Returns the implementation.
`int`	`getStatus()` Returns the current plugin status.
`Class<P>`	`getType()` Returns the plugin type.
`void`	`init()` Implement this method to know about init life cycle callback.
`String`	`toString()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

log

protected final Logger log

FAILED

public static final int FAILED

See Also:: Constant Field Values

CONSTRUCTED

public static final int CONSTRUCTED

See Also:: Constant Field Values

INITIALIZING

public static final int INITIALIZING

See Also:: Constant Field Values

INITIALIZED

public 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()

getStatus

public int getStatus()

Returns the current plugin status.

Returns:: the plugin status

getType

public final Class<P> getType()

Returns the plugin type.

Returns:: the plugin type

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()