NodeSourceDescriptor (scheduling 14.1.0-SNAPSHOT API)

java.lang.Object
- org.ow2.proactive.resourcemanager.nodesource.NodeSourceDescriptor

All Implemented Interfaces:: Serializable

@PublicAPI
public class NodeSourceDescriptor
extends Object
implements Serializable

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NodeSourceDescriptor.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`NodeSourceDescriptor.Builder`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LinkedHashMap<String,String>`	`getAdditionalInformation()` Returns additional information attached to this Node Source.
`Map<String,String>`	`getInfrastructureNamedParameters()` The infrastructure parameters as a map
`String`	`getInfrastructureParameter(String name)` Returns the value of a single infrastructure parameter
`Object[]`	`getInfrastructureParameters()` The infrastructure parameters as an array
`PluginDescriptor`	`getInfrastructurePluginDescriptor()` Returns the infrastructure descriptor, which contains the definition of the infrastructure parameters (name, type, description, etc)
`String`	`getInfrastructureType()` The class implementation of this Node Source's infrastructure
`Map<String,Serializable>`	`getLastRecoveredInfrastructureVariables()` Only used internally
`String`	`getName()` The name of this Node Source
`Map<String,String>`	`getPolicyNamedParameters()` The policy parameters as a map
`String`	`getPolicyParameter(String name)` Returns the value of a single policy parameter
`Object[]`	`getPolicyParameters()` The policy parameters as an array
`PluginDescriptor`	`getPolicyPluginDescriptor()` Returns the policy descriptor, which contains the definition of the policy parameters (name, type, description, etc)
`String`	`getPolicyType()` The class implementation of this Node Source's policy
`Client`	`getProvider()` Returns the owner of this Node Source
`List<Serializable>`	`getSerializableInfrastructureParameters()` The infrastructure parameters as a list of serializable objects
`List<Serializable>`	`getSerializablePolicyParameters()` The policy parameters as a list of serializable objects
`NodeSourceStatus`	`getStatus()` Returns this node source current status (deployed or un-deployed)
`boolean`	`nodesRecoverable()` Are the nodes in this Node Source recoverable (e.g.
`void`	`setInfrastructureParameters(List<Serializable> infrastructureParameters)`
`void`	`setPolicyParameters(List<Serializable> policyParameters)`
`void`	`setStatus(NodeSourceStatus status)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getName
```
public String getName()
```
    The name of this Node Source
    
    Returns:
    
    node source name
  - getInfrastructureType
```
public String getInfrastructureType()
```
    The class implementation of this Node Source's infrastructure
    
    Returns:
    
    fully qualified class name of the infrastructure class
  - getSerializableInfrastructureParameters
```
public List<Serializable> getSerializableInfrastructureParameters()
```
    The infrastructure parameters as a list of serializable objects
    
    Returns:
    
    list of parameters
  - getInfrastructureParameters
```
public Object[] getInfrastructureParameters()
```
    The infrastructure parameters as an array
    
    Returns:
    
    array of parameters
  - getInfrastructureNamedParameters
```
public Map<String,String> getInfrastructureNamedParameters()
```
    The infrastructure parameters as a map
    
    Returns:
    
    a map where keys are parameter names, and values are parameter values
  - getInfrastructureParameter
```
public String getInfrastructureParameter(String name)
```
    Returns the value of a single infrastructure parameter
    
    Parameters:
    
    name - infrastructure parameter name
    
    Returns:
    
    infrastructure parameter value
  - getPolicyType
```
public String getPolicyType()
```
    The class implementation of this Node Source's policy
    
    Returns:
    
    fully qualified class name of the policy class
  - getSerializablePolicyParameters
```
public List<Serializable> getSerializablePolicyParameters()
```
    The policy parameters as a list of serializable objects
    
    Returns:
    
    list of parameters
  - getPolicyParameters
```
public Object[] getPolicyParameters()
```
    The policy parameters as an array
    
    Returns:
    
    array of parameters
  - getPolicyNamedParameters
```
public Map<String,String> getPolicyNamedParameters()
```
    The policy parameters as a map
    
    Returns:
    
    a map where keys are parameter names, and values are parameter values
  - getPolicyParameter
```
public String getPolicyParameter(String name)
```
    Returns the value of a single policy parameter
    
    Parameters:
    
    name - policy parameter name
    
    Returns:
    
    policy parameter value
  - getProvider
```
public Client getProvider()
```
    Returns the owner of this Node Source
    
    Returns:
    
    node source owner
  - nodesRecoverable
```
public boolean nodesRecoverable()
```
    Are the nodes in this Node Source recoverable (e.g. stored in the database, and may be recovered in case of a server crash)
    
    Returns:
    
    recoverable configuration
  - getStatus
```
public NodeSourceStatus getStatus()
```
    Returns this node source current status (deployed or un-deployed)
    
    Returns:
    
    a status
  - getAdditionalInformation
```
public LinkedHashMap<String,String> getAdditionalInformation()
```
    Returns additional information attached to this Node Source. This is used only by certain Node Source types (for example an Azure Node Source with billing monitoring enabled)
    
    Returns:
    
    map of additional information
  - getLastRecoveredInfrastructureVariables
```
public Map<String,Serializable> getLastRecoveredInfrastructureVariables()
```
    Only used internally
  - setStatus
```
public void setStatus(NodeSourceStatus status)
```
  - setInfrastructureParameters
```
public void setInfrastructureParameters(List<Serializable> infrastructureParameters)
```
  - setPolicyParameters
```
public void setPolicyParameters(List<Serializable> policyParameters)
```
  - getInfrastructurePluginDescriptor
```
public PluginDescriptor getInfrastructurePluginDescriptor()
```
    Returns the infrastructure descriptor, which contains the definition of the infrastructure parameters (name, type, description, etc)
    
    Returns:
    
    infrastructure descriptor
  - getPolicyPluginDescriptor
```
public PluginDescriptor getPolicyPluginDescriptor()
```
    Returns the policy descriptor, which contains the definition of the policy parameters (name, type, description, etc)
    
    Returns:
    
    policy descriptor

Class NodeSourceDescriptor

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getInfrastructureType

getSerializableInfrastructureParameters

getInfrastructureParameters

getInfrastructureNamedParameters

getInfrastructureParameter

getPolicyType

getSerializablePolicyParameters

getPolicyParameters

getPolicyNamedParameters

getPolicyParameter

getProvider

nodesRecoverable

getStatus

getAdditionalInformation

getLastRecoveredInfrastructureVariables

setStatus

setInfrastructureParameters

setPolicyParameters

getInfrastructurePluginDescriptor

getPolicyPluginDescriptor