A C D E F G H L N O P R S T

A

AbstractAuthenticationFormServlet - Class in org.apache.sling.auth.core.spi
The AbstractAuthenticationFormServlet provides a basic implementation of a simple servlet to render a login form for authentication purposes.
AbstractAuthenticationFormServlet() - Constructor for class org.apache.sling.auth.core.spi.AbstractAuthenticationFormServlet
 
AbstractAuthenticationHandler - Class in org.apache.sling.auth.core.spi
The AbstractAuthenticationHandler implements the AuthenticationHandler interface and extends the DefaultAuthenticationFeedbackHandler providing some helper methods which may be used by authentication handlers.
AbstractAuthenticationHandler() - Constructor for class org.apache.sling.auth.core.spi.AbstractAuthenticationHandler
 
AUTH_TYPE - Static variable in class org.apache.sling.auth.core.spi.AuthenticationInfo
The name of the special property providing the authentication type provided by the AuthenticationHandler.
authenticate(HttpServletRequest, HttpServletResponse) - Method in interface org.apache.sling.engine.auth.AuthenticationHandler
Deprecated. Extracts credential data from the request if at all contained.
authenticationFailed(HttpServletRequest, HttpServletResponse, AuthenticationInfo) - Method in interface org.apache.sling.auth.core.spi.AuthenticationFeedbackHandler
Called if authentication failed with the credentials provided in the authInfo map.
authenticationFailed(HttpServletRequest, HttpServletResponse, AuthenticationInfo) - Method in class org.apache.sling.auth.core.spi.DefaultAuthenticationFeedbackHandler
This default implementation does nothing.
AuthenticationFeedbackHandler - Interface in org.apache.sling.auth.core.spi
The AuthenticationFeedbackHandler may be implemented by AuthenticationHandler services to request being informed on the success or failure of authentication.
AuthenticationHandler - Interface in org.apache.sling.auth.core.spi
The AuthenticationHandler interface defines the service API used by the authentication implementation to support plugin various ways of extracting credentials from the request.
AuthenticationHandler - Interface in org.apache.sling.engine.auth
Deprecated. use AuthenticationHandler instead
AuthenticationInfo - Class in org.apache.sling.auth.core.spi
The AuthenticationInfo conveys any authentication credentials and/or details extracted by the AuthenticationHandler.extractCredentials(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) method from the request.
AuthenticationInfo(String) - Constructor for class org.apache.sling.auth.core.spi.AuthenticationInfo
Creates an instance of this class with just the authentication type.
AuthenticationInfo(String, String) - Constructor for class org.apache.sling.auth.core.spi.AuthenticationInfo
Creates an instance of this class authenticating with the given type and userid.
AuthenticationInfo(String, String, char[]) - Constructor for class org.apache.sling.auth.core.spi.AuthenticationInfo
Creates an instance of this class authenticating with the given type and userid/password connecting.
AuthenticationInfo - Class in org.apache.sling.engine.auth
Deprecated. see AuthenticationHandler
AuthenticationInfo(String, Credentials) - Constructor for class org.apache.sling.engine.auth.AuthenticationInfo
Deprecated. Creates an instance of this class with the given authentication type and credentials connecting to the default workspace as if the AuthenticationInfo.AuthenticationInfo(String, Credentials, String) method would be called with a null workspace name.
AuthenticationInfo(String, Credentials, String) - Constructor for class org.apache.sling.engine.auth.AuthenticationInfo
Deprecated. Creates an instance of this class with the given authentication type and credentials.
AuthenticationInfoPostProcessor - Interface in org.apache.sling.auth.core.spi
Service interface which allows bundles to modify the AuthenticationInfo object after authentication has been performed.
authenticationSucceeded(HttpServletRequest, HttpServletResponse, AuthenticationInfo) - Method in interface org.apache.sling.auth.core.spi.AuthenticationFeedbackHandler
Called if authentication succeeded with the credentials provided in the authInfo map.
authenticationSucceeded(HttpServletRequest, HttpServletResponse, AuthenticationInfo) - Method in class org.apache.sling.auth.core.spi.DefaultAuthenticationFeedbackHandler
This default implementation calls the DefaultAuthenticationFeedbackHandler.handleRedirect(HttpServletRequest, HttpServletResponse) method to optionally redirect the request after successful authentication.
AuthenticationSupport - Interface in org.apache.sling.auth.core
The AuthenticationSupport provides the service API used to implement the HttpContext.handleSecurity method as defined in the OSGi Http Service specification.
Authenticator - Interface in org.apache.sling.engine.auth
Deprecated. use AuthenticationSupport instead

