javax.sip.header
Interface PriorityHeader

All Superinterfaces:

java.lang.Cloneable, Header, java.io.Serializable

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

Field Summary

static java.lang.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 java.lang.String	NAME Name of PriorityHeader
static java.lang.String	NON_URGENT Non-urgent priority constant
static java.lang.String	NORMAL Normal priority constant
static java.lang.String	URGENT Urgent priority constant

Method Summary

java.lang.String	getPriority() Gets the string priority value of the PriorityHeader.
void	setPriority(java.lang.String priority) Set priority of PriorityHeader

Methods inherited from interface javax.sip.header.Header

clone, equals, getName, toString

Field Detail

URGENT

public static final java.lang.String URGENT

Urgent priority constant

See Also:

Constant Field Values

NORMAL

public static final java.lang.String NORMAL

Normal priority constant

See Also:

Constant Field Values

NON_URGENT

public static final java.lang.String NON_URGENT

Non-urgent priority constant

See Also:

Constant Field Values

EMERGENCY

public static final java.lang.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

public static final java.lang.String NAME

Name of PriorityHeader

See Also:

Constant Field Values

Method Detail

setPriority

public void setPriority(java.lang.String priority)
                 throws java.text.ParseException

Set priority of PriorityHeader

Parameters:

priority - - the new string priority value

Throws:

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

getPriority

public java.lang.String getPriority()

Gets the string priority value of the PriorityHeader.

Returns:

the string priority value of the PriorityHeader