org.ow2.proactive.resourcemanager.nodesource.policy

Class NodeSourcePolicy

java.lang.Object

org.ow2.proactive.resourcemanager.nodesource.policy.NodeSourcePolicy

All Implemented Interfaces:

Serializable, NodeSourcePlugin

Direct Known Subclasses:

CronPolicy, EmptyPolicy, InfrastructureAwarePolicy, RestartDownNodesPolicy, RMAwareNodeSourcePolicy, StaticPolicy, TimeSlotPolicy

public abstract class NodeSourcePolicy
extends Object
implements NodeSourcePlugin

A node source policy is a set of rules of acquiring/releasing nodes. It describes a time and conditions when and how many nodes have to be acquired from the infrastructure.

NOTE: NodeSourcePolicy will be an active object.

To define a new node source policy:

• implement configure(Object...) and setup there all policy parameters which are available through UI
• define activation and disactivation policy behavior by implementing corresponding methods
• define how policy should react on nodes adding request initiated by user
• add the name of new policy class to the resource manager configuration file (config/rm/nodesource/policies).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected NodeSource	nodeSource Node source of the policy

Constructor Summary

Constructors

Constructor and Description
NodeSourcePolicy()

Method Summary

Modifier and Type	Method and Description
protected void	acquireAllNodes() Asynchronous request to acquires all possible nodes from infrastructure
void	acquireNodes(int n) Asynchronous request to acquires n nodes from infrastructure
void	acquireNodes(int n, long timeout, Map<String,?> nodeConfiguration)
void	acquireNodes(int n, Map<String,?> nodeConfiguration)
abstract org.objectweb.proactive.core.util.wrapper.BooleanWrapper	activate() Activates the policy.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	configure(Object... policyParameters) Configure a policy with given parameters.
protected void	debug(String message) Prints a formatted debug message to the logging system
abstract String	getDescription() Policy description for UI
Map<String,String>	getMeta()
AccessType	getProviderAccessType() Returns a node source administration type.
Map<Integer,String>	getSectionDescriptions()
AccessType	getUserAccessType() Returns a nodes access type.
protected void	info(String message) Prints a formatted info message to the logging system
void	reconfigure(Object... updatedPolicyParameters) Reconfigure a policy (potentially running) with the given parameters.
protected void	removeAllNodes(boolean preemptive) Removed all nodes from the node source
protected void	removeNode(String url, boolean preemptive) Removes a node from the node source
protected void	removeNodes(int n, boolean preemptive) Removes n nodes from the node source
void	setNodeSource(NodeSource nodeSource) Sets a policy node source
void	shutdown(Client initiator) Shutdown the policy
String	toString() Policy string representation.

Methods inherited from class java.lang.Object

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

Field Detail

nodeSource

protected NodeSource nodeSource

Node source of the policy

Constructor Detail

NodeSourcePolicy

public NodeSourcePolicy()

Method Detail

configure

public org.objectweb.proactive.core.util.wrapper.BooleanWrapper configure(Object... policyParameters)

Configure a policy with given parameters.

Parameters:

policyParameters - parameters defined by user

Throws:

IllegalArgumentException - if parameters are incorrect

reconfigure

public void reconfigure(Object... updatedPolicyParameters)
                 throws Exception

Reconfigure a policy (potentially running) with the given parameters. Implementations are free to handle override of parameters as they wish.

Parameters:

updatedPolicyParameters - parameters potentially containing updated dynamic parameters

Throws:

IllegalArgumentException - if parameters are incorrect

Exception

See Also:

Configurable.dynamic()

activate

public abstract org.objectweb.proactive.core.util.wrapper.BooleanWrapper activate()

Activates the policy.

Returns:

true if the policy has been activated successfully, false otherwise.

shutdown

public void shutdown(Client initiator)

Shutdown the policy

getDescription

public abstract String getDescription()

Policy description for UI

Returns:

policy description

setNodeSource

public void setNodeSource(NodeSource nodeSource)

Sets a policy node source

Parameters:

nodeSource - policy node source

acquireNodes

public void acquireNodes(int n)

Asynchronous request to acquires n nodes from infrastructure

Parameters:

n - number of nodes

acquireNodes

public void acquireNodes(int n,
                         Map<String,?> nodeConfiguration)

acquireNodes

public void acquireNodes(int n,
                         long timeout,
                         Map<String,?> nodeConfiguration)

acquireAllNodes

protected void acquireAllNodes()

Asynchronous request to acquires all possible nodes from infrastructure

removeNodes

protected void removeNodes(int n,
                           boolean preemptive)

Removes n nodes from the node source

Parameters:

n - number of nodes

preemptive - if true remove nodes immediately without waiting while they will be freed

removeNode

protected void removeNode(String url,
                          boolean preemptive)

Removes a node from the node source

Parameters:

url - the URL of the node

preemptive - if true remove nodes immediately without waiting while they will be freed

removeAllNodes

protected void removeAllNodes(boolean preemptive)

Removed all nodes from the node source

Parameters:

preemptive - if true remove nodes immediately without waiting while they will be freed

info

protected void info(String message)

Prints a formatted info message to the logging system

Parameters:

message - to print

debug

protected void debug(String message)

Prints a formatted debug message to the logging system

Parameters:

message - to print

getProviderAccessType

public AccessType getProviderAccessType()

Returns a node source administration type. Could be ME, MY_GROUPS, ALL

Returns:

a node source administration type

getUserAccessType

public AccessType getUserAccessType()

Returns a nodes access type. Could be ME, MY_GROUPS, PROVIDER, PROVIDER_GROUPS, ALL

Returns:

a nodes access type

toString

public String toString()

Policy string representation.

Overrides:

toString in class Object

getSectionDescriptions

public Map<Integer,String> getSectionDescriptions()

Specified by:

getSectionDescriptions in interface NodeSourcePlugin

getMeta

public Map<String,String> getMeta()

Specified by:

getMeta in interface NodeSourcePlugin