Java Doc for ReasonHeader.java in  » 6.0-JDK-Modules » Java-Advanced-Imaging » javax » sip » header » 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 » javax.sip.header 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.sip.header.ReasonHeader

ReasonHeader
public interface ReasonHeader extends Parameters,Header(Code)
This interface represents the Reason header, as defined by RFC3326, this header is not part of RFC3261.

The ReasonHeader provides information on why a SIP request was issued, often useful when creating services and also used to encapsulate a final status code in a provisional response, which is needed to resolve the "Heterogeneous Error Response Forking Problem".

The Reason header field appears to be most useful for BYE and CANCEL requests, but it can appear in any request within a dialog, in any CANCEL request and in 155 (Update Requested) responses. When used in requests, clients and servers are free to ignore this header field. It has no impact on protocol processing.

Examples of the ReasonHeader usage are:

  • A SIP CANCEL request can be issued if the call has completed on another branch or was abandoned before answer. While the protocol and system behavior is the same in both cases, namely, alerting will cease, the user interface may well differ. In the second case, the call may be logged as a missed call, while this would not be appropriate if the call was picked up elsewhere.
  • Third party call controllers sometimes generate a SIP request upon reception of a SIP response from another dialog. Gateways generate SIP requests after receiving messages from a different protocol than SIP. In both cases the client may be interested in knowing what triggered the SIP request.
  • An INVITE can sometimes be rejected not because the session initiation was declined, but because some aspect of the request was not acceptable. If the INVITE forked and resulted in a rejection, the error response may never be forwarded to the client unless all the other branches also reject the request. This problem is known as the "Heterogeneous Error Response Forking Problem". The header field defined in this draft allows encapsulating the final error response in a 155 (Update Requested) provisional response.
A server must ignore Headers that it does not understand. A proxy must not remove or modify Headers that it does not understand.
author:
   BEA Systems, NIST
version:
   1.2


Field Summary
final public static  StringNAME
    


Method Summary
public  intgetCause()
    
public  StringgetProtocol()
    
public  StringgetText()
    
public  voidsetCause(int cause)
     Sets the cause value of the ReasonHeader.
public  voidsetProtocol(String protocol)
     Sets the protocol of the ReasonHeader, for example SIP or Q.850.
public  voidsetText(String text)
     Sets the text value of the ReasonHeader.

Field Detail
NAME
final public static String NAME(Code)
Name of ReasonHeader





Method Detail
getCause
public int getCause()(Code)
Gets the cause value of the ReasonHeader the integer value of the cause of the ReasonHeader



getProtocol
public String getProtocol()(Code)
Gets the protocol value of the ReasonHeader the string value of the protocol of the ReasonHeader



getText
public String getText()(Code)
Gets the text value of the ReasonHeader the string value of the text of the ReasonHeader



setCause
public void setCause(int cause) throws InvalidArgumentException(Code)
Sets the cause value of the ReasonHeader. Any SIP status code MAY appear in the Reason header field of a request, assuming the protocol field of the ReasonHeader is SIP.
Parameters:
  cause - - the new integer value of the cause of the ReasonHeader
throws:
  InvalidArgumentException - if the cause value is less than zero.



setProtocol
public void setProtocol(String protocol) throws ParseException(Code)
Sets the protocol of the ReasonHeader, for example SIP or Q.850.
Parameters:
  protocol - - the new string value of the protocol of the ReasonHeader
throws:
  ParseException - which signals that an error has been reachedunexpectedly while parsing the protocol value.



setText
public void setText(String text) throws ParseException(Code)
Sets the text value of the ReasonHeader.
Parameters:
  text - - the new string value of the text of the ReasonHeader
throws:
  ParseException - which signals that an error has been reachedunexpectedly while parsing the text value.



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