PicketLink API 2.5.3.SP10-redhat-1
A B C D E F G H I J L M N O P Q R S T U V X 

A

AlreadyLoggedInEvent - Class in org.picketlink.authentication.event
This event is fired when an already authenticated user attempts to authenticate again
AlreadyLoggedInEvent() - Constructor for class org.picketlink.authentication.event.AlreadyLoggedInEvent
 
AUTH_TYPE_INIT_PARAM - Static variable in class org.picketlink.authentication.web.AuthenticationFilter
 
authenticate() - Method in interface org.picketlink.authentication.Authenticator
Performs the authentication.
AuthenticationException - Exception in org.picketlink.authentication
Thrown if there is an error during the authentication process
AuthenticationException(String) - Constructor for exception org.picketlink.authentication.AuthenticationException
 
AuthenticationException(String, Throwable) - Constructor for exception org.picketlink.authentication.AuthenticationException
 
AuthenticationFilter - Class in org.picketlink.authentication.web
This filter provides an authentication entry point for web applications using different HTTP Authentication Schemes such as FORM, BASIC, DIGEST and CLIENT-CERT.
AuthenticationFilter() - Constructor for class org.picketlink.authentication.web.AuthenticationFilter
 
AuthenticationFilter.AuthType - Enum in org.picketlink.authentication.web
 
Authenticator - Interface in org.picketlink.authentication
An Authenticator implementation is responsible for managing the user authentication process.
Authenticator.AuthenticationStatus - Enum in org.picketlink.authentication
 

B

BaseAuthenticator - Class in org.picketlink.authentication
Abstract base class that Authenticator implementations can extend for convenience.
BaseAuthenticator() - Constructor for class org.picketlink.authentication.BaseAuthenticator
 
BasicAuthenticationScheme - Class in org.picketlink.authentication.web
 
BasicAuthenticationScheme(FilterConfig) - Constructor for class org.picketlink.authentication.web.BasicAuthenticationScheme
 

C

Cache<K,V> - Interface in org.picketlink.cache
Cache Interface
Cacheable - Interface in org.picketlink.cache
Interface indicating an entity has access to a cache
CacheManager - Interface in org.picketlink.cache
Manager to manage cache instances
challengeClient(HttpServletRequest, HttpServletResponse) - Method in class org.picketlink.authentication.web.BasicAuthenticationScheme
 
challengeClient(HttpServletRequest, HttpServletResponse) - Method in class org.picketlink.authentication.web.ClientCertAuthenticationScheme
 
challengeClient(HttpServletRequest, HttpServletResponse) - Method in class org.picketlink.authentication.web.DigestAuthenticationScheme
 
challengeClient(HttpServletRequest, HttpServletResponse) - Method in class org.picketlink.authentication.web.FormAuthenticationScheme
 
challengeClient(HttpServletRequest, HttpServletResponse) - Method in interface org.picketlink.authentication.web.HTTPAuthenticationScheme
Challenges the client if no credentials were supplied or the credentials were not extracted in order to continue with the authentication.
ClientCertAuthenticationScheme - Class in org.picketlink.authentication.web
An implementation of HTTPAuthenticationScheme that supports the Servlet Specification CLIENT-CERT Authentication Scheme
ClientCertAuthenticationScheme(FilterConfig) - Constructor for class org.picketlink.authentication.web.ClientCertAuthenticationScheme
 
clientResponseValue(Digest, char[]) - Static method in class org.picketlink.authentication.web.support.HTTPDigestUtil
Given the digest, construct the client response value
convertBytesToHex(byte[]) - Static method in class org.picketlink.authentication.web.support.HTTPDigestUtil
Convert a byte array to hex

D

DEFAULT_REALM_NAME - Static variable in class org.picketlink.authentication.web.BasicAuthenticationScheme
 
DEFAULT_REALM_NAME - Static variable in class org.picketlink.authentication.web.DigestAuthenticationScheme
 
