org.crsh.plugin
Class PluginContext

java.lang.Object
  org.crsh.plugin.PluginContext

public class PluginContext
extends Object

The plugin context.

Version:

$Revision$

Author:

Julien Viet

Field Summary

private List<File>	dirs .
private ScheduledExecutorService	executor .
private ClassLoader	loader .
private static org.slf4j.Logger	log .
(package private) PluginManager	manager .
private static Pattern	p .
private Map<PropertyDescriptor<?>,Property<?>>	properties .
private boolean	started .
private String	version .
private FS	vfs .

Constructor Summary

PluginContext(PluginDiscovery discovery, FS fs, ClassLoader loader)
Create a new plugin context.

Method Summary

Collection<Property<?>>	getFoo() Returns the list of properties.
ClassLoader	getLoader()
Iterable<CRaSHPlugin<?>>	getPlugins()
<T> Iterable<T>	getPlugins(Class<T> pluginType)
<T> T	getProperty(PropertyDescriptor<T> desc) Returns a context property or null if it cannot be found.
<T> T	getProperty(String propertyName, Class<T> type) Returns a context property or null if it cannot be found.
String	getVersion()
List<String>	listResourceId(ResourceKind kind)
Resource	loadResource(String resourceId, ResourceKind resourceKind)
void	refresh() Refresh the fs system view.
<T> void	setProperty(PropertyDescriptor<T> desc, 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.
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

p

private static final Pattern p

.

log

private static final org.slf4j.Logger log

.

manager

final PluginManager manager

.

loader

private final ClassLoader loader

.

version

private final String version

.

executor

private ScheduledExecutorService executor

.

dirs

private volatile List<File> dirs

.

properties

private final Map<PropertyDescriptor<?>,Property<?>> properties

.

vfs

private final FS vfs

.

started

private boolean started

.

Constructor Detail

PluginContext

public PluginContext(PluginDiscovery discovery,
                     FS fs,
                     ClassLoader loader)
              throws NullPointerException

Create a new plugin context.

Parameters:

discovery - the plugin discovery

fs - the file system

loader - the loader

Throws:

NullPointerException - if any parameter argument is null

Method Detail

getPlugins

public Iterable<CRaSHPlugin<?>> getPlugins()

getVersion

public final String getVersion()

getFoo

public final Collection<Property<?>> getFoo()

Returns the list of properties.

Returns:

the properties

getProperty

public final <T> T getProperty(PropertyDescriptor<T> desc)
                    throws 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:

NullPointerException - if the descriptor argument is null

getProperty

public final <T> T getProperty(String propertyName,
                               Class<T> type)
                    throws 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:

NullPointerException - if the descriptor argument is null

setProperty

public final <T> void setProperty(PropertyDescriptor<T> desc,
                                  T value)
                       throws 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:

NullPointerException - if the descriptor argument is null

setProperty

public final <T> void setProperty(PropertyDescriptor<T> desc,
                                  String value)
                       throws NullPointerException,
                              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:

NullPointerException - if the descriptor argument is null

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

loadResource

public final Resource loadResource(String resourceId,
                                   ResourceKind resourceKind)

listResourceId

public final List<String> listResourceId(ResourceKind kind)

getLoader

public final ClassLoader getLoader()

refresh

public final 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.

start

public final void start()

stop

public final void stop()

getPlugins

public <T> Iterable<T> getPlugins(Class<T> pluginType)