Java Doc for ViaHeader.java in  » 6.0-JDK-Modules » j2me » gov » nist » siplite » 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 » j2me » gov.nist.siplite.header 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   gov.nist.core.GenericObject
      gov.nist.siplite.header.Header
         gov.nist.siplite.header.ParametersHeader
            gov.nist.siplite.header.ViaHeader

ViaHeader
public class ViaHeader extends gov.nist.siplite.header.ParametersHeader (Code)
Via Header (these are strung together in a ViaList).
version:
   JAIN-SIP-1.1
version:
   This code is in the public domain.


Field Summary
final public static  StringBRANCH
     The branch parameter is included by every forking proxy.
final public static  StringHIDDEN
     The "hidden" paramter is included if this header field was hidden by the upstream proxy.
final public static  StringMADDR
     The "maddr" parameter is designating the multicast address.
final public static  StringNAME
     Via header field label.
final public static  StringRECEIVED
     The "received" parameter is added only for receiver-added Via Fields.
final public static  StringTTL
     The "TTL" parameter is designating the time-to-live value.
public static  Classclazz
     Class handle.
protected  Stringcomment
     Comment field.
protected  HostPortsentBy
     Sent by field.
protected  ProtocolsentProtocol
     Sent protocol field.

Constructor Summary
public  ViaHeader()
     Default constructor.

Method Summary
public  Objectclone()
     Clone - do a deep copy.
public  StringencodeBody()
     Encodes the via header into a cannonical string.
public  booleanequals(Object other)
     Compares two via headers for equaltiy.
Parameters:
  other - Object to set.
public  StringgetBranch()
     Gets the Branch parameter if it exists.
public  StringgetComment()
     Accessor for the comment field.
public  StringgetHost()
     Gest the host name.
public  StringgetMaddr()
     Gets the maddr parameter if it exists.
public  intgetPort()
     Port of the Via header.
public  StringgetProtocolVersion()
     Gets the Protocol Version.
public  StringgetReceived()
     Gets the received parameter if it exists.
public  HostPortgetSentBy()
    
public  ProtocolgetSentProtocol()
     Accessor for the sentProtocol field.
public  StringgetTTL()
     get the ttl parameter if it exists.
public  StringgetTransport()
     Gets the current transport.
public  ObjectgetValue()
     Gets the value portion of this header (does nto include the parameters).
public  booleanhasComment()
     Comment of the Via Header.
public  booleanhasPort()
     Port of the Via Header.
public  voidremoveComment()
     Removes the comment field.
public  voidsetBranch(String branch)
     Sets the branch field. BNF (RFC3261, p.
public  voidsetComment(String c)
    
public  voidsetHeaderValue(String value)
     Sets the header value field (without parameters).
public  voidsetHost(String host)
     Sets the host field. BNF (RFC3261, p.
public  voidsetHost(Host host)
     Sets the host field.
public  voidsetMaddr(String maddr)
     Sets the maddr parameter. BNF (RFC3261, p.
public  voidsetParameter(String name, String value)
     This function is overloaded in order to validate the parameters. Sets the value of the specified parameter.
public  voidsetPort(int port)
     Sets the port field. BNF (RFC3261, p.
public  voidsetProtocolVersion(String protocolVersion)
     Sets the Protocol Version. BNF (RFC3261, p.
public  voidsetReceived(String received)
     Sets the 'received' parameter. BNF (RFC3261, p.
public  voidsetSentBy(HostPort s)
    
public  voidsetSentProtocol(Protocol s)
    
public  voidsetTTL(String strTTL)
     Sets the ttl parameter. BNF (RFC3261, p.
public  voidsetTransport(String transport)
     Sets the transport string. BNF (RFC3261, p.

Field Detail
BRANCH
final public static String BRANCH(Code)
The branch parameter is included by every forking proxy.



HIDDEN
final public static String HIDDEN(Code)
The "hidden" paramter is included if this header field was hidden by the upstream proxy.



MADDR
final public static String MADDR(Code)
The "maddr" parameter is designating the multicast address.



NAME
final public static String NAME(Code)
Via header field label.



RECEIVED
final public static String RECEIVED(Code)
The "received" parameter is added only for receiver-added Via Fields.



TTL
final public static String TTL(Code)
The "TTL" parameter is designating the time-to-live value.



clazz
public static Class clazz(Code)
Class handle.



comment
protected String comment(Code)
Comment field.



sentBy
protected HostPort sentBy(Code)
Sent by field.



sentProtocol
protected Protocol sentProtocol(Code)
Sent protocol field.




Constructor Detail
ViaHeader
public ViaHeader()(Code)
Default constructor.




Method Detail
clone
public Object clone()(Code)
Clone - do a deep copy. Object Via



encodeBody
public String encodeBody()(Code)
Encodes the via header into a cannonical string. String containing cannonical encoding of via header.



equals
public boolean equals(Object other)(Code)
Compares two via headers for equaltiy.
Parameters:
  other - Object to set. true if the two via headers are the same.



getBranch
public String getBranch()(Code)
Gets the Branch parameter if it exists. Branch field.



getComment
public String getComment()(Code)
Accessor for the comment field. comment field.



getHost
public String getHost()(Code)
Gest the host name. (null if not yet set). host name from the via header.



getMaddr
public String getMaddr()(Code)
Gets the maddr parameter if it exists. maddr parameter.



getPort
public int getPort()(Code)
Port of the Via header. port field.



getProtocolVersion
public String getProtocolVersion()(Code)
Gets the Protocol Version. String



getReceived
public String getReceived()(Code)
Gets the received parameter if it exists. received parameter.



getSentBy
public HostPort getSentBy()(Code)
Accessor for the sentBy field SentBy field



getSentProtocol
public Protocol getSentProtocol()(Code)
Accessor for the sentProtocol field. Protocol field



getTTL
public String getTTL()(Code)
get the ttl parameter if it exists. ttl parameter.



getTransport
public String getTransport()(Code)
Gets the current transport. the current transport



getValue
public Object getValue()(Code)
Gets the value portion of this header (does nto include the parameters). the via header field value



hasComment
public boolean hasComment()(Code)
Comment of the Via Header. false if comment does not exist and true otherwise.



hasPort
public boolean hasPort()(Code)
Port of the Via Header. true if Port exists.



removeComment
public void removeComment()(Code)
Removes the comment field.



setBranch
public void setBranch(String branch)(Code)
Sets the branch field. BNF (RFC3261, p. 232): via-branch = "branch" EQUAL token
Parameters:
  branch - the new branch value



setComment
public void setComment(String c)(Code)
Sets the comment member
Parameters:
  c - String to set.



setHeaderValue
public void setHeaderValue(String value) throws IllegalArgumentException(Code)
Sets the header value field (without parameters).
Parameters:
  value - is the value field to set.
throws:
  IllegalArgumentException - if the value is invalid.



setHost
public void setHost(String host)(Code)
Sets the host field. BNF (RFC3261, p. 222): host = hostname / IPv4address / IPv6reference See setMaddr() for the full BNF.
Parameters:
  host - the new host value



setHost
public void setHost(Host host)(Code)
Sets the host field.
Parameters:
  host - the new host value



setMaddr
public void setMaddr(String maddr) throws IllegalArgumentException(Code)
Sets the maddr parameter. BNF (RFC3261, p. 222, 232): via-maddr = "maddr" EQUAL host host = hostname / IPv4address / IPv6reference hostname = *( domainlabel "." ) toplabel [ "." ] domainlabel = alphanum / alphanum *( alphanum / "-" ) alphanum toplabel = ALPHA / ALPHA *( alphanum / "-" ) alphanum IPv4address = 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT IPv6reference = "[" IPv6address "]" IPv6address = hexpart [ ":" IPv4address ] hexpart = hexseq / hexseq "::" [ hexseq ] / "::" [ hexseq ] hexseq = hex4 *( ":" hex4) hex4 = 1*4HEXDIG IMPL_NOTE: check maddr for validity.
Parameters:
  maddr - the new maddr value.
throws:
  IllegalArgumentException - if the new maddr value is invalid.



setParameter
public void setParameter(String name, String value) throws IllegalArgumentException(Code)
This function is overloaded in order to validate the parameters. Sets the value of the specified parameter. If the parameter already had a value it will be overwritten. A zero-length String indicates flag parameter. IMPL_NOTE: add a support for all parameters that are stored as members of this class.
Parameters:
  name - a String specifying the parameter name
Parameters:
  value - a String specifying the parameter value
throws:
  IllegalArgumentException - if the parameter's name or its valueis invalid.



setPort
public void setPort(int port)(Code)
Sets the port field. BNF (RFC3261, p. 232): port = 1*DIGIT
Parameters:
  port - the new port value



setProtocolVersion
public void setProtocolVersion(String protocolVersion)(Code)
Sets the Protocol Version. BNF (RFC3261, p. 222, 232): protocol-version = token
Parameters:
  protocolVersion - String to set



setReceived
public void setReceived(String received) throws IllegalArgumentException(Code)
Sets the 'received' parameter. BNF (RFC3261, p. 223, 232): via-received = "received" EQUAL (IPv4address / IPv6address) IPv4address = 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT IPv6address = hexpart [ ":" IPv4address ] hexpart = hexseq / hexseq "::" [ hexseq ] / "::" [ hexseq ] hexseq = hex4 *( ":" hex4) hex4 = 1*4HEXDIG
Parameters:
  received - the new 'received' value.
throws:
  IllegalArgumentException - if the new 'received' value is invalid.



setSentBy
public void setSentBy(HostPort s)(Code)
Sets the sentBy member
Parameters:
  s - HostPort to set.



setSentProtocol
public void setSentProtocol(Protocol s)(Code)
Sets the sentProtocol member
Parameters:
  s - Protocol to set.



setTTL
public void setTTL(String strTTL) throws IllegalArgumentException(Code)
Sets the ttl parameter. BNF (RFC3261, p. 232): ttl = 1*3DIGIT ; 0 to 255
Parameters:
  strTTL - the new ttl value given in a string form.
throws:
  IllegalArgumentException - if the new ttl value is invalid.



setTransport
public void setTransport(String transport)(Code)
Sets the transport string. BNF (RFC3261, p. 222, 232): transport = "UDP" / "TCP" / "TLS" / "SCTP" / other-transport
Parameters:
  transport - String to set



Fields inherited from gov.nist.siplite.header.ParametersHeader
protected NameValueList parameters(Code)(Java Doc)

Methods inherited from gov.nist.siplite.header.ParametersHeader
abstract protected String encodeBody()(Code)(Java Doc)
protected String encodeWithSep()(Code)(Java Doc)
public NameValue getNameValue(String parameterName)(Code)(Java Doc)
public String getParameter(String name)(Code)(Java Doc)
protected boolean getParameterAsBoolean(String parameterName)(Code)(Java Doc)
protected int getParameterAsHexInt(String parameterName)(Code)(Java Doc)
protected int getParameterAsInt(String parameterName)(Code)(Java Doc)
protected long getParameterAsLong(String parameterName)(Code)(Java Doc)
protected URI getParameterAsURI(String parameterName)(Code)(Java Doc)
public Vector getParameterNames()(Code)(Java Doc)
public Object getParameterValue(String name)(Code)(Java Doc)
public NameValueList getParameters()(Code)(Java Doc)
public boolean hasParameter(String parameterName)(Code)(Java Doc)
public boolean hasParameters()(Code)(Java Doc)
public void removeParameter(String name)(Code)(Java Doc)
public void removeParameters()(Code)(Java Doc)
public void setParameter(String name, String value)(Code)(Java Doc)
protected void setParameter(String name, int value)(Code)(Java Doc)
protected void setParameter(String name, boolean value)(Code)(Java Doc)
protected void setParameter(String name, Object value)(Code)(Java Doc)
public void setParameter(NameValue nameValue)(Code)(Java Doc)
public void setParameters(NameValueList parameters)(Code)(Java Doc)
public void setQuotedParameter(String name, String value) throws ParseException(Code)(Java Doc)

Fields inherited from gov.nist.siplite.header.Header
final public static String ACCEPT(Code)(Java Doc)
final public static String ACCEPT_CONTACT(Code)(Java Doc)
final public static String ACCEPT_ENCODING(Code)(Java Doc)
final public static String ACCEPT_LANGUAGE(Code)(Java Doc)
final public static String ALERT_INFO(Code)(Java Doc)
final public static String ALLOW(Code)(Java Doc)
final public static String ALLOW_EVENTS(Code)(Java Doc)
final public static String AUTHENTICATION_INFO(Code)(Java Doc)
final public static String AUTHORIZATION(Code)(Java Doc)
final public static String CALL_ID(Code)(Java Doc)
final public static String CALL_INFO(Code)(Java Doc)
final public static String CONTACT(Code)(Java Doc)
final public static String CONTENT_DISPOSITION(Code)(Java Doc)
final public static String CONTENT_ENCODING(Code)(Java Doc)
final public static String CONTENT_LANGUAGE(Code)(Java Doc)
final public static String CONTENT_LENGTH(Code)(Java Doc)
final public static String CONTENT_TYPE(Code)(Java Doc)
final public static String CSEQ(Code)(Java Doc)
final public static String DATE(Code)(Java Doc)
final public static String ENCRYPTION(Code)(Java Doc)
final public static String ERROR_INFO(Code)(Java Doc)
final public static String EVENT(Code)(Java Doc)
final public static String EXPIRES(Code)(Java Doc)
final public static String EXTENSION(Code)(Java Doc)
final public static String FROM(Code)(Java Doc)
final public static String HIDE(Code)(Java Doc)
final public static String IN_REPLY_TO(Code)(Java Doc)
final public static String MAX_FORWARDS(Code)(Java Doc)
final public static String MIME_VERSION(Code)(Java Doc)
final public static String MIN_EXPIRES(Code)(Java Doc)
final public static String ORGANIZATION(Code)(Java Doc)
final public static String PRIORITY(Code)(Java Doc)
final public static String PROXY_AUTHENTICATE(Code)(Java Doc)
final public static String PROXY_AUTHORIZATION(Code)(Java Doc)
final public static String PROXY_REQUIRE(Code)(Java Doc)
final public static String RACK(Code)(Java Doc)
final public static String RECORD_ROUTE(Code)(Java Doc)
final public static String REFER_TO(Code)(Java Doc)
final public static String REQUIRE(Code)(Java Doc)
final public static String RESPONSE_KEY(Code)(Java Doc)
final public static String RETRY_AFTER(Code)(Java Doc)
final public static String ROUTE(Code)(Java Doc)
final public static String RSEQ(Code)(Java Doc)
final public static String SERVER(Code)(Java Doc)
final public static String SIP_ETAG(Code)(Java Doc)
final public static String SIP_IF_MATCH(Code)(Java Doc)
final public static String SUBJECT(Code)(Java Doc)
final public static String SUBSCRIPTION_STATE(Code)(Java Doc)
final public static String SUPPORTED(Code)(Java Doc)
final public static String TIMESTAMP(Code)(Java Doc)
final public static String TO(Code)(Java Doc)
final public static String UNSUPPORTED(Code)(Java Doc)
final public static String USER_AGENT(Code)(Java Doc)
final public static String VIA(Code)(Java Doc)
final public static String WARNING(Code)(Java Doc)
final public static String WARN_AGENT(Code)(Java Doc)
final public static String WWW_AUTHENTICATE(Code)(Java Doc)
public String headerName(Code)(Java Doc)
public String headerValue(Code)(Java Doc)
final public static String[] parameterLessHeaders(Code)(Java Doc)

Methods inherited from gov.nist.siplite.header.Header
public Object clone()(Code)(Java Doc)
public String encode()(Code)(Java Doc)
abstract protected String encodeBody()(Code)(Java Doc)
public static String encodeCalendar(Calendar date)(Code)(Java Doc)
public String getHeaderName()(Code)(Java Doc)
public String getHeaderValue()(Code)(Java Doc)
public String getName()(Code)(Java Doc)
abstract public NameValueList getParameters()(Code)(Java Doc)
public static byte getStringHash(String s)(Code)(Java Doc)
abstract public Object getValue()(Code)(Java Doc)
public static boolean isAuthorization(String name)(Code)(Java Doc)
public static boolean isParameterLess(String name)(Code)(Java Doc)
public static boolean isReliableTagPresent(String strOptionTags)(Code)(Java Doc)
public void setHeaderName(String name)(Code)(Java Doc)
public void setHeaderValue(String value)(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Methods inherited from gov.nist.core.GenericObject
abstract public Object clone()(Code)(Java Doc)
public static int compareToIgnoreCase(String s1, String s2)(Code)(Java Doc)
abstract public String encode()(Code)(Java Doc)
public static boolean equalsIgnoreCase(String s1, String s2)(Code)(Java Doc)

Methods inherited from java.lang.Object
public boolean equals(Object obj)(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.