Main Page | Class Hierarchy | Class List | File List | Class Members | Related Pages

glite::rgma::ResourceImpl Class Reference

#include <ResourceImpl.h>

Inheritance diagram for glite::rgma::ResourceImpl:

glite::rgma::Resource glite::rgma::Consumer glite::rgma::OnDemandProducer glite::rgma::PrimaryProducer glite::rgma::Registry glite::rgma::SecondaryProducer glite::rgma::ConsumerImpl glite::rgma::OnDemandProducerImpl glite::rgma::PrimaryProducerImpl glite::rgma::SecondaryProducerImpl List of all members.

Public Member Functions

virtual ResourceEndpoint getEndpoint ()
virtual TimeInterval getTerminationInterval () throw (RemoteException, UnknownResourceException)
virtual void setTerminationInterval (TimeInterval &time_interval) throw (RemoteException, UnknownResourceException, RGMAException)
virtual void destroy () throw (RemoteException, UnknownResourceException)
virtual void close () throw (RemoteException, UnknownResourceException)
virtual void showSignOfLife () throw (RemoteException, UnknownResourceException)

Protected Member Functions

ServletConnectiongetServletConnection () throw (RGMAException)

Protected Attributes

ResourceEndpoint m_endPoint

Detailed Description

An object managed by a Web Service that an API can interact with. Either a Producer or a Consumer.


Member Function Documentation

void glite::rgma::ResourceImpl::close  )  throw (RemoteException, UnknownResourceException) [virtual]
 

Closes the resource. The resource will no longer be available through this API and will be destroyed once it has finished interacting with other components.

Exceptions:
RemoteException If the service could not be contacted.
UnknownResourceException If the resource could not be found

Implements glite::rgma::Resource.

void glite::rgma::ResourceImpl::destroy  )  throw (RemoteException, UnknownResourceException) [virtual]
 

Closes and destroys the resource. The resource will no longer be available to any component.

Exceptions:
RemoteException If the service could not be contacted.
UnknownResourceException If the resource could not be found
Deprecated:

Implements glite::rgma::Resource.

ResourceEndpoint glite::rgma::ResourceImpl::getEndpoint  )  [virtual]
 

Gets the endpoint of the service/resource the API communicates with.

Returns:
The service/instance identifier

Implements glite::rgma::Resource.

ServletConnection * glite::rgma::ResourceImpl::getServletConnection  )  throw (RGMAException) [protected]
 

Will create a servlet connection if one does not exist or return a pointer to one that has been created previously

TimeInterval glite::rgma::ResourceImpl::getTerminationInterval  )  throw (RemoteException, UnknownResourceException) [virtual]
 

Retrieves the resource's termination interval.

Returns:
a pointer to the termination interval as a TimeInterval.
Exceptions:
RemoteException If the service could not be contacted.
UnknownResourceException If the resource could not be found
See also:
setTerminationInterval

Implements glite::rgma::Resource.

void glite::rgma::ResourceImpl::setTerminationInterval TimeInterval time_interval  )  throw (RemoteException, UnknownResourceException, RGMAException) [virtual]
 

Sets the termination interval for this resource.

Deprecated:
Parameters:
terminationInterval The time interval after which the resource may destroy itself if no contact has been made from the API.
Exceptions:
RemoteException If the service could not be contacted.
UnknownResourceException If the resource could not be found
RGMAException If the termination interval is invalid (e.g. in the past)
See also:
getTerminationInterval

Implements glite::rgma::Resource.

void glite::rgma::ResourceImpl::showSignOfLife  )  throw (RemoteException, UnknownResourceException) [virtual]
 

Indicates to the resource that this API is still alive. This should be used to keep a resource alive when no other method needs to be called.

Exceptions:
RemoteException If the service could not be contacted.
UnknownResourceException If the resource could not be found

Implements glite::rgma::Resource.


The documentation for this class was generated from the following files:
Generated on Fri Mar 16 14:00:16 2007 for glite-rgma-api-cpp by doxygen 1.3.5