jain.protocol.ip.sip.header
Class RequestHeader

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

Direct Known Subclasses:

AuthorizationHeader, HideHeader, MaxForwardsHeader, OrganizationHeader, PriorityHeader, ProxyAuthorizationHeader, ProxyRequireHeader, RequireHeader, ResponseKeyHeader, RouteHeader, SubjectHeader, UserAgentHeader

public class RequestHeader

extends Header

This class represents a request-header. RequestHeaders allow the client to pass additional information about the RequestMessage, and about the client itself, to the server. These Headers act as RequestMessage modifiers, with semantics equivalent to the parameters of a programming language method invocation.

RequestHeader names can be extended reliably only in combination with a change in the protocol version. However, new or experimental Headers may be given the semantics of RequestHeaders if all parties in the communication recognize them to be RequestHeaders. Unrecognized Headers are treated as EntityHeaders.

Version:

0.6

See Also:

EntityHeader, RequestMessage

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

ENTITY_HEADER, GENERAL_HEADER, REQUEST_HEADER, RESPONSE_HEADER

Constructor Summary

RequestHeader(java.lang.String token)
Creates a RequestHeader based on given token

RequestHeader(java.lang.String token, java.lang.String value)
Creates a RequestHeader based on given token and value

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

clone, equals, getHeaderType, getToken, getValue, setValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestHeader

public RequestHeader(java.lang.String token)
              throws java.lang.IllegalArgumentException

Creates a RequestHeader based on given token

Parameters:

token - token

Throws:

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

RequestHeader

public RequestHeader(java.lang.String token,
                     java.lang.String value)
              throws java.lang.IllegalArgumentException

Creates a RequestHeader based on given token and value

Parameters:

token - token

value - value

Throws:

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