A B C D E F G H I N O P 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) - 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 with @{link TokenExtractor} Give a security context with the SecurityContextProvider

AccessController(SecurityContextProvider, 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

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

C

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.tokens.encoder.impl.PlainTextTokenEncoder

decode(String) - Method in class org.sklsft.commons.rest.security.tokens.encoder.impl.SymetricCryptedTokenEncoder

decode(String) - Method in interface org.sklsft.commons.rest.security.tokens.encoder.TokenEncoder

E

encode(String) - Method in class org.sklsft.commons.rest.security.tokens.encoder.impl.PlainTextTokenEncoder

encode(T) - Method in class org.sklsft.commons.rest.security.tokens.encoder.impl.SymetricCryptedTokenEncoder

encode(T) - Method in interface org.sklsft.commons.rest.security.tokens.encoder.TokenEncoder

extractCredentials(String) - Method in class org.sklsft.commons.rest.security.credentials.extractor.impl.FromMapCredentialsExtractor

extractCredentials(T) - Method in class org.sklsft.commons.rest.security.credentials.extractor.impl.FromUnsignedTokenCredentialsExtractor

extractCredentials(T) - Method in interface org.sklsft.commons.rest.security.credentials.extractor.SecurityCredentialsExtractor

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

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

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

F

FromMapCredentialsExtractor<C> - Class in org.sklsft.commons.rest.security.credentials.extractor.impl

This is adapted for tokens that represent a plain license key where you have to find a correspondance in a repository

FromMapCredentialsExtractor() - Constructor for class org.sklsft.commons.rest.security.credentials.extractor.impl.FromMapCredentialsExtractor

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

For Symetric crypted tokens, the credentials are the token object itself

FromUnsignedTokenCredentialsExtractor() - Constructor for class org.sklsft.commons.rest.security.credentials.extractor.impl.FromUnsignedTokenCredentialsExtractor

G

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

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

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

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

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.extractor - package org.sklsft.commons.rest.security.credentials.extractor

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

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

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

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

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

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

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

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

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

P

PlainTextTokenEncoder - Class in org.sklsft.commons.rest.security.tokens.encoder.impl

For tokens that represents a plain license key

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

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

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

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 a security context given a user token

SecurityContextProviderImpl<T,C> - Class in org.sklsft.commons.rest.security.context.impl

Implementation of SecurityContextProvider based on the use of : a SecurityContextHolder which is based on ThreadLocal a TokenEncoder a TokenVerifier a SecurityCredentialsExtractor a SecurityCredentialsValidator

SecurityContextProviderImpl(TokenEncoder<T>, TokenVerifier<T>, SecurityCredentialsExtractor<T, C>, SecurityCredentialsValidator<C>) - Constructor for class org.sklsft.commons.rest.security.context.impl.SecurityContextProviderImpl

SecurityCredentialsExtractor<T,C> - Interface in org.sklsft.commons.rest.security.credentials.extractor

Provides Credentials from the Token

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

Responsible for credentials validation.

SymetricCryptedTokenEncoder<T> - Class in org.sklsft.commons.rest.security.tokens.encoder.impl

imlementation of a TokenEncoder that uses an ObjectEncoder

SymetricCryptedTokenEncoder(ObjectEncoder, Class<T>) - Constructor for class org.sklsft.commons.rest.security.tokens.encoder.impl.SymetricCryptedTokenEncoder

T

TokenEncoder<T> - Interface in org.sklsft.commons.rest.security.tokens.encoder

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

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

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.extraction

To define an interface linked with a factory TokenExtractorFactory

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

Chooses the correct tokens extractor depending on the TokenExtractionMode

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

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

To extract tokens from Servlet request cookies

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

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

To extract tokens from Servlet request headers

TokenFromHeaderExtractor() - Constructor for class org.sklsft.commons.rest.security.tokens.extraction.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

TokenVerifier<T> - Interface in org.sklsft.commons.rest.security.tokens.verification

U

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

UnsignedTokenVerifier<T> - Class in org.sklsft.commons.rest.security.tokens.verification.impl

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

V

validateCredentials(C) - Method in interface org.sklsft.commons.rest.security.credentials.validator.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.extraction.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.extraction.TokenExtractionMode

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

verifyToken(T) - Method in class org.sklsft.commons.rest.security.tokens.verification.impl.UnsignedTokenVerifier

verifyToken(T) - Method in interface org.sklsft.commons.rest.security.tokens.verification.TokenVerifier

Should be used for JWT signature verification.

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