Oracle Application Server HTTPClient API Reference
10g Release 2 (10.1.2)

B14020-02


HTTPClient
Class SuppliedUPAuthHandler

java.lang.Object
  extended byHTTPClient.SuppliedUPAuthHandler

All Implemented Interfaces:
AuthorizationHandler, HTTPClient.GlobalConstants

public class SuppliedUPAuthHandler
extends java.lang.Object
implements AuthorizationHandler, HTTPClient.GlobalConstants

A simple authorization handler that uses the supplied username/password used to create the instance Currently only handles the authentication types "Basic", "Digest".


Field Summary
static int CD_0
          Content delimiter- no body
static int CD_CHUNKED
          Content delimiter - via chunked transfer encoding
static int CD_CLOSE
          Content delimiter - by closing connection
static int CD_CONTLEN
          Content delimiter - via the Content-Length header
static int CD_HDRS
          Content delimiter - reading headers/trailers
static int CD_MP_BR
          Content delimiter - via multipart/byteranges
static int CD_NONE
          Content delimiter - raw read from the stream
static int HTTP
          plain http
static int HTTP_1_0
          HTTP 1.0
static int HTTP_1_1
          HTTP 1.1
static int HTTP_NG
          http next-generation
static int HTTPS
          http on top of SSL
static int SHTTP
          secure http

 

Constructor Summary
SuppliedUPAuthHandler(java.lang.String username, java.lang.String password)
           

 

Method Summary
 AuthorizationInfo fixupAuthInfo(AuthorizationInfo info, RoRequest req, AuthorizationInfo challenge, RoResponse resp)
          For Digest authentication we need to set the uri, response and opaque parameters.
 AuthorizationInfo getAuthorization(AuthorizationInfo challenge, RoRequest req, RoResponse resp)
          returns the requested authorization, or null if none was given.
 void handleAuthHeaders(Response resp, RoRequest req, AuthorizationInfo prev, AuthorizationInfo prxy)
          We handle the "Authentication-Info" and "Proxy-Authentication-Info" headers here.
 void handleAuthTrailers(Response resp, RoRequest req, AuthorizationInfo prev, AuthorizationInfo prxy)
          We handle the "Authentication-Info" and "Proxy-Authentication-Info" trailers here.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

HTTP

public static final int HTTP
plain http
See Also:
Constant Field Values

HTTPS

public static final int HTTPS
http on top of SSL
See Also:
Constant Field Values

SHTTP

public static final int SHTTP
secure http
See Also:
Constant Field Values

HTTP_NG

public static final int HTTP_NG
http next-generation
See Also:
Constant Field Values

HTTP_1_0

public static final int HTTP_1_0
HTTP 1.0
See Also:
Constant Field Values

HTTP_1_1

public static final int HTTP_1_1
HTTP 1.1
See Also:
Constant Field Values

CD_NONE

public static final int CD_NONE
Content delimiter - raw read from the stream
See Also:
Constant Field Values

CD_HDRS

public static final int CD_HDRS
Content delimiter - reading headers/trailers
See Also:
Constant Field Values

CD_0

public static final int CD_0
Content delimiter- no body
See Also:
Constant Field Values

CD_CLOSE

public static final int CD_CLOSE
Content delimiter - by closing connection
See Also:
Constant Field Values

CD_CONTLEN

public static final int CD_CONTLEN
Content delimiter - via the Content-Length header
See Also:
Constant Field Values

CD_CHUNKED

public static final int CD_CHUNKED
Content delimiter - via chunked transfer encoding
See Also:
Constant Field Values

CD_MP_BR

public static final int CD_MP_BR
Content delimiter - via multipart/byteranges
See Also:
Constant Field Values

Constructor Detail

SuppliedUPAuthHandler

public SuppliedUPAuthHandler(java.lang.String username,
                             java.lang.String password)

Method Detail

fixupAuthInfo

public AuthorizationInfo fixupAuthInfo(AuthorizationInfo info,
                                       RoRequest req,
                                       AuthorizationInfo challenge,
                                       RoResponse resp)
                                throws AuthSchemeNotImplException
For Digest authentication we need to set the uri, response and opaque parameters. For "Basic" and "SOCKS5" nothing is done.
Specified by:
fixupAuthInfo in interface AuthorizationHandler
Parameters:
info - the authorization info retrieved from the list of known info.
req - the request this info is targeted for.
challenge - the authorization challenge received from the server if this is in response to a 401, or null if we are preemptively sending the info.
resp - the full 401 response received, or null if we are preemptively sending the info.
Returns:
the authorization info to be sent with the request, or null if none is to be sent.
Throws:
AuthSchemeNotImplException - if the authorization scheme in the info cannot be handled.

getAuthorization

public AuthorizationInfo getAuthorization(AuthorizationInfo challenge,
                                          RoRequest req,
                                          RoResponse resp)
                                   throws AuthSchemeNotImplException
returns the requested authorization, or null if none was given.
Specified by:
getAuthorization in interface AuthorizationHandler
Parameters:
challenge - the parsed challenge from the server.
req - the request which solicited this response
resp - the full response received
Returns:
a structure containing the necessary authorization info, or null
Throws:
AuthSchemeNotImplException - if the authentication scheme in the challenge cannot be handled.

handleAuthHeaders

public void handleAuthHeaders(Response resp,
                              RoRequest req,
                              AuthorizationInfo prev,
                              AuthorizationInfo prxy)
                       throws java.io.IOException
We handle the "Authentication-Info" and "Proxy-Authentication-Info" headers here.
Specified by:
handleAuthHeaders in interface AuthorizationHandler
Parameters:
resp - the full Response
req - the Request which provoked this response
prev - the previous auth info sent, or null if none was sent
prxy - the previous proxy auth info sent, or null if none was sent
Throws:
java.io.IOException - if an exception occurs during the reading of the headers.

handleAuthTrailers

public void handleAuthTrailers(Response resp,
                               RoRequest req,
                               AuthorizationInfo prev,
                               AuthorizationInfo prxy)
                        throws java.io.IOException
We handle the "Authentication-Info" and "Proxy-Authentication-Info" trailers here.
Specified by:
handleAuthTrailers in interface AuthorizationHandler
Parameters:
resp - the full Response
req - the Request which provoked this response
prev - the previous auth info sent, or null if none was sent
prxy - the previous proxy auth info sent, or null if none was sent
Throws:
java.io.IOException - if an exception occurs during the reading of the trailers.
See Also:
AuthorizationHandler.handleAuthHeaders(HTTPClient.Response, HTTPClient.RoRequest, HTTPClient.AuthorizationInfo, HTTPClient.AuthorizationInfo)

Oracle Application Server HTTPClient API Reference
10g Release 2 (10.1.2)

B14020-02


Copyright © 2004, 2005, Oracle. All rights reserved.