gov.nist.javax.sip.header

Class Warning

java.lang.Object

gov.nist.core.GenericObject

gov.nist.javax.sip.header.SIPObject

gov.nist.javax.sip.header.SIPHeader

gov.nist.javax.sip.header.Warning

All Implemented Interfaces:

HeaderExt, SIPHeaderNames, Serializable, Cloneable, Header, WarningHeader

public class Warning
extends SIPHeader
implements WarningHeader

the WarningValue SIPObject.

Version:

1.2 $Revision: 1.9 $ $Date: 2010-05-06 14:07:55 $

Author:

M. Ranganathan
, Olivier Deruelle

See Also:

SIPHeader which strings these together., Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	agent the name or pseudonym of the server adding the Warning header, for use in debugging
protected int	code warn code field, the warn code consists of three digits.
protected String	text warn-text field

Fields inherited from class gov.nist.javax.sip.header.SIPHeader

headerName

Fields inherited from class gov.nist.core.GenericObject

AND, AT, COLON, COMMA, DOT, DOUBLE_QUOTE, EQUALS, GREATER_THAN, HT, immutableClasses, indentation, LESS_THAN, LPAREN, matchExpression, NEWLINE, PERCENT, POUND, QUESTION, QUOTE, RETURN, RPAREN, SEMICOLON, SLASH, SP, STAR, stringRepresentation

Fields inherited from interface javax.sip.header.WarningHeader

ATTRIBUTE_NOT_UNDERSTOOD, INCOMPATIBLE_BANDWIDTH_UNITS, INCOMPATIBLE_MEDIA_FORMAT, INCOMPATIBLE_NETWORK_ADDRESS_FORMATS, INCOMPATIBLE_NETWORK_PROTOCOL, INCOMPATIBLE_TRANSPORT_PROTOCOL, INSUFFICIENT_BANDWIDTH, MEDIA_TYPE_NOT_AVAILABLE, MISCELLANEOUS_WARNING, MULTICAST_NOT_AVAILABLE, NAME, SESSION_DESCRIPTION_PARAMETER_NOT_UNDERSTOOD, UNICAST_NOT_AVAILABLE

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, JOIN, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, MIN_SE, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REFERRED_BY, REPLACES, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SESSION_EXPIRES, SIP_ETAG, SIP_IF_MATCH, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE

Constructor Summary

Constructors

Constructor and Description
Warning() constructor.

Method Summary

Methods

Modifier and Type	Method and Description
StringBuilder	encodeBody(StringBuilder buffer) Encode the body of the header (return the stuff following name:).
String	getAgent() Gets agent host of WarningHeader
int	getCode() Gets code of WarningHeader
String	getText() Gets text of WarningHeader
void	setAgent(String host) Sets host of WarningHeader
void	setCode(int code) Sets code of WarningHeader
void	setText(String text) Sets text of WarningHeader

Methods inherited from class gov.nist.javax.sip.header.SIPHeader

encode, encode, getHeaderName, getHeaderValue, getName, getValue, hashCode, isHeaderList, setHeaderName, toString

Methods inherited from class gov.nist.javax.sip.header.SIPObject

dbgPrint, debugDump, debugDump, equals, match

Methods inherited from class gov.nist.core.GenericObject

clone, dbgPrint, getClassFromName, getIndentation, getMatcher, isMySubclass, makeClone, merge, setMatcher, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint

Methods inherited from class java.lang.Object

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.sip.header.Header

clone, equals, getName, hashCode, toString

Field Detail

code

protected int code

warn code field, the warn code consists of three digits.

agent

protected String agent

the name or pseudonym of the server adding the Warning header, for use in debugging

text

protected String text

warn-text field

Constructor Detail

Warning

public Warning()

constructor.

Method Detail

encodeBody

public StringBuilder encodeBody(StringBuilder buffer)

Encode the body of the header (return the stuff following name:).

Specified by:

encodeBody in class SIPHeader

Returns:

the string encoding of the header value.

getCode

public int getCode()

Gets code of WarningHeader

Specified by:

getCode in interface WarningHeader

Returns:

code of WarningHeader

getAgent

public String getAgent()

Gets agent host of WarningHeader

Specified by:

getAgent in interface WarningHeader

Returns:

agent host of WarningHeader

getText

public String getText()

Gets text of WarningHeader

Specified by:

getText in interface WarningHeader

Returns:

text of WarningHeader

setCode

public void setCode(int code)
             throws InvalidArgumentException

Sets code of WarningHeader

Specified by:

setCode in interface WarningHeader

Parameters:

code - int to set

Throws:

SipParseException - if code is not accepted by implementation

InvalidArgumentException - if an invalid integer code is given for the WarningHeader.

setAgent

public void setAgent(String host)
              throws ParseException

Sets host of WarningHeader

Specified by:

setAgent in interface WarningHeader

Parameters:

host - String to set

Throws:

ParseException - if host is not accepted by implementation

setText

public void setText(String text)
             throws ParseException

Sets text of WarningHeader

Specified by:

setText in interface WarningHeader

Parameters:

text - String to set

Throws:

ParseException - if text is not accepted by implementation