org.apache.sling.auth.core.impl.engine
Class EngineAuthenticationHandlerHolder

java.lang.Object
  extended by org.apache.sling.auth.core.impl.PathBasedHolder
      extended by org.apache.sling.auth.core.impl.AbstractAuthenticationHandlerHolder
          extended by org.apache.sling.auth.core.impl.engine.EngineAuthenticationHandlerHolder
All Implemented Interfaces:
Comparable<PathBasedHolder>, AuthenticationHandler

public final class EngineAuthenticationHandlerHolder
extends AbstractAuthenticationHandlerHolder

The EngineAuthenticationHandlerHolder class represents an old-style Sling AuthenticationHandler service in the internal data structure of the SlingAuthenticator.


Field Summary
 
Fields inherited from class org.apache.sling.auth.core.impl.PathBasedHolder
fullPath
 
Fields inherited from interface org.apache.sling.auth.core.spi.AuthenticationHandler
FAILURE_REASON, PATH_PROPERTY, REQUEST_LOGIN_PARAMETER, SERVICE_NAME, TYPE_PROPERTY
 
Constructor Summary
EngineAuthenticationHandlerHolder(String fullPath, AuthenticationHandler handler, org.osgi.framework.ServiceReference serviceReference)
           
 
Method Summary
 void doDropCredentials(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Calls the actual authentication handler to request the credentials from the client.
 AuthenticationInfo doExtractCredentials(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Calls the actual authentication handler to extract the credentials from the request.
 boolean doRequestCredentials(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Calls the actual authentication handler to request the credentials from the client.
 boolean equals(Object obj)
          Returns true if the other object is the same as this or if it is an instance of the same class with the same full path and the same provider (ServiceReference).
protected  AuthenticationFeedbackHandler getFeedbackHandler()
          Returns a feedback handler provided by the authentication handler held by this instance or null if none is provided.
 String toString()
           
 
Methods inherited from class org.apache.sling.auth.core.impl.AbstractAuthenticationHandlerHolder
dropCredentials, extractCredentials, requestCredentials
 
Methods inherited from class org.apache.sling.auth.core.impl.PathBasedHolder
compareTo, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EngineAuthenticationHandlerHolder

public EngineAuthenticationHandlerHolder(String fullPath,
                                         AuthenticationHandler handler,
                                         org.osgi.framework.ServiceReference serviceReference)
Method Detail

getFeedbackHandler

protected AuthenticationFeedbackHandler getFeedbackHandler()
Description copied from class: AbstractAuthenticationHandlerHolder
Returns a feedback handler provided by the authentication handler held by this instance or null if none is provided.

Specified by:
getFeedbackHandler in class AbstractAuthenticationHandlerHolder

doExtractCredentials

public AuthenticationInfo doExtractCredentials(javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response)
Description copied from class: AbstractAuthenticationHandlerHolder
Calls the actual authentication handler to extract the credentials from the request.

Specified by:
doExtractCredentials in class AbstractAuthenticationHandlerHolder
Parameters:
request - The current request
response - The current response
Returns:
as returned from the called authentication handler
See Also:
AbstractAuthenticationHandlerHolder.extractCredentials(HttpServletRequest, HttpServletResponse)

doRequestCredentials

public boolean doRequestCredentials(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)
                             throws IOException
Description copied from class: AbstractAuthenticationHandlerHolder
Calls the actual authentication handler to request the credentials from the client.

Specified by:
doRequestCredentials in class AbstractAuthenticationHandlerHolder
Parameters:
request - The current request
response - The current response
Returns:
as returned from the called authentication handler
Throws:
IOException - if an error occurrs sending back any response to the client.
See Also:
AbstractAuthenticationHandlerHolder.requestCredentials(HttpServletRequest, HttpServletResponse)

doDropCredentials

public void doDropCredentials(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
Description copied from class: AbstractAuthenticationHandlerHolder
Calls the actual authentication handler to request the credentials from the client.

Specified by:
doDropCredentials in class AbstractAuthenticationHandlerHolder
Parameters:
request - The current request
response - The current response
See Also:
AbstractAuthenticationHandlerHolder.dropCredentials(HttpServletRequest, HttpServletResponse)

equals

public boolean equals(Object obj)
Description copied from class: PathBasedHolder
Returns true if the other object is the same as this or if it is an instance of the same class with the same full path and the same provider (ServiceReference).

Overrides:
equals in class PathBasedHolder

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2007-2013 The Apache Software Foundation. All Rights Reserved.