C

clear() - Method in class org.apache.sling.auth.core.spi.AuthenticationInfo
Clears all properties from the map with the exception of the AuthenticationInfo.AUTH_TYPE property.
CUSTOM_FORM_PATH - Static variable in class org.apache.sling.auth.core.spi.AbstractAuthenticationFormServlet
The path to the custom login form.

D

DEFAULT_FORM_PATH - Static variable in class org.apache.sling.auth.core.spi.AbstractAuthenticationFormServlet
The path to the default login form.
DefaultAuthenticationFeedbackHandler - Class in org.apache.sling.auth.core.spi
 
DefaultAuthenticationFeedbackHandler() - Constructor for class org.apache.sling.auth.core.spi.DefaultAuthenticationFeedbackHandler
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.sling.auth.core.spi.AbstractAuthenticationFormServlet
Prepares and returns the login form.
DOING_AUTH - Static variable in class org.apache.sling.auth.core.spi.AuthenticationInfo
A special instance of this class which may be returned from the AuthenticationHandler.extractCredentials(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) method to inform the caller, that a response has been sent to the client to request for credentials.
DOING_AUTH - Static variable in class org.apache.sling.engine.auth.AuthenticationInfo
Deprecated. This object is returned by the AuthenticationHandler.authenticate(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) method to indicate an ongoing authentication transaction.
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.sling.auth.core.spi.AbstractAuthenticationFormServlet
Prepares and returns the login form.
dropCredentials(HttpServletRequest, HttpServletResponse) - Method in interface org.apache.sling.auth.core.spi.AuthenticationHandler
Drops any credential and authentication details from the request and asks the client to do the same.

E

extractCredentials(HttpServletRequest, HttpServletResponse) - Method in interface org.apache.sling.auth.core.spi.AuthenticationHandler
Extracts credential data from the request if at all contained.

F

FAIL_AUTH - Static variable in class org.apache.sling.auth.core.spi.AuthenticationInfo
A special instance of this class which may be returned from the AuthenticationHandler.extractCredentials(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) method to inform the caller that credential extraction failed for some reason.

G

getAttributeOrParameter(HttpServletRequest, String, String) - Static method in class org.apache.sling.auth.core.spi.AbstractAuthenticationHandler
Returns the value of the named request attribute or parameter as a string as follows: If there is a request attribute of that name, which is a non-empty string, it is returned.
getAuthType() - Method in class org.apache.sling.auth.core.spi.AuthenticationInfo
Returns the authentication type stored as the AuthenticationInfo.AUTH_TYPE property in this map.
getAuthType() - Method in class org.apache.sling.engine.auth.AuthenticationInfo
Deprecated. Returns type of authentication provisioning.
getCredentials() - Method in class org.apache.sling.engine.auth.AuthenticationInfo
Deprecated. Returns the credentials extracted from the client request to use for authentication.
getCustomFormPath() - Method in class org.apache.sling.auth.core.spi.AbstractAuthenticationFormServlet
Returns the path to the custom login form to load through the class loader of this instance using Class.getResourceAsStream.
getDefaultFormPath() - Method in class org.apache.sling.auth.core.spi.AbstractAuthenticationFormServlet
Returns the path to the default login form to load through the class loader of this instance using Class.getResourceAsStream.
getForm(HttpServletRequest) - Method in class org.apache.sling.auth.core.spi.AbstractAuthenticationFormServlet
Returns the form to be sent back to the client for login providing an optional informational message and the optional target to redirect to after successfully logging in.
getLoginResource(HttpServletRequest, String) - Static method in class org.apache.sling.auth.core.spi.AbstractAuthenticationHandler
Returns any resource target to redirect to after successful authentication.
getPassword() - Method in class org.apache.sling.auth.core.spi.AuthenticationInfo
Returns the password stored as the ResourceResolverFactory.PASSWORD property or null if the password is not set in this map.
getReason(HttpServletRequest) - Method in class org.apache.sling.auth.core.spi.AbstractAuthenticationFormServlet
Returns an informational message according to the value provided in the j_reason request parameter.
getResource(HttpServletRequest) - Method in class org.apache.sling.auth.core.spi.AbstractAuthenticationFormServlet
Returns the path to the resource to which the request should be redirected after successfully completing the form or an empty string if there is no resource request parameter.
getUser() - Method in class org.apache.sling.auth.core.spi.AuthenticationInfo
Returns the user name stored as the ResourceResolverFactory.USER property or null if the user is not set in this map.
getWorkspaceName() - Method in class org.apache.sling.engine.auth.AuthenticationInfo
Deprecated. Returns the name of the workspace the user contained in this instance wishes to connect to.

