org.crsh.plugin

Class PluginContext

java.lang.Object

org.crsh.plugin.PluginContext

public final class PluginContext
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PluginContext(java.util.concurrent.ExecutorService executor, java.util.concurrent.ScheduledExecutorService scanner, PluginDiscovery discovery, java.util.Map<java.lang.String,java.lang.Object> attributes, FS cmdFS, FS confFS, java.lang.ClassLoader loader) Create a new plugin context.
PluginContext(PluginDiscovery discovery, java.util.Map<java.lang.String,java.lang.Object> attributes, FS cmdFS, FS confFS, java.lang.ClassLoader loader) Create a new plugin context with preconfigured executor and scanner, this is equivalent to invoking:

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getAttributes()
java.util.concurrent.ExecutorService	getExecutor()
java.lang.ClassLoader	getLoader() Returns the classloader associated with this context.
<T> T	getPlugin(java.lang.Class<T> pluginType) Returns the first plugin associated with this context implementing the specified type.
java.lang.Iterable<CRaSHPlugin<?>>	getPlugins()
<T> java.lang.Iterable<T>	getPlugins(java.lang.Class<T> pluginType) Returns the plugins associated with this context.
<T> T	getProperty(PropertyDescriptor<T> desc) Returns a context property or null if it cannot be found.
<T> T	getProperty(java.lang.String propertyName, java.lang.Class<T> type) Returns a context property or null if it cannot be found.
org.crsh.plugin.PropertyManager	getPropertyManager()
java.lang.String	getVersion()
java.lang.Iterable<java.lang.String>	listResources(ResourceKind kind) List the resources id for a specific resource kind.
Resource	loadResource(java.lang.String resourceId, ResourceKind resourceKind) Load a resource from the context.
java.lang.Iterable<Resource>	loadResources(java.lang.String resourceId, ResourceKind resourceKind) Load a resource from the context.
void	refresh() Refresh the fs system view.
<T> void	setProperty(PropertyDescriptor<T> desc, java.lang.String value) Set a context property to a new value.
<T> void	setProperty(PropertyDescriptor<T> desc, T value) Set a context property to a new value.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginContext

public PluginContext(PluginDiscovery discovery,
             java.util.Map<java.lang.String,java.lang.Object> attributes,
             FS cmdFS,
             FS confFS,
             java.lang.ClassLoader loader)
              throws java.lang.NullPointerException

Create a new plugin context with preconfigured executor and scanner, this is equivalent to invoking:

new PluginContext(
    Executors.newFixedThreadPool(20),
    new ScheduledThreadPoolExecutor(1),
    discovery,
    attributes,
    cmdFS,
    confFS,
    loader);

Parameters:

discovery - the plugin discovery

cmdFS - the command file system

attributes - the attributes

confFS - the conf file system

loader - the loader

Throws:

java.lang.NullPointerException - if any parameter argument is null

PluginContext

public PluginContext(java.util.concurrent.ExecutorService executor,
             java.util.concurrent.ScheduledExecutorService scanner,
             PluginDiscovery discovery,
             java.util.Map<java.lang.String,java.lang.Object> attributes,
             FS cmdFS,
             FS confFS,
             java.lang.ClassLoader loader)
              throws java.lang.NullPointerException

Create a new plugin context.

Parameters:

executor - the executor for executing asynchronous jobs

scanner - the background scanner for scanning commands

discovery - the plugin discovery

cmdFS - the command file system

attributes - the attributes

confFS - the conf file system

loader - the loader

Throws:

java.lang.NullPointerException - if any parameter argument is null

Method Detail

getVersion

public java.lang.String getVersion()

getAttributes

public java.util.Map<java.lang.String,java.lang.Object> getAttributes()

getExecutor

public java.util.concurrent.ExecutorService getExecutor()

getPropertyManager

public org.crsh.plugin.PropertyManager getPropertyManager()

Returns:

the property manager

getProperty

public <T> T getProperty(PropertyDescriptor<T> desc)
              throws java.lang.NullPointerException

Returns a context property or null if it cannot be found.

Type Parameters:

T - the property parameter type

Parameters:

desc - the property descriptor

Returns:

the property value

Throws:

java.lang.NullPointerException - if the descriptor argument is null

getProperty

public <T> T getProperty(java.lang.String propertyName,
                java.lang.Class<T> type)
              throws java.lang.NullPointerException

Returns a context property or null if it cannot be found.

Type Parameters:

T - the property parameter type

Parameters:

propertyName - the name of the property

type - the property type

Returns:

the property value

Throws:

java.lang.NullPointerException - if the descriptor argument is null

setProperty

public <T> void setProperty(PropertyDescriptor<T> desc,
                   T value)
                 throws java.lang.NullPointerException

Set a context property to a new value. If the provided value is null, then the property is removed.

Type Parameters:

T - the property parameter type

Parameters:

desc - the property descriptor

value - the property value

Throws:

java.lang.NullPointerException - if the descriptor argument is null

setProperty

public <T> void setProperty(PropertyDescriptor<T> desc,
                   java.lang.String value)
                 throws java.lang.NullPointerException,
                        java.lang.IllegalArgumentException

Set a context property to a new value. If the provided value is null, then the property is removed.

Type Parameters:

T - the property parameter type

Parameters:

desc - the property descriptor

value - the property value

Throws:

java.lang.NullPointerException - if the descriptor argument is null

java.lang.IllegalArgumentException - if the string value cannot be converted to the property type

loadResource

public Resource loadResource(java.lang.String resourceId,
                    ResourceKind resourceKind)

Load a resource from the context.

Parameters:

resourceId - the resource id

resourceKind - the resource kind

Returns:

the resource or null if it cannot be found

loadResources

public java.lang.Iterable<Resource> loadResources(java.lang.String resourceId,
                                         ResourceKind resourceKind)

Load a resource from the context.

Parameters:

resourceId - the resource id

resourceKind - the resource kind

Returns:

the resource or null if it cannot be found

listResources

public java.lang.Iterable<java.lang.String> listResources(ResourceKind kind)

List the resources id for a specific resource kind.

Parameters:

kind - the resource kind

Returns:

the resource ids

getLoader

public java.lang.ClassLoader getLoader()

Returns the classloader associated with this context.

Returns:

the class loader

getPlugins

public java.lang.Iterable<CRaSHPlugin<?>> getPlugins()

getPlugins

public <T> java.lang.Iterable<T> getPlugins(java.lang.Class<T> pluginType)

Returns the plugins associated with this context.

Type Parameters:

T - the plugin generic type

Parameters:

pluginType - the plugin type

Returns:

the plugins

getPlugin

public <T> T getPlugin(java.lang.Class<T> pluginType)

Returns the first plugin associated with this context implementing the specified type.

Type Parameters:

T - the plugin generic type

Parameters:

pluginType - the plugin type

Returns:

the plugins

refresh

public void refresh()

Refresh the fs system view. This is normally triggered by the periodic job but it can be manually invoked to trigger explicit refreshes.