javax.sip.header

Interface CallInfoHeader

All Superinterfaces:

Cloneable, Header, Parameters, Serializable

All Known Implementing Classes:

CallInfo

public interface CallInfoHeader
extends Parameters, Header

The Call-Info header field provides additional information about the caller or callee, depending on whether it is found in a request or response. The purpose of the URI is described by the "purpose" parameter. The "icon" purpose designates an image suitable as an iconic representation of the caller or callee. The "info" purpose describes the caller or callee in general, for example, through a web page. The "card" purpose provides a business card, for example, in vCard or LDIF formats.

Use of the Call-Info header field can pose a security risk. If a callee fetches the URIs provided by a malicious caller, the callee may be at risk for displaying inappropriate or offensive content, dangerous or illegal content, and so on. Therefore, it is RECOMMENDED that a User Agent only render the information in the Call-Info header field if it can verify the authenticity of the element that originated the header field and trusts that element. This need not be the peer User Agent; a proxy can insert this header field into requests.

For Example:
Call-Info: http://jcp.org/duke/photo.jpg;
purpose=icon, http://jcp.org/duke/; purpose=info

Version:

1.2

Author:

BEA Systems, NIST

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Name of CallInfoHeader

Method Summary

Methods

Modifier and Type	Method and Description
URI	getInfo() Gets the URI that represents the location of the info of the caller or callee.
String	getPurpose() Gets the purpose of the information supplied in this CallInfoHeader.
void	setInfo(URI info) Sets the Information parameter of this CallInfoHeader.
void	setPurpose(String purpose) Sets the purpose parameter of the info of this CallInfoHeader.

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 CallInfoHeader

See Also:

Constant Field Values

Method Detail

setInfo

void setInfo(URI info)

Sets the Information parameter of this CallInfoHeader. The Information describes the caller or callee.

Parameters:

info - the new URI value of the location of the information.

getInfo

URI getInfo()

Gets the URI that represents the location of the info of the caller or callee.

Returns:

the location of the info of this CallInfoHeader, returns null if no info is present.

setPurpose

void setPurpose(String purpose)
                throws ParseException

Sets the purpose parameter of the info of this CallInfoHeader.

Parameters:

purpose - - the new string value of the purpose of this info.

Throws:

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

getPurpose

String getPurpose()

Gets the purpose of the information supplied in this CallInfoHeader.

Returns:

the sting value of the purpose of the info, returns null if no purpose is present.