jain.protocol.ip.sip.header
Class ProxyAuthorizationHeader

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

public final class ProxyAuthorizationHeader

extends RequestHeader

This class represents the Proxy-Authorization request-header. The ProxyAuthorizationHeader allows the client to identify itself (or its user) to a proxy which requires authentication. The ProxyAuthorizationHeader value consists of credentials containing the authentication information of the user agent for the proxy and/or realm of the resource being requested.

Unlike the AuthorizationHeader, the ProxyAuthorizationHeader applies only to the next outbound proxy that demanded authentication using the ProxyAuthenticateHeader. When multiple proxies are used in a chain, the ProxyAuthorizationHeader is consumed by the first outbound proxy that was expecting to receive credentials. A proxy may relay the credentials from the client RequestMessage to the next proxy if that is the mechanism by which the proxies cooperatively authenticate a given RequestMessage.

Version:

0.6

Field Summary

static java.lang.String

token Token of ProxyAuthorizationHeader

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

ENTITY_HEADER, GENERAL_HEADER, REQUEST_HEADER, RESPONSE_HEADER

Constructor Summary

ProxyAuthorizationHeader(Credentials credentials)
Creates a ProxyAuthorizationHeader based on given credentials

Method Summary

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

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 ProxyAuthorizationHeader

Constructor Detail

ProxyAuthorizationHeader

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

Creates a ProxyAuthorizationHeader based on given credentials

Parameters:

credentals - credentals

Throws:

java.lang.IllegalArgumentException - if credentals is null

Method Detail

getCredentials

public Credentials getCredentials()

Gets credentials of ProxyAuthorizationHeader

Returns:

credentials of ProxyAuthorizationHeader

setCredentials

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

Set credentials of ProxyAuthorizationHeader

Parameters:

credentials - credentials

Throws:

java.lang.IllegalArgumentException - if credentials is null

getValue

public java.lang.String getValue()

Gets value of ProxyAuthorizationHeader

Overrides:

getValue in class Header

Returns:

value of ProxyAuthorizationHeader

clone

public java.lang.Object clone()

Creates and returns a copy of ProxyAuthorizationHeader

Overrides:

clone in class Header

equals

public boolean equals(ProxyAuthorizationHeader proxyAuthorizationHeader)

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

Parameters:

proxyAuthorizationHeader - the ProxyAuthorizationHeader with which to compare