H

handleRedirect(HttpServletRequest, HttpServletResponse) - Static method in class org.apache.sling.auth.core.spi.DefaultAuthenticationFeedbackHandler
Handles an optional request for a redirect after successful authentication and true if the request has been redirected.
handleSecurity(HttpServletRequest, HttpServletResponse) - Method in interface org.apache.sling.auth.core.AuthenticationSupport
Handles security on behalf of a custom OSGi Http Service HttpContext instance extracting credentials from the request using any registered AuthenticationHandler services.

L

login(HttpServletRequest, HttpServletResponse) - Method in interface org.apache.sling.engine.auth.Authenticator
Deprecated. Finds an AuthenticationHandler for the given request and call its AuthenticationHandler.requestAuthentication(HttpServletRequest, HttpServletResponse) method to initiate an authentication process with the client to login to Sling.

N

NoAuthenticationHandlerException - Exception in org.apache.sling.engine.auth
Deprecated. see Authenticator
NoAuthenticationHandlerException() - Constructor for exception org.apache.sling.engine.auth.NoAuthenticationHandlerException
Deprecated.  

O

org.apache.sling.auth.core - package org.apache.sling.auth.core
 
org.apache.sling.auth.core.spi - package org.apache.sling.auth.core.spi
 
org.apache.sling.engine.auth - package org.apache.sling.engine.auth
 

P

PATH_PROPERTY - Static variable in interface org.apache.sling.auth.core.spi.AuthenticationHandler
The name of the service registration property listing one or more URL paths for which the authentication handler is to be used.
PATH_PROPERTY - Static variable in interface org.apache.sling.engine.auth.AuthenticationHandler
Deprecated. An authentication handler is associated with url paths.
postProcess(AuthenticationInfo, HttpServletRequest, HttpServletResponse) - Method in interface org.apache.sling.auth.core.spi.AuthenticationInfoPostProcessor
Perform some post-processing on the AuthenticationInfo object.
put(String, Object) - Method in class org.apache.sling.auth.core.spi.AuthenticationInfo
Sets or resets a property with the given key to a new value.

R

REDIRECT_PARAMETER - Static variable in interface org.apache.sling.auth.core.AuthenticationSupport
The name of the request parameter indicating where to redirect to after successful authentication (and optional impersonation).
remove(Object) - Method in class org.apache.sling.auth.core.spi.AuthenticationInfo
Removes the entry with the given key and returns its former value (if existing).
REQUEST_ATTRIBUTE_RESOLVER - Static variable in interface org.apache.sling.auth.core.AuthenticationSupport
The name of the request attribute set by the AuthenticationSupport.handleSecurity(HttpServletRequest, HttpServletResponse) method if authentication succeeds and true is returned.
REQUEST_LOGIN_PARAMETER - Static variable in interface org.apache.sling.auth.core.spi.AuthenticationHandler
The request parameter which may be used to explicitly select an authentication handler by its type if authentication will be requested through AuthenticationHandler.requestCredentials(HttpServletRequest, HttpServletResponse).
requestAuthentication(HttpServletRequest, HttpServletResponse) - Method in interface org.apache.sling.engine.auth.AuthenticationHandler
Deprecated. Requests authentication information from the client.
requestCredentials(HttpServletRequest, HttpServletResponse) - Method in interface org.apache.sling.auth.core.spi.AuthenticationHandler
Requests authentication information from the client.

S

SERVICE_NAME - Static variable in interface org.apache.sling.auth.core.AuthenticationSupport
The name under which this service is registered.
SERVICE_NAME - Static variable in interface org.apache.sling.auth.core.spi.AuthenticationHandler
The name under which an implementation of this interface must be registered to be used as an authentication handler.
SERVICE_NAME - Static variable in interface org.apache.sling.auth.core.spi.AuthenticationInfoPostProcessor
The name under which an implementation of this interface must be registered to be used as an authentication info post processor.
setAuthType(String) - Method in class org.apache.sling.auth.core.spi.AuthenticationInfo
 
setPassword(char[]) - Method in class org.apache.sling.auth.core.spi.AuthenticationInfo
 
setUser(String) - Method in class org.apache.sling.auth.core.spi.AuthenticationInfo
 

T

TYPE_PROPERTY - Static variable in interface org.apache.sling.auth.core.spi.AuthenticationHandler
The name of the service registration property (single string) providing the authentication type of authentication handler.

A C D E F G H L N O P R S T

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