org.apache.wink.client.handlers
Class BasicAuthSecurityHandler

java.lang.Object
  extended by org.apache.wink.client.handlers.AbstractAuthSecurityHandler
      extended by org.apache.wink.client.handlers.BasicAuthSecurityHandler
All Implemented Interfaces:
ClientHandler

public class BasicAuthSecurityHandler
extends AbstractAuthSecurityHandler
implements ClientHandler

SecurityHandler for a client to perform http basic auth:

Usage:
ClientConfig config = new ClientConfig();
BasicAuthSecurityHandler basicAuthSecHandler = new BasicAuthSecurityHandler(); basicAuthSecHandler.setUserName("username"); basicAuthSecHandler.setPassword("password"); config.handlers(basicAuthSecurityHandler);
// create the rest client instance
RestClient client = new RestClient(config);
// create the resource instance to interact with Resource
resource = client.resource("https://localhost:8080/path/to/resource");


Field Summary
 
Fields inherited from class org.apache.wink.client.handlers.AbstractAuthSecurityHandler
handlerEncodedCredentials, handlerPassword, handlerUsername
 
Constructor Summary
BasicAuthSecurityHandler()
           
BasicAuthSecurityHandler(java.lang.String username, java.lang.String password)
           
 
Method Summary
 ClientResponse handle(ClientRequest request, HandlerContext context)
          Performs basic HTTP authentication and proxy authentication, if necessary.
 
Methods inherited from class org.apache.wink.client.handlers.AbstractAuthSecurityHandler
getEncodedString, setPassword, setUserName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BasicAuthSecurityHandler

public BasicAuthSecurityHandler()

BasicAuthSecurityHandler

public BasicAuthSecurityHandler(java.lang.String username,
                                java.lang.String password)
Method Detail

handle

public ClientResponse handle(ClientRequest request,
                             HandlerContext context)
                      throws java.lang.Exception
Performs basic HTTP authentication and proxy authentication, if necessary.

Specified by:
handle in interface ClientHandler
Parameters:
client - request object
handler - context object
Returns:
a client response object that may contain an HTTP Authorization header
Throws:
java.lang.Exception - any exception can be thrown by a handler and it will be caught by the underlying client implementation and wrapped in a ClientRuntimeException


Copyright © 2009-2010 The Apache Software Foundation. All Rights Reserved.