Java Doc for SipEventCollector.java in  » 6.0-JDK-Modules » Java-Advanced-Imaging » test » tck » msgflow » 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 » Java Advanced Imaging » test.tck.msgflow 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   test.tck.msgflow.SipEventCollector

SipEventCollector
class SipEventCollector (Code)

This class collects a single event from a given provider. The collector listens for incoming events until the desired event has been received, all following events are ignored. After extractCollectedEvent method has been called, the SipEventCollecter removes itself as a listener from the provider and goes back to its original state (i.e. could be reused). The collector ignores all events except the one it is supposed to collect. If an extract operation is a attempted on an event other than the collected event a TckInternalError is thrown. All exceptions raised within the collector are let to pass through and are responsibility of the using class

This class does not test event dispatching! Event dispatching tests should have been performed before using this class in order to assure coherent test reports.


author:
   Emil Ivov Network Research Team, Louis Pasteur University,
author:
   Strasbourg, France.
version:
   1.0




Method Summary
public  voidcollectDialogTermiatedEvent(SipProvider provider)
     Collects the first javax.sip.TransactionTerminated fired by the specified provider.
public  voidcollectRequestEvent(SipProvider provider)
     Collects the first javax.sip.RequestEvent fired by the specified provider.
public  voidcollectResponseEvent(SipProvider provider)
     Collects the first javax.sip.ResponseEvent fired by the specified provider.
public  voidcollectTimeoutEvent(SipProvider provider)
     Collects the first javax.sip.TimeoutEvent fired by the specified provider.
public  voidcollectTransactionTermiatedEvent(SipProvider provider)
     Collects the first javax.sip.TransactionTerminated fired by the specified provider.
public  DialogTerminatedEventextractCollectedDialogTerminatedEvent()
     Returns the collected javax.sip.DialogTerminatedEvent or null if no event has been collected.
public  RequestEventextractCollectedRequestEvent()
     Returns the collected javax.sip.RequestEvent or null if no event has been collected.
public  RequestEventextractCollectedRequestEvent(boolean toReset)
    
public  ResponseEventextractCollectedResponseEvent()
     Returns the collected javax.sip.ResponseEvent or null if no event has been collected.
public  TimeoutEventextractCollectedTimeoutEvent()
     Returns the collected javax.sip.TimeoutEvent or null if no event has been collected.
public  TransactionTerminatedEventextractCollectedTransactionTerminatedEvent()
     Returns the collected javax.sip.DialogTerminatedEvent or null if no event has been collected.



Method Detail
collectDialogTermiatedEvent
public void collectDialogTermiatedEvent(SipProvider provider) throws TooManyListenersException(Code)
Collects the first javax.sip.TransactionTerminated fired by the specified provider. All subsequent events and events other than javax.sip.TimeoutEvent are ignored.
Parameters:
  provider - the provider that this collector should listen to
throws:
  TooManyListenersException - in case the specified provider throws that exception. It isthe responsibility of the calling class to encapsulate itwith the corresponding error (e.g. TckInternalError,AssertFailure or TiUnexpectedError) and throw it in its turnto upper layers.



collectRequestEvent
public void collectRequestEvent(SipProvider provider) throws TooManyListenersException(Code)
Collects the first javax.sip.RequestEvent fired by the specified provider. All subsequent events and events other than javax.sip.RequestEvent are ignored.
Parameters:
  provider - the provider that this collector should listen to
throws:
  TooManyListenersException - in case the specified provider throws that exception. It isthe responsibility of the calling class to encapsulate itwith the corresponding error (e.g. TckInternalError,AssertFailure or TiUnexpectedError) and throw it in its turnto upper layers.



collectResponseEvent
public void collectResponseEvent(SipProvider provider) throws TooManyListenersException(Code)
Collects the first javax.sip.ResponseEvent fired by the specified provider. All subsequent events and events other than javax.sip.ResponseEvent are ignored.
Parameters:
  provider - the provider that this collector should listen to
throws:
  TooManyListenersException - in case the specified provider throws that exception. It isthe responsibility of the calling class to encapsulate itwith the corresponding error (e.g. TckInternalError,AssertFailure or TiUnexpectedError) and throw it in its turnto upper layers.



collectTimeoutEvent
public void collectTimeoutEvent(SipProvider provider) throws TooManyListenersException(Code)
Collects the first javax.sip.TimeoutEvent fired by the specified provider. All subsequent events and events other than javax.sip.TimeoutEvent are ignored.
Parameters:
  provider - the provider that this collector should listen to
throws:
  TooManyListenersException - in case the specified provider throws that exception. It isthe responsibility of the calling class to encapsulate itwith the corresponding error (e.g. TckInternalError,AssertFailure or TiUnexpectedError) and throw it in its turnto upper layers.



collectTransactionTermiatedEvent
public void collectTransactionTermiatedEvent(SipProvider provider) throws TooManyListenersException(Code)
Collects the first javax.sip.TransactionTerminated fired by the specified provider. All subsequent events and events other than javax.sip.TimeoutEvent are ignored.
Parameters:
  provider - the provider that this collector should listen to
throws:
  TooManyListenersException - in case the specified provider throws that exception. It isthe responsibility of the calling class to encapsulate itwith the corresponding error (e.g. TckInternalError,AssertFailure or TiUnexpectedError) and throw it in its turnto upper layers.



extractCollectedDialogTerminatedEvent
public DialogTerminatedEvent extractCollectedDialogTerminatedEvent()(Code)
Returns the collected javax.sip.DialogTerminatedEvent or null if no event has been collected. After this method is called the SipEventCollector will remove itself from the corresponding javax.sip.SipProvider and reset its internal state so that it could be reused. the collected javax.sip.TimeoutEvent
throws:
  TckInternalError - in case the method is called without first calling thecollectTimeoutEvent



extractCollectedRequestEvent
public RequestEvent extractCollectedRequestEvent()(Code)
Returns the collected javax.sip.RequestEvent or null if no event has been collected. After this method is called the SipEventCollector will remove itself from the corresponding javax.sip.SipProvider and reset its internal state so that it could be reused. the collected javax.sip.RequestEvent
throws:
  TckInternalError - in case the method is called without first calling thecollectRequestEvent



extractCollectedRequestEvent
public RequestEvent extractCollectedRequestEvent(boolean toReset)(Code)



extractCollectedResponseEvent
public ResponseEvent extractCollectedResponseEvent()(Code)
Returns the collected javax.sip.ResponseEvent or null if no event has been collected. After this method is called the SipEventCollector will remove itself from the corresponding javax.sip.SipProvider and reset its internal state so that it could be reused. the collected javax.sip.ResponseEvent
throws:
  TckInternalError - in case the method is called without first calling thecollectResponseEvent



extractCollectedTimeoutEvent
public TimeoutEvent extractCollectedTimeoutEvent()(Code)
Returns the collected javax.sip.TimeoutEvent or null if no event has been collected. After this method is called the SipEventCollector will remove itself from the corresponding javax.sip.SipProvider and reset its internal state so that it could be reused. the collected javax.sip.TimeoutEvent
throws:
  TckInternalError - in case the method is called without first calling thecollectTimeoutEvent



extractCollectedTransactionTerminatedEvent
public TransactionTerminatedEvent extractCollectedTransactionTerminatedEvent()(Code)
Returns the collected javax.sip.DialogTerminatedEvent or null if no event has been collected. After this method is called the SipEventCollector will remove itself from the corresponding javax.sip.SipProvider and reset its internal state so that it could be reused. the collected javax.sip.TimeoutEvent
throws:
  TckInternalError - in case the method is called without first calling thecollectTimeoutEvent



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.