All Classes Interface Summary Class Summary Enum Summary Exception Summary
Class |
Description |
AbstractAttributeConverter<T> |
This abstract attribute converter handles some common behaviors for simple type converters.
|
AbstractCheckAuthenticationAuthorizer<U extends UserProfile> |
Check the authentication of the user.
|
AbstractExceptionAwareLogic<R,C extends WebContext> |
Abstract logic to handle exceptions:
|
AbstractJwtProfile |
Abstract JWT profile.
|
AbstractProfileService<U extends CommonProfile> |
Abstract implementation of the ProfileService for the storage: LDAP, SQL and MongoDB.
|
AbstractRequireAllAuthorizer<E,U extends UserProfile> |
An authorizer to require all the elements.
|
AbstractRequireAnyAuthorizer<E,U extends UserProfile> |
An authorizer to require any of the elements.
|
AbstractRequireElementAuthorizer<E,U extends UserProfile> |
An authorizer to require elements.
|
AbstractStore<K,O> |
Abstract store.
|
AccountNotFoundException |
Exception when an account is not found.
|
AjaxRequestResolver |
Compute if a HTTP request is an AJAX one and the appropriate response.
|
AlwaysUseSessionProfileStorageDecision<C extends WebContext> |
A decision class where the session is always used, generally when indirect and direct clients are mixed in the same web application.
|
AndAuthorizer<U extends UserProfile> |
The conjunction of authorizers.
|
AnonymousClient |
Anonymous client.
|
AnonymousCredentials |
Anonymous credentials.
|
AnonymousProfile |
Anonymous profile.
|
AttributeConverter<T> |
This interface is the contract for an attribute converter.
|
AttributeLocation |
Denotes where an attribute is placed in a profile.
|
Authenticator<C extends Credentials> |
|
AuthenticatorProfileCreator<C extends Credentials> |
This profile creator retrieves the user profile attached in the Credentials .
|
AuthorizationChecker |
The way to check authorizations.
|
AuthorizationGenerator |
Generate the authorization roles and permissions for this user profile.
|
Authorizer<U extends UserProfile> |
Checks if an access is authorized.
|
BadCredentialsException |
Exception for bad credentials.
|
BadRequestAction |
A bad request action.
|
BaseClient<C extends Credentials> |
This class is the default implementation of an authentication client (whatever the mechanism).
|
BaseClientConfiguration |
Base parent class for all client configurations
to hold common fields or to be used as a common parent
for type checking and casts in customizations.
|
BasicAuthExtractor |
To extract basic auth header.
|
BasicUserProfile |
This class is the user profile retrieved from a provider after successful authentication: it's an identifier (string) and attributes
(objects).
|
BearerAuthExtractor |
To extract an RFC 6750 bearer auth header.
|
BooleanConverter |
This class converts a String into a Boolean or returns the Boolean in input.
|
CacheControlMatcher |
Cache control header matcher.
|
CallbackLogic<R,C extends WebContext> |
Callback logic to finish the login process for an indirect client.
|
CallbackUrlResolver |
How to compute a callback URL and match a client.
|
CasLogoutActionBuilder |
CAS logout action builder.
|
ChainingConverter |
|
CheckHttpMethodAuthorizer |
Checks the HTTP method.
|
CheckProfileTypeAuthorizer<U extends UserProfile> |
Checks the profile type.
|
Client<C extends Credentials> |
This interface is the core class of the library.
|
ClientFinder |
The way to find the client.
|
Clients |
This class is made to group multiple clients, generally on one callback url.
|
Color |
This class is a simple RGB color values holder.
|
ColorConverter |
This class converts a String into a Color.
|
CommonHelper |
This class gathers all the utilities methods.
|
CommonProfile |
This class is the base implementation with the default attribute getters which can be retrieved for most profiles.
|
CommonProfileDefinition<P extends CommonProfile> |
Profile definition with the common attributes.
|
CommunicationException |
This class represents a communication exception.
|
Config |
The default configuration with clients, authorizers, matchers, etc.
|
ConfigBuilder |
To build a configuration from a factory.
|
ConfigFactory |
A factory to build the configuration.
|
ContextHelper |
A helper for the web context.
|
Converters |
This class defines the default converters.
|
Cookie |
|
CorsMatcher |
Define how the CORS requests are authorized.
|
Credentials |
This class represents the base credentials.
|
CredentialsException |
This class represents an expected exception occurring during credentials retrieval.
|
CredentialsExtractor<C extends Credentials> |
A credentials extractor.
|
CsrfAuthorizer |
Authorizer that checks CSRF tokens.
|
CsrfTokenGenerator |
CSRF token generator.
|
CsrfTokenGeneratorMatcher |
Matcher which creates a new CSRF token and adds it as a request attribute and as a cookie (AngularJS).
|
DateConverter |
This class converts a String (depending on a specified format) into a Date.
|
DefaultAjaxRequestResolver |
Default way to compute if a HTTP request is an AJAX one.
|
DefaultAuthorizationChecker |
Default way to check the authorizations (with default authorizers).
|
DefaultAuthorizers |
Constants for authorizers.
|
DefaultCallbackClientFinder |
Find the right client on the callback.
|
DefaultCallbackLogic<R,C extends WebContext> |
Default callback logic:
|
DefaultConfigFactory |
A default configuration factory.
|
DefaultCsrfTokenGenerator |
Default CSRF token generator.
|
DefaultLogoutHandler<C extends WebContext> |
Default logout handler.
|
DefaultLogoutLogic<R,C extends WebContext> |
Default logout logic:
|
DefaultMatchers |
The default matchers.
|
DefaultMatchingChecker |
Default way to check the matchers (with default matchers).
|
DefaultProfileStorageDecision<C extends WebContext> |
Default decision class where the indirect clients are handled separately from the direct clients.
|
DefaultRolesPermissionsAuthorizationGenerator |
Grant default roles and/or permissions to a user profile.
|
DefaultSavedRequestHandler |
|
DefaultSecurityClientFinder |
Find the right clients based on the query parameter for the SecurityLogic .
|
DefaultSecurityLogic<R,C extends WebContext> |
Default security logic:
|
DefaultUrlResolver |
Default URL resolver: use the provided URL as is or append the server and port for relative URLs.
|
DirectClient<C extends Credentials> |
Direct client: credentials are passed and authentication occurs for every HTTP request.
|
FindBest |
Utility class to find the best adapter, logic... in the following order:
1) the local one
2) the one from the config
3) the default one (must not be null).
|
ForbiddenAction |
A forbidden HTTP action.
|
FormExtractor |
To extract a username and password posted from a form.
|
FoundAction |
A "Found" HTTP action.
|
FromAttributesAuthorizationGenerator |
Generate the authorization information by inspecting attributes.
|
Gender |
This enumeration is the gender of a user : male, female or unspecified.
|
GenderConverter |
This class converts a String to a Gender.
|
GoogleLogoutActionBuilder |
Google logout action builder.
|
GuavaStore<K,O> |
Store data in a Guava cache.
|
HeaderExtractor |
To extract header value.
|
HeaderMatcher |
Matching on a HTTP header.
|
HttpAction |
|
HttpActionAdapter<R,C extends WebContext> |
HTTP action adapter.
|
HttpCommunicationException |
This class represents an exception which can happen during HTTP communication (with status code and message body).
|
HttpConstants |
Some HTTP constants.
|
HttpConstants.HTTP_METHOD |
|
HttpMethodMatcher |
Matching on HTTP methods.
|
HttpUtils |
This class provides utility functions to deal with opening connections,
building error messages and closing connections, etc.
|
IndirectClient<C extends Credentials> |
Indirect client: the requested protected URL is saved, the user is redirected to the identity provider for login and
back to the application after the sucessful authentication and finally to the originally requested URL.
|
InitializableObject |
Object that can be (re-)initialized.
|
InMemoryProfileService<U extends CommonProfile> |
In-memory profile service.
|
IntegerConverter |
This class converts a String into an Integer or returns the Integer in input.
|
IsAnonymousAuthorizer<U extends UserProfile> |
The user must be anonymous.
|
IsAuthenticatedAuthorizer<U extends UserProfile> |
The user must be authenticated.
|
IsFullyAuthenticatedAuthorizer<U extends UserProfile> |
The user must be fully authenticated (not remembered).
|
IsRememberedAuthorizer<U extends UserProfile> |
The user must be authenticated and remembered.
|
JavaSerializationHelper |
Helper for Java serialization.
|
JBCryptPasswordEncoder |
A password encoder for bcrypt and using a salt.
|
JEEContext |
This implementation uses the JEE HttpServletRequest and HttpServletResponse .
|
JEEContextFactory |
Build a JEE context from parameters.
|
JEEHttpActionAdapter |
|
JEESessionStore |
Store data in the JEE web session.
|
JsonSerializer |
A JSON serializer.
|
JwtClaims |
JWT claims: https://tools.ietf.org/html/rfc7519#page-9
|
LoadLinkedUserAuthorizationGenerator |
Load a linked account and replace the original account.
|
LocalCachingAuthenticator<T extends Credentials> |
An authenticator that caches the result of an authentication event locally.
|
LocaleConverter |
This class converts a String to a Locale.
|
LogoutActionBuilder |
|
LogoutHandler<C extends WebContext> |
This interface defines how to handle logout requests on client side.
|
LogoutLogic<R,C extends WebContext> |
Logout logic for the application and the identity provider.
|
LongConverter |
This class converts a String into a Long or returns the Long (or Integer) in input.
|
Matcher |
To match requests.
|
MatchingChecker |
The way to check requests matching.
|
MultipleAccountsFoundException |
Exception when multiple accounts are found.
|
NoContentAction |
A no content HTTP action.
|
NoLogoutActionBuilder |
|
NoParameterCallbackUrlResolver |
No name is added to the callback URL to be able to distinguish the client, so it doesn't match.
|
OkAction |
An OK HTTP action.
|
OrAuthorizer<U extends UserProfile> |
The disjunction of authorizers.
|
Pac4jConstants |
Common constants.
|
Pac4JPrincipal |
|
ParameterExtractor |
To extract a parameter value.
|
PasswordEncoder |
Encode a password.
|
PathMatcher |
Matches all request paths except whitelisted (excluded) paths.
|
PathParameterCallbackUrlResolver |
The client name is added to the path of the callback URL.
|
ProfileAuthorizer<U extends UserProfile> |
Authorizer which is valid if one of the profiles is authorized or all the profiles are authorized.
|
ProfileCreator<C extends Credentials> |
|
ProfileDefinition<P extends CommonProfile> |
Define a profile (its class and attributes).
|
ProfileDefinitionAware<P extends CommonProfile> |
For classes that can set the profile definition.
|
ProfileFactory<P extends UserProfile> |
A profile factory.
|
ProfileHelper |
This class is an helper for profiles.
|
ProfileManager<U extends UserProfile> |
This class is a generic way to manage the current user profile(s), i.e. the one(s) of the current authenticated user.
|
ProfileManagerFactory |
|
ProfileManagerFactory2 |
Deprecated. |
ProfileManagerFactoryAware<C extends WebContext> |
For classes that can set the profile manager factory.
|
ProfileService<U extends CommonProfile> |
Profile services: creation, update, delete and retrievals in the storage.
|
ProfileServiceSerializer |
|
ProfileStorageDecision<C extends WebContext> |
Defines the decisions related to load/save the profile(s) from/into the session store.
|
QueryParameterCallbackUrlResolver |
The client name is added as a query parameter to the callback URL.
|
RandomValueGenerator |
Value generator which returns a random value.
|
RedirectionAction |
A "redirection" HTTP action.
|
RedirectionActionBuilder |
Return the redirection action to perform.
|
RedirectionActionHelper |
|
RequireAllPermissionsAuthorizer<U extends UserProfile> |
Checks an access if the user profile has all the permissions.
|
RequireAllRolesAuthorizer<U extends UserProfile> |
Checks an access if the user profile has all the roles.
|
RequireAnyAttributeAuthorizer<U extends UserProfile> |
This is RequireAnyAttributeAuthorizer which checks profile
attributes for the specified element, and optionally
may pattern-check the configured value.
|
RequireAnyPermissionAuthorizer<U extends UserProfile> |
Checks an access if the user profile has any of the permissions.
|
RequireAnyRoleAuthorizer<U extends UserProfile> |
Checks an access if the user profile has any of the roles.
|
SavedRequestHandler |
Saves a request before a login process and restores it after a successfull login.
|
SecurityGrantedAccessAdapter<R,C extends WebContext> |
Success adapter.
|
SecurityLogic<R,C extends WebContext> |
Security logic to protect an url.
|
SeeOtherAction |
A "See Other" HTTP action.
|
Serializer |
The serializer contract.
|
SessionStore<C extends WebContext> |
To store data in session.
|
ShiroPasswordEncoder |
A password encoder based on PasswordService from Apache Shiro
Add the shiro-core dependency to use this class.
|
SpringSecurityPasswordEncoder |
A password encoder based on PasswordEncoder from the Spring
Security Crypto package.
|
SpringSecurityPropertiesAuthorizationGenerator |
Authorization generator based on a properties file in Spring security format:
username=password,grantedAuthority[,grantedAuthority][,enabled|disabled]
|
StaticValueGenerator |
Value generator which returns a pre-defined value.
|
StatusAction |
An HTTP action with just a specific status.
|
Store<K,O> |
Store data.
|
StrictTransportSecurityMatcher |
Strict transport security header matcher.
|
StringConverter |
This class only keeps String objects.
|
TechnicalException |
This class represents the root technical exception for the library.
|
TokenCredentials |
This credentials represents a token.
|
UnauthorizedAction |
An unauthorized HTTP action.
|
UrlConverter |
URL converter.
|
UrlResolver |
How to compute an URL.
|
UsernamePasswordCredentials |
This class represents a username and a password credentials
|
UserProfile |
|
ValueGenerator |
Value generator.
|
WebContext |
This interface represents the web context to use HTTP request and session.
|
WebContextFactory |
Build a web context from parameters.
|
WithContentAction |
An action with a content.
|
WithLocationAction |
An action with a location.
|
XContentTypeOptionsMatcher |
XContent type options header matcher.
|
XFrameOptionsMatcher |
XFrame options header matcher.
|
XSSProtectionMatcher |
XSS protection header matcher.
|