NIST SIP Parser and Stack (v1.2) API

gov.nist.javax.sip.header
Class Require

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

public class Require
extends SIPHeader
implements RequireHeader

Require SIP Header.

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

Field Summary
 
Fields inherited from interface javax.sip.header.RequireHeader
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
Require()
          Default constructor
Require(String s)
          constructor
 
Method Summary
 String encodeBody()
          Encode in canonical form.
 String getOptionTag()
          Gets the option tag of this OptionTag class.
 void setOptionTag(String optionTag)
          Sets the option tag value to the new supplied optionTag parameter.
 
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

Require

public Require()
Default constructor


Require

public Require(String s)
constructor

Parameters:
s - String to set
Method Detail

encodeBody

public String encodeBody()
Encode in canonical form.

Overrides:
encodeBody in class SIPHeader
Returns:
String

setOptionTag

public void setOptionTag(String optionTag)
                  throws ParseException
Sets the option tag value to the new supplied optionTag parameter.

Specified by:
setOptionTag in interface OptionTag
Parameters:
optionTag - - the new string value of the option tag.
Throws:
ParseException - which signals that an error has been reached unexpectedly while parsing the optionTag value.

getOptionTag

public String getOptionTag()
Gets the option tag of this OptionTag class.

Specified by:
getOptionTag in interface OptionTag
Returns:
the string that identifies the option tag 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.