jain.protocol.ip.sip.header
Class RouteHeader

java.lang.Object
  |
  +--jain.protocol.ip.sip.header.Header
        |
        +--jain.protocol.ip.sip.header.RequestHeader
              |
              +--jain.protocol.ip.sip.header.RouteHeader

public final class RouteHeader

extends RequestHeader

This class represents the Route request-header. RouteHeaders determine the route taken by a RequestMessage. Each host removes the first entry and then proxies the RequestMessage to the host listed in that entry, also using it as the RequestURI. The operation is further described in RecordRouteHeader.

Version:

0.6

See Also:

RecordRouteHeader

Field Summary

static java.lang.String

token Token of RouteHeader

Fields inherited from class jain.protocol.ip.sip.header.Header

ENTITY_HEADER, GENERAL_HEADER, REQUEST_HEADER, RESPONSE_HEADER

Constructor Summary

RouteHeader(NameAddress nameAddress)
Creates a RouteHeader based on given NameAddresss

Method Summary

java.lang.Object	clone() Creates and returns a copy of RouteHeader
boolean	equals(RouteHeader routeHeader) Indicates whether some other RouteHeader is "equal to" this one
NameAddress	getNameAddress() Gets NameAddress of RouteHeader
java.lang.String	getValue() Gets value of RouteHeader
void	setNameAddress(NameAddress nameAddress) Sets NameAddress of RouteHeader

Methods inherited from class jain.protocol.ip.sip.header.Header

equals, getHeaderType, getToken, setValue, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

token

public static final java.lang.String token

Token of RouteHeader

Constructor Detail

RouteHeader

public RouteHeader(NameAddress nameAddress)
            throws java.lang.IllegalArgumentException

Creates a RouteHeader based on given NameAddresss

Parameters:

nameAddress - NameAddress

Throws:

java.lang.IllegalArgumentException - if nameAddress is null

Method Detail

getNameAddress

public NameAddress getNameAddress()

Gets NameAddress of RouteHeader

Returns:

NameAddress of RouteHeader

setNameAddress

public void setNameAddress(NameAddress nameAddress)
                    throws java.lang.IllegalArgumentException

Sets NameAddress of RouteHeader

Parameters:

nameAddress - NameAddress

Throws:

java.lang.IllegalArgumentException - if nameAddress is null

getValue

public java.lang.String getValue()

Gets value of RouteHeader

Overrides:

getValue in class Header

Returns:

value of RouteHeader

clone

public java.lang.Object clone()

Creates and returns a copy of RouteHeader

Overrides:

clone in class Header

equals

public boolean equals(RouteHeader routeHeader)

Indicates whether some other RouteHeader is "equal to" this one

Parameters:

routeHeader - the RouteHeader with which to compare