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

Header
public interface Header extends Cloneable,Serializable(Code)
This interface is the super interface of all SIP headers supported explicitly by this specification. Extension Headers can be supported by this specification as required by extending the ExtensionHeader assuming other endpoints understand the Header. This specification supports the following headers not defined in RFC3261 documented in the following standards track RFCs:
  • RAckHeader - this header is specific to the reliability of provisional Responses. This functionality is defined in RFC3262.
  • RSeqHeader - this header is specific to the reliability of provisional Responses. This functionality is defined in RFC3262.
  • AllowEventsHeader - this header is specific to the event notification framework. This functionality is defined in RFC3265.
  • EventHeader - this header is specific to the event notification framework. This functionality is defined in RFC3265.
  • SubscriptionStateHeader - this header is specific to the event notification framework. This functionality is defined in RFC3265.
  • ReasonHeader - The Reason Header provides information on why a SIP request was issued, often useful when creating services and used to encapsulate a final status code in a provisional response. This functionality is defined in RFC3326.
SIP header fields are similar to HTTP header fields in both syntax and semantics. Some header fields only make sense in requests or responses. These are called request header fields and response header fields, respectively. If a header field appears in a message not matching its category (such as a request header field in a response), it MUST be ignored.

Header Handling:
Any SIP header whose grammar is of the form:

header = "header-name" HCOLON header-value *(COMMA header-value)

allows for combining header fields of the same name into a comma-separated list. In this specification each Header object has a single value or attribute pair. For example a Header whose grammer is of the form:
Allow: Invite, Bye;

would be represented in a SIP message with two AllowHeader objects each containing a single attribute, Invite and Bye respectively. Implementations MUST be able to parse multiple header field rows with the same name in any combination of the single-value-per-line or comma-separated value forms and translate them into the relevent Header objects defined in this specification.

The relative order of header objects within messages is not significant. However, it is RECOMMENDED that required header and headers which are needed for proxy processing (Via, Route, Record-Route, Proxy-Require, Max-Forwards, and Proxy-Authorization, for example) appear towards the top of the message to facilitate rapid parsing.

The relative order of header objects with the same field name is important. Multiple headers with the same name MAY be present in a message if and only if the entire field-value for that header field can be defined as a comma-separated list as defined by RFC 3261. The exceptions to this rule are the WWW-Authenticate, Authorization, Proxy-Authenticate, and Proxy-Authorization header fields. Multiple header objects with these names MAY be present in a message, but since their grammar does not follow the general form listed above, they MUST NOT be combined into a single header field row when sent over the network.

Even though an arbitrary number of parameter pairs may be attached to a header object, any given parameter-name MUST NOT appear more than once.
author:
   BEA Systems, NIST
version:
   1.2





Method Summary
public  Objectclone()
     Creates and returns a deep copy of the Header.
public  booleanequals(Object obj)
     Compare this SIP Header for equality with another.
public  StringgetName()
     Gets the unique string name of this Header.
public  inthashCode()
     Gets a integer hashcode representation of the Header.
public  StringtoString()
     Gets a string representation of the Header.



Method Detail
clone
public Object clone()(Code)
Creates and returns a deep copy of the Header. This methods must ensure a deep copy of the Header, so that when a message is cloned the Header can be modified without effecting the original Header in the message. This provides useful functionality for proxying Requests and Responses, for example:
  • Recieve a message.
  • Create a deep clone of the message and headers.
  • Modify necessary headers.
  • Proxy the message using the send methods on the SipProvider.
This method overrides the clone method in java.lang.Object. a deep copy of Header



equals
public boolean equals(Object obj)(Code)
Compare this SIP Header for equality with another. This method overrides the equals method in java.lang.Object. This method is over-ridden further for each required header (To, From, CSeq, Call-ID, Max-Forwards, and Via) which object equality is outlined as specified by RFC3261. All optional headers are compared using object equality that is each field in the header is used for comparision. When comparing header fields, field names are always case-insensitive. Unless otherwise stated in the definition of a particular header field, field values, parameter names, and parameter values are case-insensitive. Tokens are always case-insensitive. Unless specified otherwise, values expressed as quoted strings are case-sensitive.
Parameters:
  obj - the object to compare this Header with. true if obj is an instance of this classrepresenting the same SIP Header as this, false otherwise.



getName
public String getName()(Code)
Gets the unique string name of this Header. A name constant is defined in each individual Header identifying each Header. the name of this specific Header



hashCode
public int hashCode()(Code)
Gets a integer hashcode representation of the Header. This method overrides the hashcode method in java.lang.Object. integer representation of Header hashcode
since:
   v1.2



toString
public String toString()(Code)
Gets a string representation of the Header. This method overrides the toString method in java.lang.Object. string representation of Header



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