javax.sip.header

Interface PriorityHeader

All Superinterfaces:

Cloneable, Header, Serializable

All Known Implementing Classes:

Priority

public interface PriorityHeader
extends Header

The Priority header field indicates the urgency of the request as perceived by the client. The Priority header field describes the priority that the SIP request should have to the receiving human or its agent. For example, it may be factored into decisions about call routing and acceptance. For these decisions, a message containing no Priority header field SHOULD be treated as if it specified a Priority of "Normal".

The Priority header field does not influence the use of communications resources such as packet forwarding priority in routers or access to circuits in PSTN gateways.

The currently defined priority values are:

• EMERGENCY
• URGENT
• NORMAL
• NON_URGENT

For Example:
Subject: Weekend plans
Priority: non-urgent

Version:

1.2

Author:

BEA Systems, NIST

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMERGENCY Emergency priority constant - It is RECOMMENDED that the value of "emergency" only be used when life, limb, or property are in imminent danger.
static String	NAME Name of PriorityHeader
static String	NON_URGENT Non-urgent priority constant
static String	NORMAL Normal priority constant
static String	URGENT Urgent priority constant

Method Summary

Methods

Modifier and Type	Method and Description
String	getPriority() Gets the string priority value of the PriorityHeader.
void	setPriority(String priority) Set priority of PriorityHeader

Methods inherited from interface javax.sip.header.Header

clone, equals, getName, hashCode, toString

Field Detail

URGENT

static final String URGENT

Urgent priority constant

See Also:

Constant Field Values

NORMAL

static final String NORMAL

Normal priority constant

See Also:

Constant Field Values

NON_URGENT

static final String NON_URGENT

Non-urgent priority constant

See Also:

Constant Field Values

EMERGENCY

static final String EMERGENCY

Emergency priority constant - It is RECOMMENDED that the value of "emergency" only be used when life, limb, or property are in imminent danger. Otherwise, there are no semantics defined for this header field.

See Also:

Constant Field Values

NAME

static final String NAME

Name of PriorityHeader

See Also:

Constant Field Values

Method Detail

setPriority

void setPriority(String priority)
                 throws ParseException

Set priority of PriorityHeader

Parameters:

priority - - the new string priority value

Throws:

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

getPriority

String getPriority()

Gets the string priority value of the PriorityHeader.

Returns:

the string priority value of the PriorityHeader