A B C D E F G H I N O P R S T U V

A

AccessControl - Annotation Type in org.sklsft.commons.rest.security.annotations

Used to indicates a rest controller method : which AccessControlType must be considered by the AccessControlAspect which TokenExtractionMode to be used to get the tokens

AccessControlAspect - Class in org.sklsft.commons.rest.security.aspect

The aspect responsible for controlling the access to a RESTFul API
The AccessControlType is declared with the AccessControl Annotation
The access control is delegated to the @{link AccessController}

AccessControlAspect(AccessController, SecurityContextProvider) - Constructor for class org.sklsft.commons.rest.security.aspect.AccessControlAspect

AccessController - Class in org.sklsft.commons.rest.security.access

This class will : Extract the token and the application secret key with @{link TokenExtractor} Give a security context with the SecurityContextProvider

AccessController(SecurityContextProvider, String, String) - Constructor for class org.sklsft.commons.rest.security.access.AccessController

AccessControlType - Enum in org.sklsft.commons.rest.security.access

Different Access control types provided by annotation AccessControl PUBLIC : no control should be done ANONYMOUS : the only secretKey will be checked PRIVATE : both secretKey and token will be checked

B

bindApplicationCredentials(Object) - Static method in class org.sklsft.commons.rest.security.context.SecurityContextHolder

bindUserCredentials(Object) - Static method in class org.sklsft.commons.rest.security.context.SecurityContextHolder

C

clearSecurityContext() - Method in class org.sklsft.commons.rest.security.context.impl.SecurityContextProviderImpl

clearSecurityContext() - Method in interface org.sklsft.commons.rest.security.context.SecurityContextProvider

CredentialsConflictException - Exception in org.sklsft.commons.rest.security.exception

This exception is thrown if you try to bind a security context if there is already one

CredentialsConflictException(String) - Constructor for exception org.sklsft.commons.rest.security.exception.CredentialsConflictException

CredentialsConflictException(String, Throwable) - Constructor for exception org.sklsft.commons.rest.security.exception.CredentialsConflictException

D

decode(String) - Method in class org.sklsft.commons.rest.security.credentials.impl.SecurityCredentialsEncoderImpl

decode(String) - Method in interface org.sklsft.commons.rest.security.credentials.SecurityCredentialsEncoder

E

encode(T) - Method in class org.sklsft.commons.rest.security.credentials.impl.SecurityCredentialsEncoderImpl

encode(T) - Method in interface org.sklsft.commons.rest.security.credentials.SecurityCredentialsEncoder

extractToken(String) - Method in class org.sklsft.commons.rest.security.tokens.impl.TokenFromCookieExtractor

extractToken(String) - Method in class org.sklsft.commons.rest.security.tokens.impl.TokenFromHeaderExtractor

extractToken(String) - Method in interface org.sklsft.commons.rest.security.tokens.TokenExtractor

F

FromCryptedTokenCredentialsRetriever<T> - Class in org.sklsft.commons.rest.security.credentials.impl

FromCryptedTokenCredentialsRetriever(SecurityCredentialsEncoder<T>, SecurityCredentialsValidator<T>) - Constructor for class org.sklsft.commons.rest.security.credentials.impl.FromCryptedTokenCredentialsRetriever

FromMapCredentialsRetriever<T> - Class in org.sklsft.commons.rest.security.credentials.impl

FromMapCredentialsRetriever(SecurityCredentialsValidator<T>) - Constructor for class org.sklsft.commons.rest.security.credentials.impl.FromMapCredentialsRetriever

G

get(String) - Method in class org.sklsft.commons.rest.security.credentials.impl.FromMapCredentialsRetriever

getApplicationCredentials() - Static method in class org.sklsft.commons.rest.security.context.SecurityContextHolder

getApplicationCredentialsOrNull() - Static method in class org.sklsft.commons.rest.security.context.SecurityContextHolder

getTokenExtractor(TokenExtractionMode) - Method in class org.sklsft.commons.rest.security.tokens.impl.TokenExtractorFactory

getUserCredentials() - Static method in class org.sklsft.commons.rest.security.context.SecurityContextHolder

getUserCredentialsOrNull() - Static method in class org.sklsft.commons.rest.security.context.SecurityContextHolder

H

handleHandshake(ProceedingJoinPoint) - Method in class org.sklsft.commons.rest.security.aspect.AccessControlAspect

handshake(AccessControlType, TokenExtractionMode) - Method in class org.sklsft.commons.rest.security.access.AccessController

I

InvalidTokenException - Exception in org.sklsft.commons.rest.security.exception

Thrown if your token does not enable to retrieve valid credentials

InvalidTokenException(String) - Constructor for exception org.sklsft.commons.rest.security.exception.InvalidTokenException

InvalidTokenException(String, Throwable) - Constructor for exception org.sklsft.commons.rest.security.exception.InvalidTokenException

N

NoBoundCredentialsException - Exception in org.sklsft.commons.rest.security.exception

If you try to access a security context and there is no one

NoBoundCredentialsException(String) - Constructor for exception org.sklsft.commons.rest.security.exception.NoBoundCredentialsException

NoBoundCredentialsException(String, Throwable) - Constructor for exception org.sklsft.commons.rest.security.exception.NoBoundCredentialsException

O

org.sklsft.commons.rest.security.access - package org.sklsft.commons.rest.security.access

org.sklsft.commons.rest.security.annotations - package org.sklsft.commons.rest.security.annotations

org.sklsft.commons.rest.security.aspect - package org.sklsft.commons.rest.security.aspect

