Java Doc for Coordinator.java in  » 6.0-JDK-Modules-com.sun » wsit » com » sun » xml » ws » tx » coordinator » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules com.sun » wsit » com.sun.xml.ws.tx.coordinator 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sun.xml.ws.tx.coordinator.Coordinator

All known Subclasses:   com.sun.xml.ws.tx.at.ATCoordinator,
Coordinator
abstract public class Coordinator (Code)
This class encapsulates a coordinated activity.

Whenever a client (participant) registers for the activity, a Registrant is constructed and managed by this class.
author:
   Ryan.Shoemaker@Sun.COM
version:
   $Revision: 1.9 $
since:
   1.0


Inner Class :static class ExpirationTask extends TimerTask


Constructor Summary
public  Coordinator(CoordinationContextInterface context, CreateCoordinationContextType request)
     Construct a new Coordinator object from the specified context and soap request.
public  Coordinator(CoordinationContextInterface context)
     Construct a new Coordinator object from the specified context.

Method Summary
abstract public  voidaddRegistrant(Registrant registrant, WebServiceContext wsContext)
     Add the specified Registrant to the list of registrants for this coordinated activity.
abstract public  booleanexpirationGuard()
     Sub classes will implement this method to indicate whether or not they are subject to expiration.
public  voidexpire()
     Release resources held by this coordinator.

This method will be automatically invoked once if the activity has a non-zero expiration.

During expiration, the coordinator will iterate over all of its registrants and tell them to expire.

public  voidforget()
    
public  CoordinationContextInterfacegetContext()
    
abstract public  EndpointReferencegetCoordinatorProtocolServiceForRegistrant(Registrant r)
     Return the Coordinator Protocol Service EPR for registrant r.
public  longgetExpires()
    
public  IdentifiergetId()
     Get the ActivityIdentifier object.
public  StringgetIdValue()
    
abstract public  RegistrantgetRegistrant(String id)
     Get the registrant with the specified id or null if it does not exist.
abstract public  List<Registrant>getRegistrants()
     Get the list of Registrant s for this coordinated activity.

The returned list is unmodifiable (read-only).

public  CreateCoordinationContextTypegetRequest()
     Get the SOAP request associated with this coordinated activity, if it exists.
public  booleanisExpired()
    
public  booleanisSubordinate()
    
public  booleanregisterWithRootRegistrationService(Registrant r)
     Return true iff registrant should register with its root registration service.
abstract public  voidremoveRegistrant(String id)
    
public  voidsetExpired(boolean expired)
    
public  voidsetExpires(long i)
    


Constructor Detail
Coordinator
public Coordinator(CoordinationContextInterface context, CreateCoordinationContextType request)(Code)
Construct a new Coordinator object from the specified context and soap request.
Parameters:
  context - The coordination context
Parameters:
  request - The soap request



Coordinator
public Coordinator(CoordinationContextInterface context)(Code)
Construct a new Coordinator object from the specified context.

This constructor will be the main entry point for activity within the AppServer.
Parameters:
  context - The coordination context





Method Detail
addRegistrant
abstract public void addRegistrant(Registrant registrant, WebServiceContext wsContext)(Code)
Add the specified Registrant to the list of registrants for this coordinated activity.
Parameters:
  registrant - The Registrant
Parameters:
  wsContext - the web service context of the incoming message or null if it isn't available



expirationGuard
abstract public boolean expirationGuard()(Code)
Sub classes will implement this method to indicate whether or not they are subject to expiration. true if the coordinator should NOT expire, false otherwise.



expire
public void expire()(Code)
Release resources held by this coordinator.

This method will be automatically invoked once if the activity has a non-zero expiration.

During expiration, the coordinator will iterate over all of its registrants and tell them to expire. Depending on their state, registrants will either expire or not. A coordinator will not completely expire until all of its registrants have expired.




forget
public void forget()(Code)
Release all resources associated with this coordinator



getContext
public CoordinationContextInterface getContext()(Code)
Get the coordination context associated with this coordinated activity The coordination context



getCoordinatorProtocolServiceForRegistrant
abstract public EndpointReference getCoordinatorProtocolServiceForRegistrant(Registrant r)(Code)
Return the Coordinator Protocol Service EPR for registrant r.
Parameters:
  r - registrant the CPS EPT for the specified registrant



getExpires
public long getExpires()(Code)
Get the expiration value The expiration value



getId
public Identifier getId()(Code)
Get the ActivityIdentifier object.

This object can be used when it is necessary to insert the id as a ReferenceParameter in a soap message The activity id object




getIdValue
public String getIdValue()(Code)
Get the activity id value The activity id value



getRegistrant
abstract public Registrant getRegistrant(String id)(Code)
Get the registrant with the specified id or null if it does not exist.
Parameters:
  id - the registrant id the Registrant object or null if the id does not exist



getRegistrants
abstract public List<Registrant> getRegistrants()(Code)
Get the list of Registrant s for this coordinated activity.

The returned list is unmodifiable (read-only). Add new Registrants with the Coordinator.addRegistrant(Registrant,WebServiceContext) api instead. the list of Registrant objects




getRequest
public CreateCoordinationContextType getRequest()(Code)
Get the SOAP request associated with this coordinated activity, if it exists. The original SOAP request (createCoordinationContext) or nullif it doesn't exist.



isExpired
public boolean isExpired()(Code)



isSubordinate
public boolean isSubordinate()(Code)
Return true iff this coordinator is delegating to a root coordinator true iff this coordinator is delegating to a root coordinator



registerWithRootRegistrationService
public boolean registerWithRootRegistrationService(Registrant r)(Code)
Return true iff registrant should register with its root registration service.

Enables local participants to be cached with coordinator locally when this method returns true.
Parameters:
  r - restistrant Return true iff registrant should register with its root registration service




removeRegistrant
abstract public void removeRegistrant(String id)(Code)
Remove the registrant with the specified id
Parameters:
  id - the registrant id



setExpired
public void setExpired(boolean expired)(Code)



setExpires
public void setExpires(long i)(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.