|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WarningHeader
The Warning header field is used to carry additional information about the status of a response. Warning header field values are sent with responses and contain a three-digit warning code, agent name, and warning text.
When multiple WarningHeaders are attached to a Response, the user agent should display as many of them as possible, in the order that they appear in the Response. If it is not possible to display all of the warnings, the user agent first displays warnings that appear early in the Response.
Examples of using Warning Headers are as follows:
Warning: 307 isi.edu "Session parameter 'foo' not understood"
Field Summary | |
---|---|
static int |
ATTRIBUTE_NOT_UNDERSTOOD
One or more of the media attributes in the session description are not supported. |
static int |
INCOMPATIBLE_BANDWIDTH_UNITS
One or more bandwidth measurement units contained in the session description were not understood. |
static int |
INCOMPATIBLE_MEDIA_FORMAT
One or more media formats contained in the session description are not available. |
static int |
INCOMPATIBLE_NETWORK_ADDRESS_FORMATS
One or more network address formats contained in the session description are not available. |
static int |
INCOMPATIBLE_NETWORK_PROTOCOL
One or more network protocols contained in the session description are not available. |
static int |
INCOMPATIBLE_TRANSPORT_PROTOCOL
One or more transport protocols described in the session description are not available. |
static int |
INSUFFICIENT_BANDWIDTH
The bandwidth specified in the session description or defined by the media exceeds that known to be available. |
static int |
MEDIA_TYPE_NOT_AVAILABLE
One or more media types contained in the session description are not available. |
static int |
MISCELLANEOUS_WARNING
The warning text can include arbitrary information to be presented to a human user, or logged. |
static int |
MULTICAST_NOT_AVAILABLE
The site where the user is located does not support multicast. |
static java.lang.String |
NAME
Name of WarningHeader |
static int |
SESSION_DESCRIPTION_PARAMETER_NOT_UNDERSTOOD
A parameter other than those listed above was not understood. |
static int |
UNICAST_NOT_AVAILABLE
The site where the user is located does not support unicast communication (usually due to the presence of a firewall). |
Method Summary | |
---|---|
java.lang.String |
getAgent()
Gets the agent of the server that created this WarningHeader. |
int |
getCode()
Gets the code of the WarningHeader. |
java.lang.String |
getText()
Gets text of WarningHeader. |
void |
setAgent(java.lang.String agent)
Sets the agent value of the WarningHeader to the new value passed to the method. |
void |
setCode(int code)
Sets the code of the WarningHeader. |
void |
setText(java.lang.String text)
Sets the text of WarningHeader to the newly supplied text value. |
Methods inherited from interface javax.sip.header.Header |
---|
clone, equals, getName, hashCode, toString |
Field Detail |
---|
static final java.lang.String NAME
static final int INCOMPATIBLE_NETWORK_PROTOCOL
static final int INCOMPATIBLE_NETWORK_ADDRESS_FORMATS
static final int INCOMPATIBLE_TRANSPORT_PROTOCOL
static final int INCOMPATIBLE_BANDWIDTH_UNITS
static final int MEDIA_TYPE_NOT_AVAILABLE
static final int INCOMPATIBLE_MEDIA_FORMAT
static final int ATTRIBUTE_NOT_UNDERSTOOD
static final int SESSION_DESCRIPTION_PARAMETER_NOT_UNDERSTOOD
static final int MULTICAST_NOT_AVAILABLE
static final int UNICAST_NOT_AVAILABLE
static final int INSUFFICIENT_BANDWIDTH
static final int MISCELLANEOUS_WARNING
Method Detail |
---|
java.lang.String getAgent()
void setAgent(java.lang.String agent) throws java.text.ParseException
agent
- - the new agent value of WarningHeader
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the agent value.java.lang.String getText()
void setText(java.lang.String text) throws java.text.ParseException
text
- - the new text value of the Warning Header.
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the text value.void setCode(int code) throws InvalidArgumentException
code
- - the new code that defines the warning code.
InvalidArgumentException
- if an invalid integer code is given for
the WarningHeader.int getCode()
|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |