org.ogf.saga.resource.manager

Interface ResourceManager

All Superinterfaces:

Async, Cloneable, SagaObject

public interface ResourceManager
extends SagaObject, Async

The resource manager can translate resource requests into stateful resource handles. It also manages the persistence of those resource handles, and of resource pools.

Field Summary

Fields inherited from interface org.ogf.saga.SagaObject

NO_WAIT, WAIT_FOREVER

Method Summary

Methods

Modifier and Type	Method and Description
Compute	acquireCompute(ComputeDescription description) Acquire compute resource matching from requirements
Compute	acquireCompute(String id) Return resource handle for some known compute resource.
Task<ResourceManager,Compute>	acquireCompute(TaskMode mode, ComputeDescription description) Creates a task that acquires compute resource matching from requirements.
Task<ResourceManager,Compute>	acquireCompute(TaskMode mode, String id) Creates a task that returns resource handle for some known compute resource.
Network	acquireNetwork(NetworkDescription description) Acquire network resource matching from requirements
Network	acquireNetwork(String id) Return resource handle for some known network resource.
Task<ResourceManager,Network>	acquireNetwork(TaskMode mode, NetworkDescription description) Creates a task that acquires network resource matching from requirements.
Task<ResourceManager,Network>	acquireNetwork(TaskMode mode, String id) Creates a task that returns resource handle for some known network resource.
Storage	acquireStorage(StorageDescription description) Acquire storage resource matching from requirements
Storage	acquireStorage(String id) Return resource handle for some known storage resource.
Task<ResourceManager,Storage>	acquireStorage(TaskMode mode, StorageDescription description) Creates a task that acquires storage resource matching from requirements.
Task<ResourceManager,Storage>	acquireStorage(TaskMode mode, String id) Creates a task that returns resource handle for some known storage resource.
ResourceDescription	getTemplate(String id) Human readable description of template
Task<ResourceManager,ResourceDescription>	getTemplate(TaskMode mode, String id) Creates a task that returns human readable description of template.
Task<ResourceManager,List<String>>	listResources(TaskMode mode, Type type) Creates a task that obtains the list of pilot/vm/ar (etc.) instances that are currently known to the resource manager.
List<String>	listResources(Type type) Obtains the list of pilot/vm/ar (etc.) instances that are currently known to the resource manager.
Task<ResourceManager,List<String>>	listTemplates(TaskMode mode, Type type) Creates a task that obtains the list of available templates.
List<String>	listTemplates(Type type) List available templates.
void	releaseCompute(String id) Close compute resource, even if it is not drained.
void	releaseCompute(String id, boolean drain) Close compute resource
Task<ResourceManager,Void>	releaseCompute(TaskMode mode, String id) Creates a task that closes compute resource, even if it is not drained.
Task<ResourceManager,Void>	releaseCompute(TaskMode mode, String id, boolean drain) Creates a task that closes compute resource.
void	releaseNetwork(String id) Close network resource
Task<ResourceManager,Void>	releaseNetwork(TaskMode mode, String id) Creates a task that closes network resource.
void	releaseStorage(String id) Close storage resource
Task<ResourceManager,Void>	releaseStorage(TaskMode mode, String id) Creates a task that closes storage resource.

Methods inherited from interface org.ogf.saga.SagaObject

clone, getId, getSession

Method Detail

listResources

List<String> listResources(Type type)
                           throws NotImplementedException,
                                  AuthenticationFailedException,
                                  AuthorizationFailedException,
                                  TimeoutException,
                                  NoSuccessException

Obtains the list of pilot/vm/ar (etc.) instances that are currently known to the resource manager.

Parameters:

type - the resource type (default = any)

Returns:

a list of resource identifications.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

listTemplates

List<String> listTemplates(Type type)
                           throws NotImplementedException,
                                  TimeoutException,
                                  NoSuccessException

List available templates.

Parameters:

type - the resource type (default = any)

Returns:

the list of templates

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

getTemplate

ResourceDescription getTemplate(String id)
                                throws NotImplementedException,
                                       BadParameterException,
                                       DoesNotExistException,
                                       TimeoutException,
                                       NoSuccessException

Human readable description of template

Parameters:

id - the template identifier

Returns:

the template description

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

BadParameterException - is thrown when the resource manager cannot parse the template id.

DoesNotExistException - is thrown when the resource manager can handle the template id, but the referenced template is not found.

acquireCompute