DefaultLoginCredentials - Class in org.picketlink.credential
The default Credentials implementation.
DefaultLoginCredentials() - Constructor for class org.picketlink.credential.DefaultLoginCredentials
 
destroy() - Method in class org.picketlink.authentication.web.AuthenticationFilter
 
digest(String[]) - Static method in class org.picketlink.authentication.web.support.HTTPDigestUtil
Construct a DigestHolder from the tokens
DigestAuthenticationScheme - Class in org.picketlink.authentication.web
 
DigestAuthenticationScheme(FilterConfig) - Constructor for class org.picketlink.authentication.web.DigestAuthenticationScheme
 
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.picketlink.authentication.web.AuthenticationFilter
 

E

extract(String, String) - Static method in class org.picketlink.authentication.web.support.HTTPDigestUtil
Given a digest token, extract the value
extractCredential(HttpServletRequest, DefaultLoginCredentials) - Method in class org.picketlink.authentication.web.BasicAuthenticationScheme
 
extractCredential(HttpServletRequest, DefaultLoginCredentials) - Method in class org.picketlink.authentication.web.ClientCertAuthenticationScheme
 
extractCredential(HttpServletRequest, DefaultLoginCredentials) - Method in class org.picketlink.authentication.web.DigestAuthenticationScheme
 
extractCredential(HttpServletRequest, DefaultLoginCredentials) - Method in class org.picketlink.authentication.web.FormAuthenticationScheme
 
extractCredential(HttpServletRequest, DefaultLoginCredentials) - Method in interface org.picketlink.authentication.web.HTTPAuthenticationScheme
Extracts the credentials from the given HttpServletRequest and populate the DefaultLoginCredentials with them.
extractUsernameAndPassword(HttpServletRequest) - Method in class org.picketlink.authentication.web.BasicAuthenticationScheme
 

F

FORCE_REAUTHENTICATION_INIT_PARAM - Static variable in class org.picketlink.authentication.web.AuthenticationFilter
 
FORM_ERROR_PAGE_INIT_PARAM - Static variable in class org.picketlink.authentication.web.FormAuthenticationScheme
 
FORM_LOGIN_PAGE_INIT_PARAM - Static variable in class org.picketlink.authentication.web.FormAuthenticationScheme
 
FormAuthenticationScheme - Class in org.picketlink.authentication.web
An implementation of HTTPAuthenticationScheme that supports the Servlet Specification FORM Authentication Scheme
FormAuthenticationScheme(FilterConfig) - Constructor for class org.picketlink.authentication.web.FormAuthenticationScheme
 

G

generateAndCacheNonce(HttpServletRequest) - Method in class org.picketlink.authentication.web.support.NonceCache
 
get() - Method in class org.picketlink.authentication.web.support.UUIDNonceGenerator
 
getAccount() - Method in interface org.picketlink.authentication.Authenticator
Returns a Account if a successful authentication was made.
getAccount() - Method in class org.picketlink.authentication.BaseAuthenticator
 
getAccount() - Method in class org.picketlink.authentication.event.PostLoggedOutEvent
 
getAccount() - Method in class org.picketlink.authentication.event.PreLoggedOutEvent
 
getAccount() - Method in interface org.picketlink.Identity
 
getCache() - Method in interface org.picketlink.cache.Cacheable
Get the Cache
getCache(String) - Method in interface org.picketlink.cache.CacheManager
Given a name for the cache, return an instance of Cache
getConfig() - Method in class org.picketlink.IdentityConfigurationEvent
 
getContextPath() - Method in class org.picketlink.authentication.web.support.SavedRequest
Returns the original context path used by the original request.
getCookies() - Method in class org.picketlink.authentication.web.support.SavedRequest
Returns the cookies copied from the original request.
getCredential() - Method in class org.picketlink.credential.DefaultLoginCredentials
 
getHeaders() - Method in class org.picketlink.authentication.web.support.SavedRequest
Returns the headers copied from the original request.
getLoginException() - Method in class org.picketlink.authentication.event.LoginFailedEvent
 
getMethod() - Method in class org.picketlink.authentication.web.support.SavedRequest
Returns the original HTTP method used by the original request.
getNonceMaxValid() - Method in class org.picketlink.authentication.web.support.NonceCache
 
getParameters() - Method in class org.picketlink.authentication.web.support.SavedRequest
Returns the parameters copied from the original request.
getPartitionManager() - Method in class org.picketlink.PartitionManagerCreateEvent
 
getPassword() - Method in class org.picketlink.credential.DefaultLoginCredentials
 
getQueryString() - Method in class org.picketlink.authentication.web.support.SavedRequest
Returns the querystring used by the original request.
getRequestURI() - Method in class org.picketlink.authentication.web.support.SavedRequest
Returns the requestURI used by the original request.
getScheme() - Method in class org.picketlink.authentication.web.support.SavedRequest
Returns the original scheme used by the original request.
getStatus() - Method in interface org.picketlink.authentication.Authenticator
Returns the current status of the authentication attempt.
getStatus() - Method in class org.picketlink.authentication.BaseAuthenticator
 
getUserId() - Method in class org.picketlink.credential.DefaultLoginCredentials
 

H

hasExpired(String, long) - Method in class org.picketlink.authentication.web.support.NonceCache
 
hasPermission(Object, String) - Method in interface org.picketlink.Identity
Tests if the currently authenticated user has permission to perform the specified operation on the specified resource.
hasPermission(Class<?>, Serializable, String) - Method in interface org.picketlink.Identity
As above, however this method should be used when a reference to the resource is not available, or is expensive to retrieve, for example looking up an entity from a relational database.
hasValidNonce(Digest, HttpServletRequest) - Method in class org.picketlink.authentication.web.support.NonceCache
 
HTTPAuthenticationScheme - Interface in org.picketlink.authentication.web
Defines the methods that should be implemented by classes that provide implementations for the HTTP Authentication Schemes such as BASIC, FORM, DIGEST and CLIENT-CERT.
HTTPDigestUtil - Class in org.picketlink.authentication.web.support
Utility class to support HTTP Digest Authentication
HTTPDigestUtil() - Constructor for class org.picketlink.authentication.web.support.HTTPDigestUtil
 

I

Identity - Interface in org.picketlink
Represents the identity of the current user, and provides an API for authentication and authorization.
Identity.AuthenticationResult - Enum in org.picketlink
 
Identity.Stateless - Annotation Type in org.picketlink
Defines a Qualifier that may be applied to an injection point to indicate that a stateless Identity is expected.
IdentityConfigurationEvent - Class in org.picketlink
This event is raised during PicketLink startup when building the IDM configuration.
IdentityConfigurationEvent(IdentityConfigurationBuilder) - Constructor for class org.picketlink.IdentityConfigurationEvent
 
init(FilterConfig) - Method in class org.picketlink.authentication.web.AuthenticationFilter
 
invalidate() - Method in class org.picketlink.credential.DefaultLoginCredentials
 
isLoggedIn() - Method in interface org.picketlink.Identity
Simple check that returns true if the user is logged in, without attempting to authenticate

J

J_PASSWORD - Static variable in class org.picketlink.authentication.web.FormAuthenticationScheme
 
J_SECURITY_CHECK - Static variable in class org.picketlink.authentication.web.FormAuthenticationScheme
 
J_USERNAME - Static variable in class org.picketlink.authentication.web.FormAuthenticationScheme
 

L

LockedAccountEvent - Class in org.picketlink.authentication.event
This event is fired during the authentication process if the agent is disabled.
LockedAccountEvent() - Constructor for class org.picketlink.authentication.event.LockedAccountEvent
 
LockedAccountException - Exception in org.picketlink.authentication
Thrown during the authentication process to indicate that the account being validated is disabled.
LockedAccountException(String) - Constructor for exception org.picketlink.authentication.LockedAccountException
 
LoggedInEvent - Class in org.picketlink.authentication.event
This event is raised when user successfully logs in.
LoggedInEvent() - Constructor for class org.picketlink.authentication.event.LoggedInEvent
 
