Java Doc for WarningHeader.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.WarningHeader

WarningHeader
public interface WarningHeader extends Header(Code)
The Warning header field is used to carry additional information about the status of a response. Warning header field values are sent with responses and contain a three-digit warning code, agent name, and warning text.
  • Warning Text: The "warn-text" should be in a natural language that is most likely to be intelligible to the human user receiving the response. This decision can be based on any available knowledge, such as the location of the user, the Accept-Language field in a request, or the Content-Language field in a response.
  • Warning Code: The currently-defined "warn-code"s have a recommended warn-text in English and a description of their meaning. These warnings describe failures induced by the session description. The first digit of warning codes beginning with "3" indicates warnings specific to SIP. Warnings 300 through 329 are reserved for indicating problems with keywords in the session description, 330 through 339 are warnings related to basic network services requested in the session description, 370 through 379 are warnings related to quantitative QoS parameters requested in the session description, and 390 through 399 are miscellaneous warnings that do not fall into one of the above categories. Additional "warn-code"s can be defined.
Any server may add WarningHeaders to a Response. Proxy servers must place additional WarningHeaders before any AuthorizationHeaders. Within that constraint, WarningHeaders must be added after any existing WarningHeaders not covered by a signature. A proxy server must not delete any WarningHeader that it received with a Response.

When multiple WarningHeaders are attached to a Response, the user agent should display as many of them as possible, in the order that they appear in the Response. If it is not possible to display all of the warnings, the user agent first displays warnings that appear early in the Response.

Examples of using Warning Headers are as follows:

  • A UAS rejecting an offer contained in an INVITE SHOULD return a 488 (Not Acceptable Here) response. Such a response SHOULD include a Warning header field value explaining why the offer was rejected.
  • If the new session description is not acceptable, the UAS can reject it by returning a 488 (Not Acceptable Here) response for the re-INVITE. This response SHOULD include a Warning header field.
  • A 606 (Not Acceptable) response means that the user wishes to communicate, but cannot adequately support the session described. The 606 (Not Acceptable) response MAY contain a list of reasons in a Warning header field describing why the session described cannot be supported.
  • Contact header fields MAY be present in a 200 (OK) response and have the same semantics as in a 3xx response. That is, they may list a set of alternative names and methods of reaching the user. A Warning header field MAY be present.
For Example:
Warning: 307 isi.edu "Session parameter 'foo' not understood"
author:
   BEA Systems, NIST
version:
   1.2


Field Summary
final public static  intATTRIBUTE_NOT_UNDERSTOOD
     One or more of the media attributes in the session description are not supported.
final public static  intINCOMPATIBLE_BANDWIDTH_UNITS
     One or more bandwidth measurement units contained in the session description were not understood.
final public static  intINCOMPATIBLE_MEDIA_FORMAT
     One or more media formats contained in the session description are not available.
final public static  intINCOMPATIBLE_NETWORK_ADDRESS_FORMATS
     One or more network address formats contained in the session description are not available.
final public static  intINCOMPATIBLE_NETWORK_PROTOCOL
     One or more network protocols contained in the session description are not available.
final public static  intINCOMPATIBLE_TRANSPORT_PROTOCOL
     One or more transport protocols described in the session description are not available.
final public static  intINSUFFICIENT_BANDWIDTH
     The bandwidth specified in the session description or defined by the media exceeds that known to be available.
final public static  intMEDIA_TYPE_NOT_AVAILABLE
     One or more media types contained in the session description are not available.
final public static  intMISCELLANEOUS_WARNING
     The warning text can include arbitrary information to be presented to a human user, or logged.
final public static  intMULTICAST_NOT_AVAILABLE
     The site where the user is located does not support multicast.
final public static  StringNAME
    
final public static  intSESSION_DESCRIPTION_PARAMETER_NOT_UNDERSTOOD
     A parameter other than those listed above was not understood.
final public static  intUNICAST_NOT_AVAILABLE
     The site where the user is located does not support unicast communication (usually due to the presence of a firewall).


Method Summary
public  StringgetAgent()
     Gets the agent of the server that created this WarningHeader.
public  intgetCode()
     Gets the code of the WarningHeader.
public  StringgetText()
     Gets text of WarningHeader.
public  voidsetAgent(String agent)
     Sets the agent value of the WarningHeader to the new value passed to the method.
public  voidsetCode(int code)
     Sets the code of the WarningHeader.
public  voidsetText(String text)
     Sets the text of WarningHeader to the newly supplied text value.

Field Detail
ATTRIBUTE_NOT_UNDERSTOOD
final public static int ATTRIBUTE_NOT_UNDERSTOOD(Code)
One or more of the media attributes in the session description are not supported.



INCOMPATIBLE_BANDWIDTH_UNITS
final public static int INCOMPATIBLE_BANDWIDTH_UNITS(Code)
One or more bandwidth measurement units contained in the session description were not understood.



INCOMPATIBLE_MEDIA_FORMAT
final public static int INCOMPATIBLE_MEDIA_FORMAT(Code)
One or more media formats contained in the session description are not available.



INCOMPATIBLE_NETWORK_ADDRESS_FORMATS
final public static int INCOMPATIBLE_NETWORK_ADDRESS_FORMATS(Code)
One or more network address formats contained in the session description are not available.



INCOMPATIBLE_NETWORK_PROTOCOL
final public static int INCOMPATIBLE_NETWORK_PROTOCOL(Code)
One or more network protocols contained in the session description are not available.



INCOMPATIBLE_TRANSPORT_PROTOCOL
final public static int INCOMPATIBLE_TRANSPORT_PROTOCOL(Code)
One or more transport protocols described in the session description are not available.



INSUFFICIENT_BANDWIDTH
final public static int INSUFFICIENT_BANDWIDTH(Code)
The bandwidth specified in the session description or defined by the media exceeds that known to be available.



MEDIA_TYPE_NOT_AVAILABLE
final public static int MEDIA_TYPE_NOT_AVAILABLE(Code)
One or more media types contained in the session description are not available.



MISCELLANEOUS_WARNING
final public static int MISCELLANEOUS_WARNING(Code)
The warning text can include arbitrary information to be presented to a human user, or logged. A system receiving this warning MUST NOT take any automated action.



MULTICAST_NOT_AVAILABLE
final public static int MULTICAST_NOT_AVAILABLE(Code)
The site where the user is located does not support multicast.



NAME
final public static String NAME(Code)
Name of WarningHeader



SESSION_DESCRIPTION_PARAMETER_NOT_UNDERSTOOD
final public static int SESSION_DESCRIPTION_PARAMETER_NOT_UNDERSTOOD(Code)
A parameter other than those listed above was not understood.



UNICAST_NOT_AVAILABLE
final public static int UNICAST_NOT_AVAILABLE(Code)
The site where the user is located does not support unicast communication (usually due to the presence of a firewall).





Method Detail
getAgent
public String getAgent()(Code)
Gets the agent of the server that created this WarningHeader. the agent of the WarningHeader



getCode
public int getCode()(Code)
Gets the code of the WarningHeader. the integer code value of the WarningHeader



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



setAgent
public void setAgent(String agent) throws ParseException(Code)
Sets the agent value of the WarningHeader to the new value passed to the method.
Parameters:
  agent - - the new agent value of WarningHeader
throws:
  ParseException - which signals that an error has been reachedunexpectedly while parsing the agent value.



setCode
public void setCode(int code) throws InvalidArgumentException(Code)
Sets the code of the WarningHeader. The standard RFC3261 codes are defined as constants in this class.
Parameters:
  code - - the new code that defines the warning code.
throws:
  InvalidArgumentException - if an invalid integer code is given forthe WarningHeader.



setText
public void setText(String text) throws ParseException(Code)
Sets the text of WarningHeader to the newly supplied text value.
Parameters:
  text - - the new text value of the Warning Header.
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.