| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.httpclient.auth.HttpAuthenticator
public final class HttpAuthenticator
Utility methods for HTTP authorization and authentication. This class provides utility methods for generating responses to HTTP www and proxy authentication challenges.
A client SHOULD assume that all paths at or deeper than the depth of the last symbolic element in the path field of the Request-URI also are within the protection space specified by the basic realm value of the current challenge. A client MAY preemptively send the corresponding Authorization header with requests for resources in that space without receipt of another challenge from the server. Similarly, when a client sends a request to a proxy, it may reuse a userid and password in the Proxy-Authorization header field without receiving another challenge from the proxy server.
| Field Summary | |
|---|---|
| static String | PROXY_AUTHDeprecated. The proxy authenticate challange header. | 
| static String | PROXY_AUTH_RESPDeprecated. The proxy authenticate response header. | 
| static String | WWW_AUTHDeprecated. The www authenticate challange header. | 
| static String | WWW_AUTH_RESPDeprecated. The www authenticate response header. | 
| Constructor Summary | |
|---|---|
| HttpAuthenticator()Deprecated. | |
| Method Summary | |
|---|---|
| static boolean | authenticate(AuthScheme authscheme,
             HttpMethod method,
             HttpConnection conn,
             HttpState state)Deprecated. use AuthScheme | 
| static boolean | authenticateDefault(HttpMethod method,
                    HttpConnection conn,
                    HttpState state)Deprecated. use AuthScheme | 
| static boolean | authenticateProxy(AuthScheme authscheme,
                  HttpMethod method,
                  HttpConnection conn,
                  HttpState state)Deprecated. use AuthScheme | 
| static boolean | authenticateProxyDefault(HttpMethod method,
                         HttpConnection conn,
                         HttpState state)Deprecated. use AuthScheme | 
| static AuthScheme | selectAuthScheme(Header[] challenges)Deprecated. Use AuthChallengeParser.parseChallenges(Header[])andAuthPolicy.getAuthScheme(String) | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
|---|
public static final String WWW_AUTH
public static final String WWW_AUTH_RESP
public static final String PROXY_AUTH
public static final String PROXY_AUTH_RESP
| Constructor Detail | 
|---|
public HttpAuthenticator()
| Method Detail | 
|---|
public static AuthScheme selectAuthScheme(Header[] challenges)
                                   throws MalformedChallengeException
AuthChallengeParser.parseChallenges(Header[]) and 
      AuthPolicy.getAuthScheme(String)
NTLM,
 Digest, Basic schemes are recognized. 
 The NTLM scheme is considered the strongest and is 
 preferred to all others. The Digest scheme is preferred to 
 the Basic one which provides no encryption for credentials.
 The Basic scheme is used only if it is the only one 
 supported.
challenges - The array of authentication challenges
MalformedChallengeException - is thrown if an authentication 
  challenge is malformed
UnsupportedOperationException - when none of challenge types
  available is supported.
public static boolean authenticateDefault(HttpMethod method,
                                          HttpConnection conn,
                                          HttpState state)
                                   throws AuthenticationException
method - the HttpMethod which requires authenticationconn - the connection to a specific host. This parameter 
   may be null if default credentials (not specific 
   to any particular host) are to be usedstate - the HttpState object providing Credentials
InvalidCredentialsException - if authentication credentials
         are not valid or not applicable for basic scheme
AuthenticationException - when a parsing or other error occursHttpState.setCredentials(String,String,Credentials)
public static boolean authenticateProxyDefault(HttpMethod method,
                                               HttpConnection conn,
                                               HttpState state)
                                        throws AuthenticationException
method - the HttpMethod which requires authenticationconn - the connection to a specific host. This parameter 
   may be null if default credentials (not specific 
   to any particular host) are to be usedstate - the HttpState object providing Credentials
InvalidCredentialsException - if authentication credentials
         are not valid or not applicable for basic scheme
AuthenticationException - when a parsing or other error occursHttpState.setCredentials(String,String,Credentials)
public static boolean authenticate(AuthScheme authscheme,
                                   HttpMethod method,
                                   HttpConnection conn,
                                   HttpState state)
                            throws AuthenticationException
authscheme - The authentication scheme to be usedmethod - The HttpMethod which requires authenticationconn - the connection to a specific host. This parameter 
   may be null if default credentials (not specific 
   to any particular host) are to be usedstate - The HttpState object providing Credentials
CredentialsNotAvailableException - if authentication credentials
         required to respond to the authentication challenge are not available
AuthenticationException - when a parsing or other error occursHttpState.setCredentials(String,String,Credentials)
public static boolean authenticateProxy(AuthScheme authscheme,
                                        HttpMethod method,
                                        HttpConnection conn,
                                        HttpState state)
                                 throws AuthenticationException
authscheme - The authentication scheme to be usedmethod - the HttpMethod which requires authenticationconn - the connection to a specific host. This parameter 
   may be null if default credentials (not specific 
   to any particular host) are to be usedstate - the HttpState object providing Credentials
CredentialsNotAvailableException - if authentication credentials
         required to respond to the authentication challenge are not available
AuthenticationException - when a parsing or other error occursHttpState.setCredentials(String,String,Credentials)| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||