| HTTPClient.AuthorizationHandler
All known Subclasses: HTTPClient.DefaultAuthHandler,
| AuthorizationHandler | | public interface AuthorizationHandler (Code) | | This is the interface that an Authorization handler must implement. You
can implement your own auth handler to add support for auth schemes other
than the ones handled by the default handler, to use a different UI for
soliciting usernames and passwords, or for using an altogether different
way of getting the necessary auth info.
See Also: AuthorizationInfo.setAuthHandler(HTTPClient.AuthorizationHandler)
version:
0.3-2 18/06/1999
author:
Ronald Tschalär |
| Method Summary | |
| AuthorizationInfo | fixupAuthInfo(AuthorizationInfo info, RoRequest req, AuthorizationInfo challenge, RoResponse resp)
This method is called whenever auth info is chosen from the list of
known info in the AuthorizationInfo class to be sent with a request.
This happens when either auth info is being preemptively sent or if
a 401 response is retrieved and a matching info is found in the list
of known info. | | AuthorizationInfo | getAuthorization(AuthorizationInfo challenge, RoRequest req, RoResponse resp)
This method is called whenever a 401 or 407 response is received and
no candidate info is found in the list of known auth info. | | void | handleAuthHeaders(Response resp, RoRequest req, AuthorizationInfo prev, AuthorizationInfo prxy)
Sometimes even non-401 responses will contain headers pertaining to
authorization (such as the "Authentication-Info" header). | | void | handleAuthTrailers(Response resp, RoRequest req, AuthorizationInfo prev, AuthorizationInfo prxy)
This method is similar to handleAuthHeaders except that
it is called if any headers in the trailer were sent. |
| fixupAuthInfo | | AuthorizationInfo fixupAuthInfo(AuthorizationInfo info, RoRequest req, AuthorizationInfo challenge, RoResponse resp) throws AuthSchemeNotImplException(Code) | | This method is called whenever auth info is chosen from the list of
known info in the AuthorizationInfo class to be sent with a request.
This happens when either auth info is being preemptively sent or if
a 401 response is retrieved and a matching info is found in the list
of known info. The intent of this method is to allow the handler to
fix up the info being sent based on the actual request (e.g. in digest
authentication the digest-uri, nonce and response-digest usually need
to be recalculated).
Parameters:
info - the authorization info retrieved from the list ofknown info.
Parameters:
req - the request this info is targeted for.
Parameters:
challenge - the authorization challenge received from the serverif this is in response to a 401, or null if we arepreemptively sending the info.
Parameters:
resp - the full 401 response received, or null if we arepreemptively sending the info. the authorization info to be sent with the request, or nullif none is to be sent.
exception:
AuthSchemeNotImplException - if the authorization schemein the info cannot be handled. |
| getAuthorization | | AuthorizationInfo getAuthorization(AuthorizationInfo challenge, RoRequest req, RoResponse resp) throws AuthSchemeNotImplException(Code) | | This method is called whenever a 401 or 407 response is received and
no candidate info is found in the list of known auth info. Usually
this method will query the user for the necessary info.
If the returned info is not null it will be added to the list of
known info. If the info is valid for more than one (host, port, realm,
scheme) tuple then this method must add the corresponding auth infos
itself.
This method must check req.allow_ui and only attempt
user interaction if it's true.
Parameters:
challenge - the parsed challenge from the server; the host,port, scheme, realm and params are set to thevalues given by the server in the challenge.
Parameters:
req - the request which provoked this response.
Parameters:
resp - the full response. the authorization info to use when retrying the request,or null if the request is not to be retried. The necessaryinfo includes the host, port, scheme and realm as given inthe challenge parameter, plus either the basiccookie or any necessary params.
exception:
AuthSchemeNotImplException - if the authorization schemein the challenge cannot be handled. |
| handleAuthHeaders | | void handleAuthHeaders(Response resp, RoRequest req, AuthorizationInfo prev, AuthorizationInfo prxy) throws IOException(Code) | | Sometimes even non-401 responses will contain headers pertaining to
authorization (such as the "Authentication-Info" header). Therefore
this method is invoked for each response received, even if it is not
a 401 or 407 response. In case of a 401 or 407 response the methods
fixupAuthInfo() and getAuthorization() are
invoked after this method.
Parameters:
resp - the full Response
Parameters:
req - the Request which provoked this response
Parameters:
prev - the previous auth info sent, or null if none was sent
Parameters:
prxy - the previous proxy auth info sent, or null if none was sent
exception:
IOException - if an exception occurs during the reading ofthe headers. |
|
|