org.ow2.proactive.utils

Class Criteria

java.lang.Object

org.ow2.proactive.utils.Criteria

All Implemented Interfaces:

Serializable

@PublicAPI
public class Criteria
extends Object
implements Serializable

When user searches for nodes in the resource manager he can specify various criteria. This class encapsulates requirements and limitations for resulting node set.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Criteria(int size) Creates criteria instance

Method Summary

Modifier and Type	Method and Description
Set<String>	getAcceptableNodesUrls()
Map<String,Serializable>	getBindings() returns the bindings map used by selection scripts
NodeSet	getBlackList()
Collection<String>	getComputationDescriptors()
List<Map<String,String>>	getListUsageInfo()
String	getNodeAccessToken() If a token is specified the resource manager only looks for nodes having this token.
String	getNodeSourceRestriction() If a node source is specified, the resource manager only looks for nodes which belong to the specified node source
List<SelectionScript>	getScripts()
int	getSize()
TopologyDescriptor	getTopology()
boolean	isBestEffort()
void	setAcceptableNodesUrls(Set<String> acceptableNodesUrls) Sets acceptables nodes that can resulting nodes list.
void	setBestEffort(boolean bestEffort) Sets the mode of selection: if best effort is true RM returns up to required number of nodes that satisfy to selection scripts and topology if false it either exact number of empty node set.
void	setBindings(Map<String,Serializable> bindings) Sets variable bindings map used by selection scripts
void	setBlackList(NodeSet blackList) Sets nodes that have not be in resulting nodes list.
void	setComputationDescriptors(Collection<String> computationDescriptors) Sets descriptors of computations for which nodes will be reserved (for information purposes).
void	setListUsageInfo(List<Map<String,String>> listUsageInfo)
void	setNodeAccessToken(String nodeAccessToken) If key is specified the resource manager only looks for nodes having this token.
void	setNodeSourceRestriction(String nodeSourceRestriction) If a node source is specified, the resource manager only looks for nodes which belong to the specified node source
void	setScripts(List<SelectionScript> scripts) Sets a selection scripts list.
void	setTopology(TopologyDescriptor topology) Sets topology criteria for nodes TopologyDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

Criteria

public Criteria(int size)

Creates criteria instance

Parameters:

size - - required number of nodes

Method Detail

getSize

public int getSize()

Returns:

required number of nodes

getTopology

public TopologyDescriptor getTopology()

Returns:

a topology descriptor TopologyDescriptor

setTopology

public void setTopology(TopologyDescriptor topology)

Sets topology criteria for nodes TopologyDescriptor

getScripts

public List<SelectionScript> getScripts()

Returns:

a selection scripts list. All have to pass on every single node.

setScripts

public void setScripts(List<SelectionScript> scripts)

Sets a selection scripts list. All have to pass on every single node.

setBindings

public void setBindings(Map<String,Serializable> bindings)

Sets variable bindings map used by selection scripts

Parameters:

bindings -

getBindings

public Map<String,Serializable> getBindings()

returns the bindings map used by selection scripts

Returns:

getBlackList

public NodeSet getBlackList()

Returns:

nodes that have not be in resulting nodes list.

setBlackList

public void setBlackList(NodeSet blackList)

Sets nodes that have not be in resulting nodes list.

setAcceptableNodesUrls

public void setAcceptableNodesUrls(Set<String> acceptableNodesUrls)

Sets acceptables nodes that can resulting nodes list.

getAcceptableNodesUrls

public Set<String> getAcceptableNodesUrls()

Returns:

urls of nodes that can be in resulting nodes list.

isBestEffort

public boolean isBestEffort()

Returns:

the mode of selection

setBestEffort

public void setBestEffort(boolean bestEffort)

Sets the mode of selection: if best effort is true RM returns up to required number of nodes that satisfy to selection scripts and topology if false it either exact number of empty node set.

getComputationDescriptors

public Collection<String> getComputationDescriptors()

Returns:

a set of descriptors of computations for which nodes will be reserved (for information purposes).

setComputationDescriptors

public void setComputationDescriptors(Collection<String> computationDescriptors)

Sets descriptors of computations for which nodes will be reserved (for information purposes).

getNodeAccessToken

public String getNodeAccessToken()

If a token is specified the resource manager only looks for nodes having this token. If no token is specified in the criteria, nodes protected by token will not be selected.

Returns:

a key for accessing nodes

setNodeAccessToken

public void setNodeAccessToken(String nodeAccessToken)

If key is specified the resource manager only looks for nodes having this token. If no token is specified in the criteria, nodes protected by token will not be selected.

Parameters:

nodeAccessToken -

getNodeSourceRestriction

public String getNodeSourceRestriction()

If a node source is specified, the resource manager only looks for nodes which belong to the specified node source

Returns:

nodeSourceRestriction

setNodeSourceRestriction

public void setNodeSourceRestriction(String nodeSourceRestriction)

If a node source is specified, the resource manager only looks for nodes which belong to the specified node source

Parameters:

nodeSourceRestriction -

getListUsageInfo

public List<Map<String,String>> getListUsageInfo()

setListUsageInfo

public void setListUsageInfo(List<Map<String,String>> listUsageInfo)