|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.xml.ws.tx.coordinator.Coordinator
public abstract class Coordinator
This class encapsulates a coordinated activity.
Whenever a client (participant) registers for the activity, aRegistrant
is constructed and managed by this class.
Constructor Summary | |
---|---|
Coordinator(CoordinationContextInterface context)
Construct a new Coordinator object from the specified context. |
|
Coordinator(CoordinationContextInterface context,
CreateCoordinationContextType request)
Construct a new Coordinator object from the specified context and soap request. |
Method Summary | |
---|---|
abstract void |
addRegistrant(Registrant registrant,
javax.xml.ws.WebServiceContext wsContext)
Add the specified Registrant to the list of registrants for this coordinated activity. |
abstract boolean |
expirationGuard()
Sub classes will implement this method to indicate whether or not they are subject to expiration. |
void |
expire()
Release resources held by this coordinator. |
void |
forget()
Release all resources associated with this coordinator |
CoordinationContextInterface |
getContext()
Get the coordination context associated with this coordinated activity |
abstract javax.xml.ws.EndpointReference |
getCoordinatorProtocolServiceForRegistrant(Registrant r)
Return the Coordinator Protocol Service EPR for registrant r. |
long |
getExpires()
Get the expiration value |
Identifier |
getId()
Get the ActivityIdentifier object. |
java.lang.String |
getIdValue()
Get the activity id value |
abstract Registrant |
getRegistrant(java.lang.String id)
Get the registrant with the specified id or null if it does not exist. |
abstract java.util.List<Registrant> |
getRegistrants()
Get the list of Registrant s for this coordinated activity. |
CreateCoordinationContextType |
getRequest()
Get the SOAP request associated with this coordinated activity, if it exists. |
boolean |
isExpired()
|
boolean |
isSubordinate()
Return true iff this coordinator is delegating to a root coordinator |
boolean |
registerWithRootRegistrationService(Registrant r)
Return true iff registrant should register with its root registration service. |
abstract void |
removeRegistrant(java.lang.String id)
Remove the registrant with the specified id |
void |
setExpired(boolean expired)
|
void |
setExpires(long i)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Coordinator(@NotNull CoordinationContextInterface context, @Nullable CreateCoordinationContextType request)
context
- The coordination contextrequest
- The soap requestpublic Coordinator(@NotNull CoordinationContextInterface context)
context
- The coordination contextMethod Detail |
---|
@NotNull public CoordinationContextInterface getContext()
@Nullable public CreateCoordinationContextType getRequest()
@NotNull public java.lang.String getIdValue()
@NotNull public Identifier getId()
ActivityIdentifier
object.
This object can be used when it is necessary to insert the id as
a ReferenceParameter in a soap message
public long getExpires()
public void setExpires(long i)
@NotNull public abstract java.util.List<Registrant> getRegistrants()
Registrant
s for this coordinated activity.
The returned list is unmodifiable (read-only). Add new Registrants
with the addRegistrant(Registrant,WebServiceContext)
api instead.
public abstract void addRegistrant(Registrant registrant, javax.xml.ws.WebServiceContext wsContext)
registrant
- The Registrant
wsContext
- the web service context of the incoming message or null if it isn't available@Nullable public abstract Registrant getRegistrant(java.lang.String id)
id
- the registrant id
public abstract void removeRegistrant(java.lang.String id)
id
- the registrant idpublic boolean isSubordinate()
@NotNull public abstract javax.xml.ws.EndpointReference getCoordinatorProtocolServiceForRegistrant(@NotNull Registrant r)
r
- registrant
public boolean registerWithRootRegistrationService(@NotNull Registrant r)
r
- restistrant
public abstract boolean expirationGuard()
public void expire()
public boolean isExpired()
public void setExpired(boolean expired)
public void forget()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |