org.ogf.saga.resource.instance

Interface Resource<R,RD>

All Superinterfaces:

Async, AsyncAttributes<R>, Attributes, Cloneable, Monitorable, ResourceTask, SagaObject

All Known Subinterfaces:

Compute, Network, Storage

public interface Resource<R,RD>
extends ResourceTask, Async, AsyncAttributes<R>

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCESS Attribute name: list of access URLs
static String	MANAGER_ID Attribute name: URL representation of the resource manager
static String	RESOURCE_DESCRIPTION Attribute name: human readable description of the resource
static String	RESOURCE_ID Attribute name: SAGA representation of the resource identifier
static String	RESOURCE_TYPE Attribute name: the resource type

Fields inherited from interface org.ogf.saga.resource.task.ResourceTask

RESOURCE_STATE, RESOURCE_STATEDETAIL

Fields inherited from interface org.ogf.saga.SagaObject

NO_WAIT, WAIT_FOREVER

Fields inherited from interface org.ogf.saga.attributes.Attributes

BOOL, ENUM, FALSE, FLOAT, INT, STRING, TIME, TRIGGER, TRUE

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getAccess()
RD	getDescription() Retrieves the resource description that was used to create this resource instance.
ResourceManager	getManager()
Type	getType()
void	reconfigure(RD description) Reconfigure
void	release() Release resource

Methods inherited from interface org.ogf.saga.resource.task.ResourceTask

getState, waitFor, waitFor, waitFor, waitFor

Methods inherited from interface org.ogf.saga.SagaObject

clone, getId, getSession

Methods inherited from interface org.ogf.saga.monitoring.Monitorable

addCallback, getMetric, listMetrics, removeCallback

Methods inherited from interface org.ogf.saga.attributes.AsyncAttributes

existsAttribute, findAttributes, getAttribute, getVectorAttribute, isReadOnlyAttribute, isRemovableAttribute, isVectorAttribute, isWritableAttribute, listAttributes, removeAttribute, setAttribute, setVectorAttribute

Methods inherited from interface org.ogf.saga.attributes.Attributes

existsAttribute, findAttributes, getAttribute, getVectorAttribute, isReadOnlyAttribute, isRemovableAttribute, isVectorAttribute, isWritableAttribute, listAttributes, removeAttribute, setAttribute, setVectorAttribute

Field Detail

RESOURCE_TYPE

static final String RESOURCE_TYPE

Attribute name: the resource type

See Also:

Constant Field Values

RESOURCE_ID

static final String RESOURCE_ID

Attribute name: SAGA representation of the resource identifier

See Also:

Constant Field Values

MANAGER_ID

static final String MANAGER_ID

Attribute name: URL representation of the resource manager

See Also:

Constant Field Values

ACCESS

static final String ACCESS

Attribute name: list of access URLs

See Also:

Constant Field Values

RESOURCE_DESCRIPTION

static final String RESOURCE_DESCRIPTION

Attribute name: human readable description of the resource

See Also:

Constant Field Values

Method Detail

getType

Type getType()
             throws NotImplementedException,
                    NoSuccessException

Returns:

the resource type

Throws:

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

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

getManager

ResourceManager getManager()
                           throws NotImplementedException,
                                  NoSuccessException

Returns:

the resource manager

Throws:

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

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

getAccess

String[] getAccess()
                   throws NotImplementedException,
                          AuthenticationFailedException,
                          AuthorizationFailedException,
                          TimeoutException,
                          NoSuccessException

Returns:

the list of access URLs

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.

getDescription

RD getDescription()
                  throws NotImplementedException,
                         AuthenticationFailedException,
                         AuthorizationFailedException,
                         DoesNotExistException,
                         TimeoutException,
                         NoSuccessException

Retrieves the resource description that was used to create this resource instance.

Returns:

the resource description

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.

DoesNotExistException - is thrown in cases where the resource description is not available, for instance when the resource was not created through SAGA and the resource was obtained using the ResourceManager.acquire() call.

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

reconfigure

void reconfigure(RD description)
                 throws NotImplementedException,
                        AuthenticationFailedException,
                        AuthorizationFailedException,
                        BadParameterException,
                        TimeoutException,
                        NoSuccessException

Reconfigure

Parameters:

description - the new resource description

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.

release

void release()
             throws NotImplementedException,
                    AuthenticationFailedException,
                    AuthorizationFailedException,
                    DoesNotExistException,
                    TimeoutException,
                    IncorrectStateException,
                    NoSuccessException

Release resource

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.

IncorrectStateException - is thrown when the resource is in such a state that it cannot be released

DoesNotExistException - is thrown when the resource is not alive.