Class EngineAuthenticationHandlerHolder
- java.lang.Object
-
- org.apache.sling.auth.core.impl.PathBasedHolder
-
- org.apache.sling.auth.core.impl.AbstractAuthenticationHandlerHolder
-
- org.apache.sling.auth.core.impl.engine.EngineAuthenticationHandlerHolder
-
- All Implemented Interfaces:
Comparable<PathBasedHolder>
,AuthenticationHandler
public final class EngineAuthenticationHandlerHolder extends AbstractAuthenticationHandlerHolder
TheEngineAuthenticationHandlerHolder
class represents an old-style SlingAuthenticationHandler
service in the internal data structure of theSlingAuthenticator
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.sling.auth.core.spi.AuthenticationHandler
AuthenticationHandler.FAILURE_REASON_CODES
-
-
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, FAILURE_REASON_CODE, PATH_PROPERTY, REQUEST_LOGIN_PARAMETER, SERVICE_NAME, TYPE_PROPERTY
-
-
Constructor Summary
Constructors Constructor Description EngineAuthenticationHandlerHolder(String fullPath, AuthenticationHandler handler, org.osgi.framework.ServiceReference serviceReference)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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)
Returnstrue
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 ornull
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
-
-
-
-
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 ornull
if none is provided.- Specified by:
getFeedbackHandler
in classAbstractAuthenticationHandlerHolder
-
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 classAbstractAuthenticationHandlerHolder
- Parameters:
request
- The current requestresponse
- 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 classAbstractAuthenticationHandlerHolder
- Parameters:
request
- The current requestresponse
- The current response- Returns:
- as returned from the called authentication handler
- Throws:
IOException
- if an error occurs 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 classAbstractAuthenticationHandlerHolder
- Parameters:
request
- The current requestresponse
- The current response- See Also:
AbstractAuthenticationHandlerHolder.dropCredentials(HttpServletRequest, HttpServletResponse)
-
equals
public boolean equals(Object obj)
Description copied from class:PathBasedHolder
Returnstrue
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 classPathBasedHolder
-
-