jain.protocol.ip.sip.header
Class Header

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

Direct Known Subclasses:

EntityHeader, GeneralHeader, RequestHeader, ResponseHeader

public class Header

extends java.lang.Object

implements java.lang.Cloneable

This class represents a generic SIP header. A Header can be one of the following types:

GeneralHeader - can be in RequestMessage or ResponseMessage

RequestHeader - can only be in RequestMessage

ResponseHeader - can only be in ResponseMessage

EntityHeader - describes Message body or resource

Messages may contain multiple instances of certain Headers. The order of these Headers within a Message is significant. The order of all Headers within a Message is also significant. Additionally, Headers which are hop-by-hop must appear before any Headers which are end-to-end. Proxies should not reorder Headers. Proxies add ViaHeaders and may add other hop-by-hop Headers. They can modify certain Headers, such as MaxForwardsHeaders and "fix up" the ViaHeaders with "received" parameters. Proxies must not alter any Headers that are authenticated.

Other Headers can be added as required; a server must ignore Headers that it does not understand. A proxy must not remove or modify Headers that it does not understand.

Version:

0.6

See Also:

GeneralHeader, RequestHeader, ResponseHeader, EntityHeader

Field Summary

static int	ENTITY_HEADER
static int	GENERAL_HEADER
static int	REQUEST_HEADER
static int	RESPONSE_HEADER

Constructor Summary

Header(java.lang.String token, java.lang.String value, int headerType)
Creates a Header based on given token and value

Method Summary

java.lang.Object	clone() Creates and returns a copy of Header
boolean	equals(Header header) Indicates whether some other Header is "equal to" this one
int	getHeaderType() Gets type of Header
java.lang.String	getToken() Gets token of Header
java.lang.String	getValue() Gets value of Header
void	setValue(java.lang.String value) Sets value of Header
java.lang.String	toString() Gets string representation of Header

Methods inherited from class java.lang.Object

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

Field Detail

GENERAL_HEADER

public static final int GENERAL_HEADER

REQUEST_HEADER

public static final int REQUEST_HEADER

RESPONSE_HEADER

public static final int RESPONSE_HEADER

ENTITY_HEADER

public static final int ENTITY_HEADER

Constructor Detail

Header

public Header(java.lang.String token,
              java.lang.String value,
              int headerType)
       throws java.lang.IllegalArgumentException

Creates a Header based on given token and value

Parameters:

token - token

value - value

Throws:

java.lang.IllegalArgumentException - if token or value are null or zero-length

Method Detail

getToken

public java.lang.String getToken()

Gets token of Header

Returns:

token of Header

getHeaderType

public int getHeaderType()

Gets type of Header

Returns:

type of Header

setValue

public void setValue(java.lang.String value)
              throws java.lang.IllegalArgumentException

Sets value of Header

Parameters:

value - value

Throws:

java.lang.IllegalArgumentException - if token is null or zero-length

getValue

public java.lang.String getValue()

Gets value of Header

Returns:

value of Header

clone

public java.lang.Object clone()

Creates and returns a copy of Header

toString

public java.lang.String toString()

Gets string representation of Header

Overrides:

toString in class java.lang.Object

Returns:

string representation of Header

equals

public boolean equals(Header header)

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

Parameters:

header - the Header with which to compare