gov.nist.javax.sip.header
Class ErrorInfo

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.ErrorInfo

All Implemented Interfaces:

Cloneable, ErrorInfoHeader, Header, Parameters, Serializable, SIPHeaderNames

public final class ErrorInfo

extends ParametersHeader

implements ErrorInfoHeader

ErrorInfo SIP Header.

Since:

1.1

Version:

1.2 $Revision: 1.5 $ $Date: 2006/07/13 09:01:24 $

Author:

M. Ranganathan
, Olivier Deruelle

See Also:

Serialized Form

Field Summary

Fields inherited from interface javax.sip.header.ErrorInfoHeader

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, 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

ErrorInfo()
Default constructor.

ErrorInfo(GenericURI errorInfo)
Constructor given the error info

Method Summary

Object	clone() Creates and returns a deep copy of the Header.
String	encodeBody() Encode into canonical form.
URI	getErrorInfo() Returns the ErrorInfo value of this ErrorInfoHeader.
String	getErrorMessage() Get the Error information message of this ErrorInfoHeader.
void	setErrorInfo(URI errorInfo) Sets the ErrorInfo of the ErrorInfoHeader to the errorInfo parameter value.
void	setErrorMessage(String message) Sets the Error information message to the new message value supplied to this method.

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

getNameValue, getParameter, getParameterNames, getParameters, getParameterValue, hasParameter, hasParameters, removeParameter, removeParameters, setParameter, setParameter, setParameters, setQuotedParameter

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

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

getClassFromName, getMatcher, isMySubclass, makeClone, merge, setMatcher

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.sip.header.Parameters

getParameter, getParameterNames, removeParameter, setParameter

Methods inherited from interface javax.sip.header.Header

equals, getName, hashCode, toString

Constructor Detail

ErrorInfo

public ErrorInfo()

Default constructor.

ErrorInfo

public ErrorInfo(GenericURI errorInfo)

Constructor given the error info

Parameters:

errorInfo - -- the error information to set.

Method Detail

encodeBody

public String encodeBody()

Encode into canonical form.

Returns:

String

setErrorInfo

public void setErrorInfo(URI errorInfo)

Sets the ErrorInfo of the ErrorInfoHeader to the errorInfo parameter value.

Specified by:

setErrorInfo in interface ErrorInfoHeader

Parameters:

errorInfo - the new ErrorInfo of this ErrorInfoHeader.

getErrorInfo

public URI getErrorInfo()

Returns the ErrorInfo value of this ErrorInfoHeader. This message may return null if a String message identifies the ErrorInfo.

Specified by:

getErrorInfo in interface ErrorInfoHeader

Returns:

the URI representing the ErrorInfo.

setErrorMessage

public void setErrorMessage(String message)
                     throws ParseException

Sets the Error information message to the new message value supplied to this method.

Specified by:

setErrorMessage in interface ErrorInfoHeader

Parameters:

message - - the new string value that represents the error message.

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the error message.

getErrorMessage

public String getErrorMessage()

Get the Error information message of this ErrorInfoHeader.

Specified by:

getErrorMessage in interface ErrorInfoHeader

Returns:

the stringified version of the ErrorInfo header.

clone

public Object clone()

Description copied from interface: Header

Creates and returns a deep copy of the Header. This methods must ensure a deep copy of the Header, so that when a message is cloned the Header can be modified without effecting the original Header in the message. This provides useful functionality for proxying Requests and Responses, for example:

• Recieve a message.
• Create a deep clone of the message and headers.
• Modify necessary headers.
• Proxy the message using the send methods on the SipProvider.

This method overrides the clone method in java.lang.Object.

Specified by:

clone in interface Header

Overrides:

clone in class ParametersHeader