NIST SIP Parser and Stack (v1.2) API

gov.nist.javax.sip.header
Class UserAgent

java.lang.Object
  |
  +--gov.nist.core.GenericObject
        |
        +--gov.nist.javax.sip.header.SIPObject
              |
              +--gov.nist.javax.sip.header.SIPHeader
                    |
                    +--gov.nist.javax.sip.header.UserAgent
All Implemented Interfaces:
Cloneable, Header, Serializable, SIPHeaderNames, UserAgentHeader

public class UserAgent
extends SIPHeader
implements UserAgentHeader

the UserAgent SIPObject.

Author:
Olivier Deruelle
This code is in the public domain.
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface javax.sip.header.UserAgentHeader
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
UserAgent()
          Constructor.
 
Method Summary
 void addProductToken(String pt)
          set the productToken field
 String encodeBody()
          Encode only the body of this header.
 ListIterator getProduct()
          Returns the list value of the product parameter.
 void setProduct(List product)
          Sets the product value of the UserAgentHeader.
 
Methods inherited from class gov.nist.javax.sip.header.SIPHeader
encode, getHeaderName, getHeaderValue, getName, getValue, isHeaderList, setHeaderName
 
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, getName, toString
 

Constructor Detail

UserAgent

public UserAgent()
Constructor.

Method Detail

addProductToken

public void addProductToken(String pt)
set the productToken field

Parameters:
pt - String to set

encodeBody

public String encodeBody()
Encode only the body of this header.

Overrides:
encodeBody in class SIPHeader
Returns:
encoded value of the header.

getProduct

public ListIterator getProduct()
Returns the list value of the product parameter.

Specified by:
getProduct in interface UserAgentHeader
Returns:
the software of this UserAgentHeader

setProduct

public void setProduct(List product)
                throws ParseException
Sets the product value of the UserAgentHeader.

Specified by:
setProduct in interface UserAgentHeader
Parameters:
product - - a List specifying the product value
Throws:
ParseException - which signals that an error has been reached unexpectedly while parsing the product value.

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.