org.ow2.proactive.resourcemanager.nodesource.common

Class PluginDescriptor

java.lang.Object

org.ow2.proactive.resourcemanager.nodesource.common.PluginDescriptor

All Implemented Interfaces:

Serializable

@PublicAPI
public class PluginDescriptor
extends Object
implements Serializable

A descriptor of pluggable policies and infrastructure manages. Used to dynamically obtain a meta information about the service without having a direct link to the service.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PluginDescriptor()
PluginDescriptor(Class<?> cls, Object instance, Map<String,String> defaultValues)
PluginDescriptor(Class<?> cls, Object instance, Object[] parameters) Create a plugin descriptor populated with the given parameters

Method Summary

Modifier and Type	Method and Description
static String	beautifyName(String name)
Collection<ConfigurableField>	getConfigurableFields()
Map<String,String>	getDefaultValues()
Map<String,String>	getMeta()
String	getPluginDescription()
String	getPluginName()
Map<Integer,String>	getSectionDescriptions()
Object[]	packParameters(Object[] parameters) Packs parameters inputed by user into appropriate parameters set required for this plugin.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginDescriptor

public PluginDescriptor()

PluginDescriptor

public PluginDescriptor(Class<?> cls,
                        Object instance,
                        Map<String,String> defaultValues)

PluginDescriptor

public PluginDescriptor(Class<?> cls,
                        Object instance,
                        Object[] parameters)

Create a plugin descriptor populated with the given parameters

Method Detail

getPluginName

public String getPluginName()

getPluginDescription

public String getPluginDescription()

getConfigurableFields

public Collection<ConfigurableField> getConfigurableFields()

getDefaultValues

public Map<String,String> getDefaultValues()

Returns:

the default values set by the rm core for this plugin

getSectionDescriptions

public Map<Integer,String> getSectionDescriptions()

packParameters

public Object[] packParameters(Object[] parameters)
                        throws RMException

Packs parameters inputed by user into appropriate parameters set required for this plugin. Performs some operations such as file loading on user side.

Parameters:

parameters - input parameters

Returns:

output parameters

Throws:

RMException - when error occurs

beautifyName

public static String beautifyName(String name)

toString

public String toString()

Overrides:

toString in class Object

getMeta

public Map<String,String> getMeta()