|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Resource
An object managed by a service that an API can interact with. Either a Producer or a Consumer.
Method Summary | |
---|---|
void |
close()
Closes the resource. |
void |
destroy()
Closes and destroys the resource. |
ResourceEndpoint |
getResourceEndpoint()
Gets the endpoint of the resource with which the API communicates. |
TimeInterval |
getTerminationInterval()
Retrieves the resource's termination interval. |
void |
setTerminationInterval(TimeInterval terminationInterval)
Deprecated. Termination interval can only be set in factory create method. |
void |
showSignOfLife()
Indicates to the resource that this API is still alive. |
Method Detail |
---|
ResourceEndpoint getResourceEndpoint()
void setTerminationInterval(TimeInterval terminationInterval) throws RemoteException, UnknownResourceException, RGMAException
terminationInterval
- The time interval after which the resource
may destroy itself if no contact has been made from the API.
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).getTerminationInterval()
TimeInterval getTerminationInterval() throws RemoteException, UnknownResourceException
RemoteException
- If the service could not be contacted.
UnknownResourceException
- If the resource could not be found.setTerminationInterval(TimeInterval)
void close() throws RemoteException, UnknownResourceException
RemoteException
- If the service could not be contacted.
UnknownResourceException
- If the resource could not be found.destroy()
void destroy() throws RemoteException, UnknownResourceException
RemoteException
- If the service could not be contacted.
UnknownResourceException
- If the resource could not be found.close()
void showSignOfLife() throws RemoteException, UnknownResourceException
RemoteException
- If the service could not be contacted.
UnknownResourceException
- If the resource could not be found.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |