NIST SIP Parser and Stack (v1.2) API

gov.nist.javax.sip.header
Class SIPHeader

java.lang.Object
  |
  +--gov.nist.core.GenericObject
        |
        +--gov.nist.javax.sip.header.SIPObject
              |
              +--gov.nist.javax.sip.header.SIPHeader
All Implemented Interfaces:
Cloneable, Header, Serializable, SIPHeaderNames
Direct Known Subclasses:
Allow, AllowEvents, CallID, ContentEncoding, ContentLanguage, ContentLength, CSeq, Expires, ExtensionHeaderImpl, InReplyTo, MaxForwards, MimeVersion, MinExpires, Organization, ParametersHeader, Priority, ProxyRequire, RAck, Require, RSeq, Server, SIPDateHeader, SIPHeaderList, Subject, Supported, TimeStamp, Unsupported, UserAgent, Warning

public abstract class SIPHeader
extends SIPObject
implements SIPHeaderNames, Header

Root class from which all SIPHeader objects are subclassed.

Author:
M. Ranganathan
This code is in the public domain.
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface gov.nist.javax.sip.header.SIPHeaderNames
ACCEPT, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ALERT_INFO, ALLOW, ALLOW_EVENTS, AUTHENTICATION_INFO, AUTHORIZATION, CALL_ID, CALL_INFO, CONTACT, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CSEQ, DATE, ERROR_INFO, EVENT, EXPIRES, FROM, IN_REPLY_TO, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE
 
Constructor Summary
SIPHeader()
          Default constructor
 
Method Summary
 String encode()
          Encode this header into canonical form.
 String getHeaderName()
          Name of the SIPHeader
 String getHeaderValue()
          Get the header value (i.e. what follows the name:).
 String getName()
          Alias for getHaderName above.
 String getValue()
          Alias for getHeaderValue.
 boolean isHeaderList()
          Return false if this is not a header list (SIPHeaderList overrrides this method).
 void setHeaderName(String hdrname)
          Set the name of the header .
 
Methods inherited from class gov.nist.javax.sip.header.SIPObject
clone, dbgPrint, debugDump, debugDump, equals, match, merge, replace, replace, replace, replace, toString
 
Methods inherited from class gov.nist.core.GenericObject
getClassFromName, getMatcher, isMySubclass, setMatcher
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.sip.header.Header
clone, equals, toString
 

Constructor Detail

SIPHeader

public SIPHeader()
Default constructor

Method Detail

getHeaderName

public String getHeaderName()
Name of the SIPHeader

Returns:
String

getName

public String getName()
Alias for getHaderName above.

Specified by:
getName in interface Header
Returns:
String headerName

setHeaderName

public void setHeaderName(String hdrname)
Set the name of the header .

Parameters:
hdrname - String to set

getHeaderValue

public String getHeaderValue()
Get the header value (i.e. what follows the name:). This merely goes through and lops off the portion that follows the headerName:


isHeaderList

public boolean isHeaderList()
Return false if this is not a header list (SIPHeaderList overrrides this method).

Returns:
false

encode

public String encode()
Encode this header into canonical form.

Specified by:
encode in class SIPObject
Returns:
String

getValue

public String getValue()
Alias for getHeaderValue.


NIST SIP Parser and Stack (v1.2) API

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Get the latest distribution.
Submit a bug report or feature request.