login() - Method in interface org.picketlink.Identity
Attempts to authenticate the user.
LoginFailedEvent - Class in org.picketlink.authentication.event
This event is fired when an authentication attempt fails
LoginFailedEvent(Throwable) - Constructor for class org.picketlink.authentication.event.LoginFailedEvent
 
logout() - Method in interface org.picketlink.Identity
Logs out the currently authenticated user

M

matchCredential(Digest, char[]) - Static method in class org.picketlink.authentication.web.support.HTTPDigestUtil
Match the Client Response value with a generated digest based on the password
md5(String) - Static method in class org.picketlink.authentication.web.support.HTTPDigestUtil
Determine the message digest

N

NonceCache - Class in org.picketlink.authentication.web.support
 
NonceCache() - Constructor for class org.picketlink.authentication.web.support.NonceCache
 

O

org.picketlink - package org.picketlink
 
org.picketlink.annotations - package org.picketlink.annotations
 
org.picketlink.authentication - package org.picketlink.authentication
 
org.picketlink.authentication.event - package org.picketlink.authentication.event
 
org.picketlink.authentication.web - package org.picketlink.authentication.web
 
org.picketlink.authentication.web.support - package org.picketlink.authentication.web.support
 
org.picketlink.cache - package org.picketlink.cache
Package containing the caching wrapper
org.picketlink.credential - package org.picketlink.credential
 

P

PartitionManagerCreateEvent - Class in org.picketlink
This event is fired during PicketLink startup after creating the PartitionManager.
PartitionManagerCreateEvent(PartitionManager) - Constructor for class org.picketlink.PartitionManagerCreateEvent
 
PicketLink - Annotation Type in org.picketlink.annotations
Qualifies a bean, injection or producer field as a PicketLink resource.
postAuthenticate() - Method in interface org.picketlink.authentication.Authenticator
Post-authentication logic.
postAuthenticate() - Method in class org.picketlink.authentication.BaseAuthenticator
 
PostAuthenticateEvent - Class in org.picketlink.authentication.event
This event is raised just after authentication
PostAuthenticateEvent() - Constructor for class org.picketlink.authentication.event.PostAuthenticateEvent
 
postAuthentication(HttpServletRequest, HttpServletResponse) - Method in class org.picketlink.authentication.web.BasicAuthenticationScheme
 
postAuthentication(HttpServletRequest, HttpServletResponse) - Method in class org.picketlink.authentication.web.ClientCertAuthenticationScheme
 
postAuthentication(HttpServletRequest, HttpServletResponse) - Method in class org.picketlink.authentication.web.DigestAuthenticationScheme
 
postAuthentication(HttpServletRequest, HttpServletResponse) - Method in class org.picketlink.authentication.web.FormAuthenticationScheme
 
postAuthentication(HttpServletRequest, HttpServletResponse) - Method in interface org.picketlink.authentication.web.HTTPAuthenticationScheme
Performs any post-authentication logic regarding of the authentication result.
PostLoggedOutEvent - Class in org.picketlink.authentication.event
This event is raised just after the user un-authenticates
PostLoggedOutEvent(Account) - Constructor for class org.picketlink.authentication.event.PostLoggedOutEvent
 
PreAuthenticateEvent - Class in org.picketlink.authentication.event
This event is raised just before authentication.
PreAuthenticateEvent() - Constructor for class org.picketlink.authentication.event.PreAuthenticateEvent
 
PreLoggedOutEvent - Class in org.picketlink.authentication.event
This event is raised just before the user un-authenticates
PreLoggedOutEvent(Account) - Constructor for class org.picketlink.authentication.event.PreLoggedOutEvent
 

Q

quoteTokenize(String) - Static method in class org.picketlink.authentication.web.support.HTTPDigestUtil
Given the standard client response in HTTP/Digest mechanism, generate a set of string tokens that retains the quotes

R

REALM_NAME_INIT_PARAM - Static variable in class org.picketlink.authentication.web.BasicAuthenticationScheme
 
