NIST SIP Parser and Stack (v1.2) API

gov.nist.javax.sip.header
Class From

java.lang.Object
  |
  +--gov.nist.core.GenericObject
        |
        +--gov.nist.javax.sip.header.SIPObject
              |
              +--gov.nist.javax.sip.header.SIPHeader
                    |
                    +--gov.nist.javax.sip.header.ParametersHeader
                          |
                          +--gov.nist.javax.sip.header.AddressParametersHeader
                                |
                                +--gov.nist.javax.sip.header.From
All Implemented Interfaces:
Cloneable, FromHeader, Header, HeaderAddress, Parameters, Serializable, SIPHeaderNames

public final class From
extends AddressParametersHeader
implements FromHeader

From SIP Header.

Version:
JAIN-SIP-1.1
Author:
M. Ranganathan
This code is in the public domain.
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface javax.sip.header.FromHeader
NAME
 
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
From()
          Default constructor
From(To to)
          Generate a FROM header from a TO header
 
Method Summary
 String encode()
          Encode the header into a String.
 boolean equals(Object otherHeader)
          Compare two To headers for equality.
 String getDisplayName()
          Get the display name from the address.
 HostPort getHostPort()
          Conveniance accessor function to get the hostPort field from the address.
 String getTag()
          Get the tag parameter from the address parm list.
 String getUserAtHostPort()
          Get the user@host port string.
 boolean hasTag()
          Boolean function
 void removeTag()
          remove Tag member
 void setAddress(Address address)
          Set the address member
 void setTag(String t)
          Set the tag member
 String toString()
          Gets a string representation of the Header.
 
Methods inherited from class gov.nist.javax.sip.header.AddressParametersHeader
getAddress
 
Methods inherited from class gov.nist.javax.sip.header.ParametersHeader
getParameter, getParameterNames, getParameters, getParameterValue, hasParameter, hasParameters, removeParameter, removeParameters, setParameter, setParameter, setParameters, setQuotedParameter
 
Methods inherited from class gov.nist.javax.sip.header.SIPHeader
getHeaderName, getHeaderValue, getName, getValue, isHeaderList, setHeaderName
 
Methods inherited from class gov.nist.javax.sip.header.SIPObject
clone, dbgPrint, debugDump, debugDump, match, merge, replace, replace, replace, replace
 
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.HeaderAddress
getAddress
 
Methods inherited from interface javax.sip.header.Parameters
getParameter, getParameterNames, removeParameter, setParameter
 
Methods inherited from interface javax.sip.header.Header
clone, getName
 

Constructor Detail

From

public From()
Default constructor


From

public From(To to)
Generate a FROM header from a TO header

Method Detail

equals

public boolean equals(Object otherHeader)
Compare two To headers for equality.

Specified by:
equals in interface Header
Overrides:
equals in class SIPObject
Parameters:
otherHeader - Object to set
Returns:
true if the two headers are the same.

encode

public String encode()
Encode the header into a String.

Overrides:
encode in class SIPHeader
Returns:
String

getHostPort

public HostPort getHostPort()
Conveniance accessor function to get the hostPort field from the address. Warning -- this assumes that the embedded URI is a SipURL.

Returns:
hostport field

getDisplayName

public String getDisplayName()
Get the display name from the address.

Returns:
Display name

getTag

public String getTag()
Get the tag parameter from the address parm list.

Specified by:
getTag in interface FromHeader
Returns:
tag field

hasTag

public boolean hasTag()
Boolean function

Returns:
true if the Tag exist

removeTag

public void removeTag()
remove Tag member


setAddress

public void setAddress(Address address)
Set the address member

Specified by:
setAddress in interface HeaderAddress
Overrides:
setAddress in class AddressParametersHeader
Parameters:
address - Address to set

setTag

public void setTag(String t)
            throws ParseException
Set the tag member

Specified by:
setTag in interface FromHeader
Parameters:
t - tag to set. From tags are mandatory.
Throws:
ParseException - which signals that an error has been reached unexpectedly while parsing the Tag value.

getUserAtHostPort

public String getUserAtHostPort()
Get the user@host port string.


toString

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

Specified by:
toString in interface Header
Overrides:
toString in class SIPObject
Returns:
string representation of Header

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.