jain.protocol.ip.sip.header
Class AuthorizationHeader

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

public final class AuthorizationHeader

extends RequestHeader

This class represents the Authorization request-header. A user agent that wishes to authenticate itself with a server - usually, but not necessarily, after receiving an UNAUTHORIZED ResponseMessage - may do so by including an AuthorizationHeader with the RequestMessage. The AuthorizationHeader consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

Version:

0.6

See Also:

Credentials

Field Summary

static java.lang.String

token Token of AuthorizationHeader

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

ENTITY_HEADER, GENERAL_HEADER, REQUEST_HEADER, RESPONSE_HEADER

Constructor Summary

AuthorizationHeader(Credentials credentials)
Creates an AuthorizationHeader based on given method

Method Summary

java.lang.Object	clone() Creates and returns a copy of AuthorizationHeader
boolean	equals(AuthorizationHeader authorizationHeader) Indicates whether some other AuthorizationHeader is "equal to" this one
Credentials	getCredentials() Gets credentials of AuthorizationHeader
java.lang.String	getValue() Gets value of AuthorizationHeader
void	setCredentials(Credentials credentials) Sets credentials of AuthorizationHeader

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 AuthorizationHeader

Constructor Detail

AuthorizationHeader

public AuthorizationHeader(Credentials credentials)
                    throws java.lang.IllegalArgumentException

Creates an AuthorizationHeader based on given method

Parameters:

credentals - credentals

Throws:

java.lang.IllegalArgumentException - if credentals is null

Method Detail

getCredentials

public Credentials getCredentials()

Gets credentials of AuthorizationHeader

Returns:

credentials of AuthorizationHeader

setCredentials

public void setCredentials(Credentials credentials)
                    throws java.lang.IllegalArgumentException

Sets credentials of AuthorizationHeader

Parameters:

credentials - credentials

Throws:

java.lang.IllegalArgumentException - if credentials is null

getValue

public java.lang.String getValue()

Gets value of AuthorizationHeader

Overrides:

getValue in class Header

Returns:

value of AuthorizationHeader

clone

public java.lang.Object clone()

Creates and returns a copy of AuthorizationHeader

Overrides:

clone in class Header

Returns:

copy of AuthorizationHeader

equals

public boolean equals(AuthorizationHeader authorizationHeader)

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

Parameters:

authorizationHeader - the AuthorizationHeader with which to compare