org.sklsft.commons.rest.security.context - package org.sklsft.commons.rest.security.context

org.sklsft.commons.rest.security.context.impl - package org.sklsft.commons.rest.security.context.impl

org.sklsft.commons.rest.security.credentials - package org.sklsft.commons.rest.security.credentials

org.sklsft.commons.rest.security.credentials.impl - package org.sklsft.commons.rest.security.credentials.impl

org.sklsft.commons.rest.security.exception - package org.sklsft.commons.rest.security.exception

org.sklsft.commons.rest.security.tokens - package org.sklsft.commons.rest.security.tokens

org.sklsft.commons.rest.security.tokens.impl - package org.sklsft.commons.rest.security.tokens.impl

P

provideApplicationSecurityContext(String) - Method in class org.sklsft.commons.rest.security.context.impl.SecurityContextProviderImpl

provideApplicationSecurityContext(String) - Method in interface org.sklsft.commons.rest.security.context.SecurityContextProvider

provideUserSecurityContext(String) - Method in class org.sklsft.commons.rest.security.context.impl.SecurityContextProviderImpl

provideUserSecurityContext(String) - Method in interface org.sklsft.commons.rest.security.context.SecurityContextProvider

R

retrieveCredentials(String) - Method in class org.sklsft.commons.rest.security.credentials.impl.FromCryptedTokenCredentialsRetriever

retrieveCredentials(String) - Method in class org.sklsft.commons.rest.security.credentials.impl.FromMapCredentialsRetriever

retrieveCredentials(String) - Method in interface org.sklsft.commons.rest.security.credentials.SecurityCredentialsRetriever

S

SecurityContextHolder - Class in org.sklsft.commons.rest.security.context

A security context is handled by a ThreadLocal

SecurityContextHolder() - Constructor for class org.sklsft.commons.rest.security.context.SecurityContextHolder

SecurityContextProvider - Interface in org.sklsft.commons.rest.security.context

Responsible for : Providing an application security context given an application token Providing a user security context given a user token Destroying security contexts

SecurityContextProviderImpl<A,U> - Class in org.sklsft.commons.rest.security.context.impl

Implementation of SecurityContextProvider based on the use of : a SecurityContextHolder which is based on ThreadLocal two SecurityCredentialsRetriever

SecurityContextProviderImpl(SecurityCredentialsRetriever<A>, SecurityCredentialsRetriever<U>) - Constructor for class org.sklsft.commons.rest.security.context.impl.SecurityContextProviderImpl

SecurityCredentialsEncoder<T> - Interface in org.sklsft.commons.rest.security.credentials

used to encode/decode a SecurityCredentials to/from a String

SecurityCredentialsEncoderImpl<T> - Class in org.sklsft.commons.rest.security.credentials.impl

imlementation of a SecurityCredentialsEncoder that uses an ObjectEncoder

SecurityCredentialsEncoderImpl(ObjectEncoder, Class<T>) - Constructor for class org.sklsft.commons.rest.security.credentials.impl.SecurityCredentialsEncoderImpl

SecurityCredentialsRetriever<T> - Interface in org.sklsft.commons.rest.security.credentials

Provides Credentials from the Token Several implementations are possible : We can decode then validate the credentials : FromCryptedTokenCredentialsRetriever We can link the token to credentials with an access to a licences repository

SecurityCredentialsValidator<T> - Interface in org.sklsft.commons.rest.security.credentials

Responsible for credentials validation.

T

TokenExtractionMode - Enum in org.sklsft.commons.rest.security.tokens

Different Token extraction modes provided by annotation AccessControl HEADER : Token are passed through header (default mode) COOKIE : Token are given by cookies (useful for images to be displayed in html)

TokenExtractor - Interface in org.sklsft.commons.rest.security.tokens

To define an interface linked with a factory TokenExtractorFactory

TokenExtractorFactory - Class in org.sklsft.commons.rest.security.tokens.impl

Chooses the correct tokens extractor depending on the TokenExtractionMode

TokenExtractorFactory() - Constructor for class org.sklsft.commons.rest.security.tokens.impl.TokenExtractorFactory

TokenFromCookieExtractor - Class in org.sklsft.commons.rest.security.tokens.impl

To extract tokens from Servlet request cookies

TokenFromCookieExtractor(TokenFromHeaderExtractor) - Constructor for class org.sklsft.commons.rest.security.tokens.impl.TokenFromCookieExtractor

TokenFromHeaderExtractor - Class in org.sklsft.commons.rest.security.tokens.impl

To extract tokens from Servlet request headers

TokenFromHeaderExtractor() - Constructor for class org.sklsft.commons.rest.security.tokens.impl.TokenFromHeaderExtractor

TokenNotFoundException - Exception in org.sklsft.commons.rest.security.exception

Thrown if your token does not enable to retrieve valid credentials

TokenNotFoundException(String) - Constructor for exception org.sklsft.commons.rest.security.exception.TokenNotFoundException

TokenNotFoundException(String, Throwable) - Constructor for exception org.sklsft.commons.rest.security.exception.TokenNotFoundException

U

unbindCredentials() - Static method in class org.sklsft.commons.rest.security.context.SecurityContextHolder

V

validateCredentials(T) - Method in interface org.sklsft.commons.rest.security.credentials.SecurityCredentialsValidator

valueOf(String) - Static method in enum org.sklsft.commons.rest.security.access.AccessControlType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.sklsft.commons.rest.security.tokens.TokenExtractionMode

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.sklsft.commons.rest.security.access.AccessControlType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.sklsft.commons.rest.security.tokens.TokenExtractionMode

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I N O P R S T U V