uk.ac.soton.itinnovation.grid.comms.client
Class BaseRemoteConversation<T extends Conversation>

java.lang.Object
  uk.ac.soton.itinnovation.grid.comms.client.BaseRemoteResource<T>
      uk.ac.soton.itinnovation.grid.comms.client.BaseRemoteConversation<T>

All Implemented Interfaces:

Comparable<StorableInStateRepository>, Conversation, StorableInStateRepository

Direct Known Subclasses:

CltMgtRegistryResourceHelpers, DataStagerHelpers, JobHelpers, MembershipGroupHelpers, OgsaDaiResourceConversationHelpers, OgsaDaiRoleConversationHelpers, OgsaDaiSubscriptionConversationHelpers, PrivateAccountHelpers, SLAHelpers, TradeAccountHelpers

public class BaseRemoteConversation<T extends Conversation>
extends BaseRemoteResource<T>
implements Conversation

Non-SOAP methods common to Conversation objects. This base class provides the implementation of the core operations supported by proxies to remote resources.

See Also:

RemoteResourceProxy, AdditionalMethods

Field Summary

protected static org.apache.log4j.Logger

log

Fields inherited from class uk.ac.soton.itinnovation.grid.comms.client.BaseRemoteResource

EPR, proxy, repository, serviceName, soapBinding, transport

Constructor Summary

BaseRemoteConversation()

Method Summary

protected void	assertNotFinished() Throws a RuntimeException if the conversation is finished (unusable).
int	compareTo(StorableInStateRepository other)
void	finish() Indicate that this conversation is no longer required.
StorableInStateRepository[]	getChildConversations() Returns an array of all conversations having this one as a parent.
protected String	getContextID() Value to put in the context header, or null if none.
Conversation	getParentConversation()
RemoteService	getService() Return the conversation's RemoteService.
protected void	initHelper() Perform any post-initialisation setup.
boolean	isFinished() Returns true if the finish method has been called.
void	outOfDate() Used by the StateRepository if the server returns new conversation with our ID.
void	setLabel(String description)
String	toString()

Methods inherited from class uk.ac.soton.itinnovation.grid.comms.client.BaseRemoteResource

createMethod, equals, getDescription, getEndpoint, getEndpointRef, getInterface, getMethod, getParentURL, getRepository, getServiceName, getURL, getWSDL, hasMethod, invoke, invokeService, invokeService, setDescription

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface uk.ac.soton.ecs.iam.grid.comms.client.StorableInStateRepository

getDescription, getEndpointRef, getInterface, getParentURL, getRepository, getURL, setDescription

Field Detail

log

protected static org.apache.log4j.Logger log

Constructor Detail

BaseRemoteConversation

public BaseRemoteConversation()

Method Detail

initHelper

protected void initHelper()

Description copied from class: BaseRemoteResource

Perform any post-initialisation setup. Can be overridden by subclasses. Called at the end of BaseRemoteResource.initProxyInternal(T, java.lang.Class, uk.ac.soton.ecs.iam.grid.comms.client.StateRepository, org.apache.axis.message.addressing.EndpointReferenceType).

Overrides:

initHelper in class BaseRemoteResource<T extends Conversation>

getParentConversation

public Conversation getParentConversation()

getChildConversations

public StorableInStateRepository[] getChildConversations()

Description copied from interface: Conversation

Returns an array of all conversations having this one as a parent.

Specified by:

getChildConversations in interface Conversation

getContextID

protected String getContextID()

Description copied from class: BaseRemoteResource

Value to put in the context header, or null if none.

Overrides:

getContextID in class BaseRemoteResource<T extends Conversation>

toString

public String toString()

Overrides:

toString in class BaseRemoteResource<T extends Conversation>

assertNotFinished

protected void assertNotFinished()

Throws a RuntimeException if the conversation is finished (unusable).

Overrides:

assertNotFinished in class BaseRemoteResource<T extends Conversation>

finish

public void finish()

Description copied from interface: Conversation

Indicate that this conversation is no longer required. It will be removed from the StateRepository. No other methods on a Conversation can be called once finish() has been invoked.

Note that this does not close the conversation with the remote supplier. You should normally call a different method, such as WSResourceLifetime.destroy().

Specified by:

finish in interface Conversation

isFinished

public boolean isFinished()

Description copied from interface: Conversation

Returns true if the finish method has been called.

Specified by:

isFinished in interface Conversation

getService

public RemoteService getService()

Description copied from interface: Conversation

Return the conversation's RemoteService.

Specified by:

getService in interface Conversation

outOfDate

public void outOfDate()

Used by the StateRepository if the server returns new conversation with our ID.

Specified by:

outOfDate in interface Conversation

compareTo

public int compareTo(StorableInStateRepository other)

Specified by:

compareTo in interface Comparable<StorableInStateRepository>

Overrides:

compareTo in class BaseRemoteResource<T extends Conversation>

setLabel

public void setLabel(String description)
              throws RemoteException

Throws:

RemoteException