Compute acquireCompute(ComputeDescription description)
                       throws NotImplementedException,
                              AuthenticationFailedException,
                              AuthorizationFailedException,
                              BadParameterException,
                              TimeoutException,
                              NoSuccessException

Acquire compute resource matching from requirements

Parameters:

description - the resource description

Returns:

the resource handle

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

BadParameterException - is thrown when the resource description contains invalid values.

acquireCompute

Compute acquireCompute(String id)
                       throws NotImplementedException,
                              AuthenticationFailedException,
                              AuthorizationFailedException,
                              BadParameterException,
                              DoesNotExistException,
                              TimeoutException,
                              NoSuccessException

Return resource handle for some known compute resource.

Parameters:

id - the resource identifier (can also be an old fashioned JobService URL)

Returns:

the resource handle

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

BadParameterException - is thrown when the resource manager cannot parse the resource id.

DoesNotExistException - is thrown when the resource manager can handle the resource id, but the referenced resource is not alive.

releaseCompute

void releaseCompute(String id)
                    throws NotImplementedException,
                           AuthenticationFailedException,
                           AuthorizationFailedException,
                           BadParameterException,
                           DoesNotExistException,
                           TimeoutException,
                           NoSuccessException,
                           IncorrectStateException

Close compute resource, even if it is not drained.

Parameters:

id - the resource identifier

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

BadParameterException - is thrown when the resource manager cannot parse the resource id.

DoesNotExistException - is thrown when the resource manager can handle the resource id, but the referenced resource is not alive.

IncorrectStateException

releaseCompute

void releaseCompute(String id,
                  boolean drain)
                    throws NotImplementedException,
                           AuthenticationFailedException,
                           AuthorizationFailedException,
                           BadParameterException,
                           DoesNotExistException,
                           TimeoutException,
                           NoSuccessException,
                           IncorrectStateException

Close compute resource

Parameters:

id - the resource identifier

drain - true if the resource must be drained, else false

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

BadParameterException - is thrown when the resource manager cannot parse the resource id.

DoesNotExistException - is thrown when the resource manager can handle the resource id, but the referenced resource is not alive.

IncorrectStateException

acquireNetwork

Network acquireNetwork(NetworkDescription description)
                       throws NotImplementedException,
                              AuthenticationFailedException,
                              AuthorizationFailedException,
                              BadParameterException,
                              TimeoutException,
                              NoSuccessException

Acquire network resource matching from requirements

Parameters:

description - the resource description

Returns:

the resource handle

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

BadParameterException - is thrown when the resource description contains invalid values.

acquireNetwork

Network acquireNetwork(String id)
                       throws NotImplementedException,
                              AuthenticationFailedException,
                              AuthorizationFailedException,
                              BadParameterException,
                              DoesNotExistException,
                              TimeoutException,
                              NoSuccessException

Return resource handle for some known network resource.

Parameters:

id - the resource identifier

Returns:

the resource handle

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

BadParameterException - is thrown when the resource manager cannot parse the resource id.

DoesNotExistException - is thrown when the resource manager can handle the resource id, but the referenced resource is not alive.

releaseNetwork

void releaseNetwork(String id)
                    throws NotImplementedException,
                           AuthenticationFailedException,
                           AuthorizationFailedException,
                           BadParameterException,
                           DoesNotExistException,
                           TimeoutException,
                           NoSuccessException,
                           IncorrectStateException

Close network resource

Parameters:

id - the resource identifier

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

BadParameterException - is thrown when the resource manager cannot parse the resource id.

DoesNotExistException - is thrown when the resource manager can handle the resource id, but the referenced resource is not alive.

IncorrectStateException

acquireStorage

Storage acquireStorage(StorageDescription description)
                       throws NotImplementedException,
                              AuthenticationFailedException,
                              AuthorizationFailedException,
                              BadParameterException,
                              TimeoutException,
                              NoSuccessException

Acquire storage resource matching from requirements

Parameters:

description - the resource description

Returns:

the resource handle

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

BadParameterException - is thrown when the resource description contains invalid values.

acquireStorage

Storage acquireStorage(String id)
                       throws NotImplementedException,
                              AuthenticationFailedException,
                              AuthorizationFailedException,
                              BadParameterException,
                              DoesNotExistException,
                              TimeoutException,
                              NoSuccessException

Return resource handle for some known storage resource.

Parameters:

id - the resource identifier

Returns:

the resource handle

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

BadParameterException - is thrown when the resource manager cannot parse the resource id.

