javax.sip.header

Interface ErrorInfoHeader

All Superinterfaces:

Cloneable, Header, Parameters, Serializable

All Known Implementing Classes:

ErrorInfo

public interface ErrorInfoHeader
extends Parameters, Header

The Error-Info header field provides a pointer to additional information about the error status response. SIP UACs have user interface capabilities ranging from pop-up windows and audio on PC softclients to audio-only on "black" phones or endpoints connected via gateways. Rather than forcing a server generating an error to choose between sending an error status code with a detailed reason phrase and playing an audio recording, the Error-Info header field allows both to be sent. The UAC then has the choice of which error indicator to render to the caller.

A UAC MAY treat a SIP or SIPS URI in an Error-Info header field as if it were a Contact in a redirect and generate a new INVITE, resulting in a recorded announcement session being established. A non-SIP URI MAY be rendered to the user.

Examples:
SIP/2.0 404 The number you have dialed is not in service
Error-Info: sip:[email protected]

Version:

1.2

Author:

BEA Systems, NIST

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Name of the ErroInfoHeader

Method Summary

Methods

Modifier and Type	Method and Description
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 interface javax.sip.header.Parameters

getParameter, getParameterNames, removeParameter, setParameter

Methods inherited from interface javax.sip.header.Header

clone, equals, getName, hashCode, toString

Field Detail

NAME

static final String NAME

Name of the ErroInfoHeader

See Also:

Constant Field Values

Method Detail

setErrorInfo

void setErrorInfo(URI errorInfo)

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

Parameters:

errorInfo - the new ErrorInfo of this ErrorInfoHeader.

getErrorInfo

URI getErrorInfo()

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

Returns:

the URI representing the ErrorInfo.

setErrorMessage

void setErrorMessage(String message)
                     throws ParseException

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

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

String getErrorMessage()

Get the Error information message of this ErrorInfoHeader.

Returns:

the stringified version of the ErrorInfo header.