JAIN-SIP 2.0 API

javax.sip.header
Interface ReplacesHeader

All Superinterfaces:
Cloneable, Header, Parameters, Serializable

public interface ReplacesHeader
extends Parameters, Header

Defines an interface for the SIP Replaces Header as defined in RFC 3891. The Replaces header is used to logically replace an existing SIP dialog with a new SIP dialog. This primitive can be used to enable a variety of features, for example: "Attended Transfer" and "Call Pickup".

Since:
2.0
Version:
2.0
Author:
Oracle Inc., NIST

Field Summary
static String NAME
          The header NAME.
 
Method Summary
 String getCallId()
          get the previously set call Id or Null if nothing has been set.
 String getFromTag()
          Get the previously set From tag or Null if no tag set.
 String getToTag()
          Get the previously set to tag or Null if no tag set.
 void setCallId(String callId)
          Set the CallId of the Replaces header.
 void setFromTag(String tag)
          Set the From tag of the Replaces header.
 void setToTag(String tag)
          set the to tag of the Replaces header.
 
Methods inherited from interface javax.sip.header.Parameters
getParameter, getParameter, getParameterNames, removeParameter, setParameter
 
Methods inherited from interface javax.sip.header.Header
clone, equals, getName, getValue, hashCode, toString
 

Field Detail

NAME

static final String NAME
The header NAME.

See Also:
Constant Field Values
Method Detail

setToTag

void setToTag(String tag)
              throws ParseException,
                     NullPointerException
set the to tag of the Replaces header.

Parameters:
tag - - the tag to set.
Throws:
NullPointerException - if null tag is set.
ParseException - if invalid characters are in the tag.

setFromTag

void setFromTag(String tag)
                throws ParseException,
                       NullPointerException
Set the From tag of the Replaces header.

Parameters:
tag - - the tag to set.
Throws:
NullPointerException - if null tag is set.
ParseException - if invalid characters are in the tag.

getToTag

String getToTag()
Get the previously set to tag or Null if no tag set.


getFromTag

String getFromTag()
Get the previously set From tag or Null if no tag set.


setCallId

void setCallId(String callId)
               throws ParseException,
                      NullPointerException
Set the CallId of the Replaces header.

Parameters:
callId - - the callId to set.
Throws:
NullPointerException - if null tag is set.
ParseException - if invalid characters are in the tag.

getCallId

String getCallId()
get the previously set call Id or Null if nothing has been set.


JAIN-SIP 2.0 API


See conditions of use.
Submit a bug report or feature request.