DoesNotExistException - is thrown when the resource manager can handle the resource id, but the referenced resource is not alive.

releaseStorage

void releaseStorage(String id)
                    throws NotImplementedException,
                           AuthenticationFailedException,
                           AuthorizationFailedException,
                           BadParameterException,
                           DoesNotExistException,
                           TimeoutException,
                           NoSuccessException,
                           IncorrectStateException

Close storage resource

Parameters:

id - the resource identifier

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

BadParameterException - is thrown when the resource manager cannot parse the resource id.

DoesNotExistException - is thrown when the resource manager can handle the resource id, but the referenced resource is not alive.

IncorrectStateException

listResources

Task<ResourceManager,List<String>> listResources(TaskMode mode,
                                               Type type)
                                                 throws NotImplementedException

Creates a task that obtains the list of pilot/vm/ar (etc.) instances that are currently known to the resource manager.

Parameters:

mode - the task mode.

type - the resource type (default = any)

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

listTemplates

Task<ResourceManager,List<String>> listTemplates(TaskMode mode,
                                               Type type)
                                                 throws NotImplementedException

Creates a task that obtains the list of available templates.

Parameters:

mode - the task mode.

type - the resource type (default = any)

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

getTemplate

Task<ResourceManager,ResourceDescription> getTemplate(TaskMode mode,
                                                    String id)
                                                      throws NotImplementedException

Creates a task that returns human readable description of template.

Parameters:

mode - the task mode.

id - the template identifier

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

acquireCompute

Task<ResourceManager,Compute> acquireCompute(TaskMode mode,
                                           ComputeDescription description)
                                             throws NotImplementedException

Creates a task that acquires compute resource matching from requirements.

Parameters:

mode - the task mode.

description - the resource description.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

acquireCompute

Task<ResourceManager,Compute> acquireCompute(TaskMode mode,
                                           String id)
                                             throws NotImplementedException

Creates a task that returns resource handle for some known compute resource.

Parameters:

mode - the task mode.

id - the resource identifier (can also be an old fashioned JobService URL).

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

releaseCompute

Task<ResourceManager,Void> releaseCompute(TaskMode mode,
                                        String id)
                                          throws NotImplementedException

Creates a task that closes compute resource, even if it is not drained.

Parameters:

mode - the task mode.

id - the resource identifier.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

releaseCompute

Task<ResourceManager,Void> releaseCompute(TaskMode mode,
                                        String id,
                                        boolean drain)
                                          throws NotImplementedException

Creates a task that closes compute resource.

Parameters:

mode - the task mode.

id - the resource identifier.

drain - true if the resource must be drained, else false

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

acquireNetwork

Task<ResourceManager,Network> acquireNetwork(TaskMode mode,
                                           NetworkDescription description)
                                             throws NotImplementedException

Creates a task that acquires network resource matching from requirements.

Parameters:

mode - the task mode.

description - the resource description

Returns:

the task.

Throws:

NotImplementedException

acquireNetwork

Task<ResourceManager,Network> acquireNetwork(TaskMode mode,
                                           String id)
                                             throws NotImplementedException

Creates a task that returns resource handle for some known network resource.

Parameters:

mode - the task mode.

id - the resource identifier

Returns:

the task.

Throws:

NotImplementedException

releaseNetwork

Task<ResourceManager,Void> releaseNetwork(TaskMode mode,
                                        String id)
                                          throws NotImplementedException

Creates a task that closes network resource.

Parameters:

mode - the task mode.

id - the resource identifier

Returns:

the task.

Throws:

NotImplementedException

acquireStorage

Task<ResourceManager,Storage> acquireStorage(TaskMode mode,
                                           StorageDescription description)
                                             throws NotImplementedException

Creates a task that acquires storage resource matching from requirements.

Parameters:

mode - the task mode.

description - the resource description

Returns:

the task.

Throws:

NotImplementedException

acquireStorage

Task<ResourceManager,Storage> acquireStorage(TaskMode mode,
                                           String id)
                                             throws NotImplementedException

Creates a task that returns resource handle for some known storage resource.

Parameters:

mode - the task mode.

id - the resource identifier

Returns:

the task.

Throws:

NotImplementedException

releaseStorage

Task<ResourceManager,Void> releaseStorage(TaskMode mode,
                                        String id)
                                          throws NotImplementedException

Creates a task that closes storage resource.

Parameters:

mode - the task mode.

id - the resource identifier

Returns:

the task.

Throws:

NotImplementedException