org.sblim.cimclient.internal.http

Class AuthorizationInfo

public abstract class AuthorizationInfo extends Object

Abstract superclass for HTTP authorization information.

Field Summary
protected String	iA1
protected String	iAddr
protected String	iAlgorithm
protected String	iCnonce
protected PasswordAuthentication	iCredentials
protected long	iNc
protected String	iNonce
protected String	iOpaque
protected int	iPort
protected String	iProtocol
protected String	iQop
protected String	iRealm
protected String	iResponse
protected String	iScheme
protected String	iUri

Method Summary
static AuthorizationInfo	createAuthorizationInfo(String pModule, Boolean pProxy, String pAddress, int pPort, String pProtocol, String pRealm, String pScheme) Factory method for AuthorizationInfo objects.
static AuthorizationInfo	createAuthorizationInfo(String pModule) Factory method for AuthorizationInfo objects.
String	getA1() Returns A1
String	getAddr() Returns the address
String	getAlgorithm() Returns algorithm
String	getCnonce() Returns cnonce
PasswordAuthentication	getCredentials() Returns the credentials
abstract String	getHeaderFieldName() Gets the HTTP header field name for this authentication information
long	getNc() Returns nc
String	getNonce() Returns nonce
String	getOpaque() Returns opaque
int	getPort() Returns the port
String	getProtocol() Returns the protocol
String	getQop() Returns Qop
String	getRealm() Returns the realm
String	getResponse() Returns response
String	getScheme() Returns the scheme
String	getURI() Returns URI
void	init(Boolean pProxy, String pAddress, int pPort, String pProtocol, String pRealm, String pScheme) Initialize
abstract boolean	isKeptAlive() Determines if the connection is kept alive after the "401 Unauthorized" response
abstract boolean	isSentOnFirstRequest() Determines if the authorization information is already sent on the very first http request or after the "401 Unauthorized" response
boolean	match(Object obj) Compares two authorization informations.
void	setA1(String A1) Sets A1
void	setAlgorithm(String algorithm) Set algorithm
void	setCnonce(String cnonce) Set cnonce
void	setCredentials(PasswordAuthentication credentials) Sets credentials
void	setNc(long nc) Sets nc
void	setNonce(String nonce) Sets nonce
void	setOpaque(String opaque) Sets opaque
void	setQop(String qop) Sets Qop
void	setRealm(String realm) Sets the realm
void	setResponse(String response) Sets response
void	setScheme(String scheme) Sets the scheme
void	setURI(String uri) Sets URI
abstract void	updateAuthenticationInfo(Challenge challenge, String authenticate, URI url, String requestMethod) Updates the authorization information according to a received challenge.

Field Detail

iCredentials

protected PasswordAuthentication iCredentials

Method Detail

createAuthorizationInfo

public static AuthorizationInfo createAuthorizationInfo(String pModule, Boolean pProxy, String pAddress, int pPort, String pProtocol, String pRealm, String pScheme)

Factory method for AuthorizationInfo objects. Returns an instance of a subclass according to the requested type.

Parameters: pModule The authorization info type to be constructed pProxy Proxy authentication ? pAddress Server address pPort Server port pProtocol Protocol (http/https) pRealm Realm pScheme Scheme (e.g. Basic, Digest)

Returns: An instance of a AuthorizationInfo subclass or null

createAuthorizationInfo

public static AuthorizationInfo createAuthorizationInfo(String pModule)

Factory method for AuthorizationInfo objects. Returns an instance of a subclass according to the requested type.

Parameters: pModule The authorization info type to be constructed

Returns: An instance of a AuthorizationInfo subclass or null

getA1

public String getA1()

Returns A1

Returns: A1

getAddr

public String getAddr()

Returns the address

Returns: The server address

getAlgorithm

public String getAlgorithm()

Returns algorithm

Returns: algorithm

getCnonce

public String getCnonce()

Returns cnonce

Returns: cnonce

getCredentials

public PasswordAuthentication getCredentials()

Returns the credentials

Returns: The credentials

getHeaderFieldName

public abstract String getHeaderFieldName()

Gets the HTTP header field name for this authentication information

Returns: The field name

getNc

public long getNc()

Returns nc

Returns: nc

getNonce

public String getNonce()

Returns nonce

Returns: nonce

getOpaque

public String getOpaque()

Returns opaque

Returns: Opaque

getPort

public int getPort()

Returns the port

Returns: The server port

getProtocol

public String getProtocol()

Returns the protocol

Returns: The protocol

getQop

public String getQop()

Returns Qop

Returns: Qop

getRealm

public String getRealm()

Returns the realm

Returns: The realm

getResponse

public String getResponse()

Returns response

Returns: New value

getScheme

public String getScheme()

Returns the scheme

Returns: The scheme

getURI

public String getURI()

Returns URI

Returns: URI

init

public void init(Boolean pProxy, String pAddress, int pPort, String pProtocol, String pRealm, String pScheme)

Initialize

Parameters: pProxy Proxy authentication ? pAddress Server address pPort Server port pProtocol Protocol pRealm Realm pScheme Scheme

isKeptAlive

public abstract boolean isKeptAlive()

Determines if the connection is kept alive after the "401 Unauthorized" response

Returns: true or false

isSentOnFirstRequest

public abstract boolean isSentOnFirstRequest()

Determines if the authorization information is already sent on the very first http request or after the "401 Unauthorized" response

Returns: true or false

match

public boolean match(Object obj)

Compares two authorization informations.

Parameters: obj The other authorization information

Returns: true if type, realm, scheme, address, protocol and port of both authorization informations are equal, false otherwise.

setA1

public void setA1(String A1)

Sets A1

Parameters: A1 New value

setAlgorithm

public void setAlgorithm(String algorithm)

Set algorithm

Parameters: algorithm New value

setCnonce

public void setCnonce(String cnonce)

Set cnonce

Parameters: cnonce New value

setCredentials

public void setCredentials(PasswordAuthentication credentials)

Sets credentials

Parameters: credentials New value

setNc

public void setNc(long nc)

Sets nc

Parameters: nc New value

setNonce

public void setNonce(String nonce)

Sets nonce

Parameters: nonce New Value

setOpaque

public void setOpaque(String opaque)

Sets opaque

Parameters: opaque new Value

setQop

public void setQop(String qop)

Sets Qop

Parameters: qop New value

setRealm

public void setRealm(String realm)

Sets the realm

Parameters: realm New value

setResponse

public void setResponse(String response)

Sets response

Parameters: response New value

setScheme

public void setScheme(String scheme)

Sets the scheme

Parameters: scheme New value

setURI

public void setURI(String uri)

Sets URI

Parameters: uri New value

updateAuthenticationInfo

public abstract void updateAuthenticationInfo(Challenge challenge, String authenticate, URI url, String requestMethod)

Updates the authorization information according to a received challenge.

Parameters: challenge The received challenge authenticate The authenticate header field url The url of the CIM server requestMethod The HTTP request method (POST or MPOST)

Throws: NoSuchAlgorithmException