REALM_NAME_INIT_PARAM - Static variable in class org.picketlink.authentication.web.DigestAuthenticationScheme
 
removeAndStoreSavedRequestInSession(HttpServletRequest) - Method in class org.picketlink.authentication.web.support.RequestCache
Removes a cached request and stores it in the session.
RequestCache - Class in org.picketlink.authentication.web.support
This class maintains a cache of SavedRequest instances created from HttpServletRequest instances.
RequestCache() - Constructor for class org.picketlink.authentication.web.support.RequestCache
 
run() - Method in class org.picketlink.authentication.web.support.NonceCache
 

S

SAVED_REQUEST - Static variable in class org.picketlink.authentication.web.FormAuthenticationScheme
 
SavedRequest - Class in org.picketlink.authentication.web.support
This class is a representation of the state of a previous HttpServletRequest instance.
SavedRequest(HttpServletRequest) - Constructor for class org.picketlink.authentication.web.support.SavedRequest
Create a new instance copying the state from the request passed as argument.
saveRequest(HttpServletRequest) - Method in class org.picketlink.authentication.web.support.RequestCache
Saves a HttpServletRequest as a SavedRequest instance.
setAccount(Account) - Method in class org.picketlink.authentication.BaseAuthenticator
 
setCacheManager(Cache<K, V>) - Method in interface org.picketlink.cache.Cacheable
Set the CacheManager
setCredential(Object) - Method in class org.picketlink.credential.DefaultLoginCredentials
 
setPassword(String) - Method in class org.picketlink.credential.DefaultLoginCredentials
Convenience method that allows a plain text password credential to be set
setStatus(Authenticator.AuthenticationStatus) - Method in class org.picketlink.authentication.BaseAuthenticator
 
setUserId(String) - Method in class org.picketlink.credential.DefaultLoginCredentials
 
STATE - Static variable in class org.picketlink.authentication.web.FormAuthenticationScheme
 

T

toString() - Method in class org.picketlink.credential.DefaultLoginCredentials
 

U

UnexpectedCredentialException - Exception in org.picketlink.authentication
Thrown during the authentication process to indicate that credentials are not supported or could not be handled.
UnexpectedCredentialException(String) - Constructor for exception org.picketlink.authentication.UnexpectedCredentialException
 
UnexpectedCredentialException(String, Throwable) - Constructor for exception org.picketlink.authentication.UnexpectedCredentialException
 
UNPROTECTED_METHODS_INIT_PARAM - Static variable in class org.picketlink.authentication.web.AuthenticationFilter
 
UserAlreadyLoggedInException - Exception in org.picketlink.authentication
Thrown during the authentication process to indicate that an user is already authenticated.
UserAlreadyLoggedInException(String) - Constructor for exception org.picketlink.authentication.UserAlreadyLoggedInException
 
userName(String) - Static method in class org.picketlink.authentication.web.support.HTTPDigestUtil
 
UUIDNonceGenerator - Class in org.picketlink.authentication.web.support
A nonce generator that uses UUID level 4
UUIDNonceGenerator() - Constructor for class org.picketlink.authentication.web.support.UUIDNonceGenerator
 

V

valueOf(String) - Static method in enum org.picketlink.authentication.Authenticator.AuthenticationStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.picketlink.authentication.web.AuthenticationFilter.AuthType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.picketlink.Identity.AuthenticationResult
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.picketlink.authentication.Authenticator.AuthenticationStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.picketlink.authentication.web.AuthenticationFilter.AuthType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.picketlink.Identity.AuthenticationResult
Returns an array containing the constants of this enum type, in the order they are declared.

X

X509_CLIENT_CERT_REQUEST_ATTRIBUTE - Static variable in class org.picketlink.authentication.web.ClientCertAuthenticationScheme
 
A B C D E F G H I J L M N O P Q R S T U V X 
PicketLink API 2.5.3.SP10-redhat-1

Copyright © 2014 JBoss by Red Hat. All Rights Reserved.