|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ErrorInfoHeader
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:not-in-service-recording@atlanta.com
Field Summary | |
---|---|
static java.lang.String |
NAME
Name of the ErroInfoHeader |
Method Summary | |
---|---|
URI |
getErrorInfo()
Returns the ErrorInfo value of this ErrorInfoHeader. |
java.lang.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(java.lang.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 |
---|
static final java.lang.String NAME
Method Detail |
---|
void setErrorInfo(URI errorInfo)
errorInfo
- the new ErrorInfo of this ErrorInfoHeader.URI getErrorInfo()
void setErrorMessage(java.lang.String message) throws java.text.ParseException
message
- - the new string value that represents the error message.
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the error message.java.lang.String getErrorMessage()
|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |