A C D E F G H I K M N P R S T U V
All Classes All Packages

A

ANNOTATION - eu.europeana.apikey.util.ApiName

api() - Method in class eu.europeana.apikey.config.SwaggerConfig

ApiKey - Class in eu.europeana.apikey.domain

API key as it is used internally and stored in the database Created by luthien on 18/04/2017.

ApiKey() - Constructor for class eu.europeana.apikey.domain.ApiKey

ApiKey(ApiKey) - Constructor for class eu.europeana.apikey.domain.ApiKey

Constructor with all fields

ApiKey(String, String, String, String, String, String) - Constructor for class eu.europeana.apikey.domain.ApiKey

Constructor with all required fields.

ApiKeyApplication - Class in eu.europeana.apikey

ApiKeyApplication() - Constructor for class eu.europeana.apikey.ApiKeyApplication

ApiKeyController - Class in eu.europeana.apikey.controller

Handles all incoming requests Authentication is done using Keycloak authentication, but additional constraints my be checked (for example if the account is a manager account) Created by luthien on 18/04/2017.

ApiKeyController(ApiKeyRepo, CaptchaManager, CustomKeycloakAuthenticationProvider, MailService, SimpleMailMessage, KeycloakManager) - Constructor for class eu.europeana.apikey.controller.ApiKeyController

ApiKeyDeprecatedException - Exception in eu.europeana.apikey.exception

Exception thrown when trying to perform an action on a deprecated API key

ApiKeyDeprecatedException(String) - Constructor for exception eu.europeana.apikey.exception.ApiKeyDeprecatedException

ApiKeyException - Exception in eu.europeana.apikey.exception

Created by luthien on 01/08/2017.

ApiKeyException(String) - Constructor for exception eu.europeana.apikey.exception.ApiKeyException

ApiKeyException(String, String) - Constructor for exception eu.europeana.apikey.exception.ApiKeyException

ApiKeyException(String, Throwable) - Constructor for exception eu.europeana.apikey.exception.ApiKeyException

ApiKeyException(Throwable) - Constructor for exception eu.europeana.apikey.exception.ApiKeyException

ApiKeyExistsException - Exception in eu.europeana.apikey.exception

Exception thrown when trying to create a new API key for an application name and email address that is already in use

ApiKeyExistsException(String, String) - Constructor for exception eu.europeana.apikey.exception.ApiKeyExistsException

ApiKeyNotDeprecatedException - Exception in eu.europeana.apikey.exception

Exception thrown when trying to enable an API key that was not disabled/deprecated

ApiKeyNotDeprecatedException(String) - Constructor for exception eu.europeana.apikey.exception.ApiKeyNotDeprecatedException

ApiKeyNotFoundException - Exception in eu.europeana.apikey.exception

Exception thrown when there the requested API key cannot be found

ApiKeyNotFoundException(String) - Constructor for exception eu.europeana.apikey.exception.ApiKeyNotFoundException

ApiKeyRepo - Interface in eu.europeana.apikey.repos

ApiKeyRequest - Class in eu.europeana.apikey.domain

API-key object as it is defined for incoming requests (e.g.

ApiKeyRequest() - Constructor for class eu.europeana.apikey.domain.ApiKeyRequest

ApiKeyRequest(String, String, String, String, String) - Constructor for class eu.europeana.apikey.domain.ApiKeyRequest

Constructor with all required fields

ApiKeyRequest(String, String, String, String, String, String, String) - Constructor for class eu.europeana.apikey.domain.ApiKeyRequest

Constructor with all supported fields

ApiKeySecret - Class in eu.europeana.apikey.domain

ApiKey and Secret.

ApiKeySecret(String, String, String, String, String, String, String) - Constructor for class eu.europeana.apikey.domain.ApiKeySecret

ApiName - Enum in eu.europeana.apikey.util

authenticate(String, String) - Method in class eu.europeana.apikey.keycloak.CustomKeycloakAuthenticationProvider

authenticate(Authentication) - Method in class eu.europeana.apikey.keycloak.CustomKeycloakAuthenticationProvider

C

CaptchaException - Exception in eu.europeana.apikey.exception

Exception thrown when the captcha could not be validated

CaptchaException(String) - Constructor for exception eu.europeana.apikey.exception.CaptchaException

CaptchaManager - Class in eu.europeana.apikey.captcha

CaptchaManager() - Constructor for class eu.europeana.apikey.captcha.CaptchaManager

ClasspathResourceUtils - Class in eu.europeana.apikey.util

clean() - Method in class eu.europeana.apikey.keycloak.KeycloakManager

close() - Method in class eu.europeana.apikey.captcha.CaptchaManager

configure(HttpSecurity) - Method in class eu.europeana.apikey.config.SecurityConfig

context - Variable in class eu.europeana.apikey.keycloak.KeycloakPrincipal

create(ApiKeyRequest) - Method in class eu.europeana.apikey.controller.ApiKeyController

Create a new API key with the following mandatory values supplied in a JSON request body: - firstName - lastName - email - appName - company The following fields are optional: - website - sector The ApiKey field is generated as a unique and random 'readable' lowercase string 8 to 12 characters long, e.g.

createCaptcha(HttpServletRequest, ApiKeyRequest) - Method in class eu.europeana.apikey.controller.ApiKeyController

Create a new API key with the following mandatory values supplied in a JSON request body: - firstName - lastName - email - appName - company The following fields are optional: - website - sector The ApiKey field is generated as a unique and random 'readable' lowercase string 8 to 12 characters long, e.g.

createClient(KeycloakSecurityContext, ApiKeyRequest) - Method in class eu.europeana.apikey.keycloak.KeycloakManager

Create a new client in Keycloak.

CustomKeycloakAuthenticationProvider - Class in eu.europeana.apikey.keycloak

Authentication provider used to authenticate clients following the client credentials grant type

CustomKeycloakAuthenticationProvider(KeycloakManager) - Constructor for class eu.europeana.apikey.keycloak.CustomKeycloakAuthenticationProvider

D

delete(String) - Method in class eu.europeana.apikey.controller.ApiKeyController

This method deletes BOTH the apikey identified by the supplied string AND the linked Keycloak client.

deleteClient(KeycloakSecurityContext, String) - Method in class eu.europeana.apikey.keycloak.KeycloakManager

Deletes a client from Keycloak

deleteSynchronize(String) - Method in class eu.europeana.apikey.controller.ApiKeyController

This method deletes ONLY the apikey identified by the linked Keycloak client ID aka "secret key".

disable(String) - Method in class eu.europeana.apikey.controller.ApiKeyController

Disables / deprecates a given ApiKey.

disableClient(String, KeycloakSecurityContext) - Method in class eu.europeana.apikey.keycloak.KeycloakManager

Disables the client in Keycloak, but only if it is enabled

doLog() - Method in exception eu.europeana.apikey.exception.ApiKeyException

doLogStacktrace() - Method in exception eu.europeana.apikey.exception.ApiKeyDeprecatedException

doLogStacktrace() - Method in exception eu.europeana.apikey.exception.ApiKeyException

doLogStacktrace() - Method in exception eu.europeana.apikey.exception.ApiKeyExistsException

doLogStacktrace() - Method in exception eu.europeana.apikey.exception.ApiKeyNotDeprecatedException

doLogStacktrace() - Method in exception eu.europeana.apikey.exception.ApiKeyNotFoundException

doLogStacktrace() - Method in exception eu.europeana.apikey.exception.ForbiddenException

doLogStacktrace() - Method in exception eu.europeana.apikey.exception.KCClientExistsException

doLogStacktrace() - Method in exception eu.europeana.apikey.exception.KCIdNotEmptyException

doLogStacktrace() - Method in exception eu.europeana.apikey.exception.MissingDataException

doLogStacktrace() - Method in exception eu.europeana.apikey.exception.MissingKCClientException

doLogStacktrace() - Method in exception eu.europeana.apikey.exception.MissingKeyException

E

email - Variable in class eu.europeana.apikey.domain.ApiKey

emailSender - Variable in class eu.europeana.apikey.mail.MailService

enable(String) - Method in class eu.europeana.apikey.controller.ApiKeyController

Re-enables a given invalid ApiKey (of which the deprecationdate column has previously been set to a past time).

enableClient(String, KeycloakSecurityContext) - Method in class eu.europeana.apikey.keycloak.KeycloakManager

Enables the client in Keycloak, but only if it was disabled

ENTITY - eu.europeana.apikey.util.ApiName

equals(Object) - Method in class eu.europeana.apikey.keycloak.KeycloakPrincipal

eu.europeana.apikey - package eu.europeana.apikey

eu.europeana.apikey.captcha - package eu.europeana.apikey.captcha

eu.europeana.apikey.config - package eu.europeana.apikey.config

eu.europeana.apikey.controller - package eu.europeana.apikey.controller

eu.europeana.apikey.domain - package eu.europeana.apikey.domain

eu.europeana.apikey.exception - package eu.europeana.apikey.exception

eu.europeana.apikey.keycloak - package eu.europeana.apikey.keycloak

eu.europeana.apikey.mail - package eu.europeana.apikey.mail

eu.europeana.apikey.repos - package eu.europeana.apikey.repos

eu.europeana.apikey.util - package eu.europeana.apikey.util

F

findAll() - Method in interface eu.europeana.apikey.repos.ApiKeyRepo

findAllKeysToMigrate() - Method in interface eu.europeana.apikey.repos.ApiKeyRepo

findByEmail(String) - Method in interface eu.europeana.apikey.repos.ApiKeyRepo

findByEmailAndAppName(String, String) - Method in interface eu.europeana.apikey.repos.ApiKeyRepo

findByKeycloakId(String) - Method in interface eu.europeana.apikey.repos.ApiKeyRepo

ForbiddenException - Exception in eu.europeana.apikey.exception

Exception thrown when there is not enough information, e.g.

ForbiddenException() - Constructor for exception eu.europeana.apikey.exception.ForbiddenException

ForbiddenException(String) - Constructor for exception eu.europeana.apikey.exception.ForbiddenException

G

generate(int) - Method in class eu.europeana.apikey.util.PassGenerator

Generates a new password.

generatePassPhrase(int) - Static method in class eu.europeana.apikey.util.Tools

getActivationDate() - Method in class eu.europeana.apikey.domain.ApiKey

getApiKey() - Method in class eu.europeana.apikey.domain.ApiKey

getAppName() - Method in class eu.europeana.apikey.domain.ApiKey

getAppName() - Method in class eu.europeana.apikey.domain.ApiKeyRequest

getAuthServerUrl() - Method in class eu.europeana.apikey.config.KeycloakProperties

getClientSecret() - Method in class eu.europeana.apikey.domain.ApiKeySecret

getCompany() - Method in class eu.europeana.apikey.domain.ApiKey

getCompany() - Method in class eu.europeana.apikey.domain.ApiKeyRequest

getCredentials() - Method in class eu.europeana.apikey.keycloak.KeycloakAuthenticationToken

getDeprecationDate() - Method in class eu.europeana.apikey.domain.ApiKey

getEmail() - Method in class eu.europeana.apikey.domain.ApiKey

getEmail() - Method in class eu.europeana.apikey.domain.ApiKeyRequest

getError() - Method in exception eu.europeana.apikey.exception.ApiKeyException

getFirstName() - Method in class eu.europeana.apikey.domain.ApiKey

getFirstName() - Method in class eu.europeana.apikey.domain.ApiKeyRequest

getKeycloakId() - Method in class eu.europeana.apikey.domain.ApiKey

getLastAccessDate() - Method in class eu.europeana.apikey.domain.ApiKey

getLastName() - Method in class eu.europeana.apikey.domain.ApiKey

getLastName() - Method in class eu.europeana.apikey.domain.ApiKeyRequest

getManagerClientId() - Method in class eu.europeana.apikey.config.KeycloakProperties

getManagerClientSecret() - Method in class eu.europeana.apikey.config.KeycloakProperties

getMessage() - Method in exception eu.europeana.apikey.exception.ApiKeyException

getName() - Method in class eu.europeana.apikey.keycloak.KeycloakPrincipal

getPrincipal() - Method in class eu.europeana.apikey.keycloak.KeycloakAuthenticationToken

getPublicKey() - Method in class eu.europeana.apikey.keycloak.KeycloakTokenVerifier

Return the realm public key

getRealm() - Method in class eu.europeana.apikey.config.KeycloakProperties

getRealmPublicKey() - Method in class eu.europeana.apikey.config.KeycloakProperties

getRegistrationDate() - Method in class eu.europeana.apikey.domain.ApiKey

getResourceContentFromPath(String) - Static method in class eu.europeana.apikey.util.ClasspathResourceUtils

Get a resource in classpath as a String

getSector() - Method in class eu.europeana.apikey.domain.ApiKey

getSector() - Method in class eu.europeana.apikey.domain.ApiKeyRequest

getStatus() - Method in exception eu.europeana.apikey.exception.ApiKeyException

getTimestamp() - Method in exception eu.europeana.apikey.exception.ApiKeyException

getWebsite() - Method in class eu.europeana.apikey.domain.ApiKey

getWebsite() - Method in class eu.europeana.apikey.domain.ApiKeyRequest

GlobalExceptionHandler - Class in eu.europeana.apikey.exception

Global exception handler that catches all errors and logs the interesting ones

GlobalExceptionHandler() - Constructor for class eu.europeana.apikey.exception.GlobalExceptionHandler

H

handleApiKeyException(HttpServletResponse, ApiKeyException) - Method in class eu.europeana.apikey.exception.GlobalExceptionHandler

Checks if we should log an error (and its stacktrace) and rethrows it

hashCode() - Method in class eu.europeana.apikey.keycloak.KeycloakPrincipal

I

init() - Method in class eu.europeana.apikey.captcha.CaptchaManager

init() - Method in class eu.europeana.apikey.keycloak.KeycloakManager

isManagerClientAuthorized(KeycloakAuthenticationToken) - Method in class eu.europeana.apikey.keycloak.KeycloakManager

Checks whether the token was issued for a manager client

isOwner(String, KeycloakAuthenticationToken) - Method in class eu.europeana.apikey.keycloak.KeycloakManager

Checks whether the client for which the token was issued is the owner of the apikey

isUseResourceRoleMappings() - Method in class eu.europeana.apikey.config.KeycloakProperties

K

KCClientExistsException - Exception in eu.europeana.apikey.exception

Exception thrown when we try to create a keycloak client that already exists

KCClientExistsException(String) - Constructor for exception eu.europeana.apikey.exception.KCClientExistsException

KCIdNotEmptyException - Exception in eu.europeana.apikey.exception

Exception thrown when we try to recreate a keycloak client for an apikey that already has a keycloakId set

KCIdNotEmptyException(String, String) - Constructor for exception eu.europeana.apikey.exception.KCIdNotEmptyException

KeycloakAuthenticationToken - Class in eu.europeana.apikey.keycloak

KeycloakAuthenticationToken(KeycloakPrincipal<KeycloakSecurityContext>) - Constructor for class eu.europeana.apikey.keycloak.KeycloakAuthenticationToken

KeycloakManager - Class in eu.europeana.apikey.keycloak

Class for working with Keycloak and it's Rest Admin API.
Note that there are 2 client id's used by keycloak: ClientId which is the same as an apikey (string) id which is an internal id (hash) of the client.

KeycloakManager(KeycloakProperties) - Constructor for class eu.europeana.apikey.keycloak.KeycloakManager

KeycloakPrincipal<T extends KeycloakSecurityContext> - Class in eu.europeana.apikey.keycloak

This class implements Principal interface used in Spring security.

KeycloakProperties - Class in eu.europeana.apikey.config

Central location where all (or most) configuration settings are loaded.

KeycloakProperties() - Constructor for class eu.europeana.apikey.config.KeycloakProperties

KeycloakProperties(String, String, boolean, String) - Constructor for class eu.europeana.apikey.config.KeycloakProperties

KeycloakSecurityContext - Class in eu.europeana.apikey.keycloak

KeycloakTokenVerifier - Class in eu.europeana.apikey.keycloak

Class used for verifying token signature.

KeycloakTokenVerifier(String) - Constructor for class eu.europeana.apikey.keycloak.KeycloakTokenVerifier

M

MailService - Class in eu.europeana.apikey.mail

Created by luthien on 04/07/2017.

MailService() - Constructor for class eu.europeana.apikey.mail.MailService

main(String[]) - Static method in class eu.europeana.apikey.ApiKeyApplication

MissingDataException - Exception in eu.europeana.apikey.exception

Exception thrown when there is not enough information, e.g.

MissingDataException(String, String) - Constructor for exception eu.europeana.apikey.exception.MissingDataException

MissingKCClientException - Exception in eu.europeana.apikey.exception

Exception thrown when the keycloak client could not be found

MissingKCClientException(String) - Constructor for exception eu.europeana.apikey.exception.MissingKCClientException

MissingKeyException - Exception in eu.europeana.apikey.exception

Exception thrown when no API key was specified (in a validate request)

MissingKeyException(String) - Constructor for exception eu.europeana.apikey.exception.MissingKeyException

N

name - Variable in class eu.europeana.apikey.keycloak.KeycloakPrincipal

nvl(Long) - Static method in class eu.europeana.apikey.util.Tools

nvl(String) - Static method in class eu.europeana.apikey.util.Tools

nvl(Date) - Static method in class eu.europeana.apikey.util.Tools

P

PassGenerator - Class in eu.europeana.apikey.util

Created by luthien on 03/07/2017.

PassGenerator() - Constructor for class eu.europeana.apikey.util.PassGenerator

R

read(String) - Method in class eu.europeana.apikey.controller.ApiKeyController

Retrieves the details associated with the registration of a given ApiKey

recreateClient(KeycloakSecurityContext, String, ApiKeyRequest) - Method in class eu.europeana.apikey.keycloak.KeycloakManager

Used for creating a new keycloak client based on an already existing apikey (missing client synchronization)

S

SEARCH - eu.europeana.apikey.util.ApiName

SecurityConfig - Class in eu.europeana.apikey.config

SecurityConfig() - Constructor for class eu.europeana.apikey.config.SecurityConfig

SendMailException - Exception in eu.europeana.apikey.exception

Exception thrown when an email cannot be sent (e.g.

SendMailException(String, Throwable) - Constructor for exception eu.europeana.apikey.exception.SendMailException

sendSimpleMessageUsingTemplate(String, String, SimpleMailMessage, String...) - Method in class eu.europeana.apikey.mail.MailService

setActivationDate(Date) - Method in class eu.europeana.apikey.domain.ApiKey

setApiKey(String) - Method in class eu.europeana.apikey.domain.ApiKey

setAppName(String) - Method in class eu.europeana.apikey.domain.ApiKey

setAuthServerUrl(String) - Method in class eu.europeana.apikey.config.KeycloakProperties

setCompany(String) - Method in class eu.europeana.apikey.domain.ApiKey

setDeprecationDate(Date) - Method in class eu.europeana.apikey.domain.ApiKey

setEmail(String) - Method in class eu.europeana.apikey.domain.ApiKey

setFirstName(String) - Method in class eu.europeana.apikey.domain.ApiKey

setKeycloakId(String) - Method in class eu.europeana.apikey.domain.ApiKey

setLastAccessDate(Date) - Method in class eu.europeana.apikey.domain.ApiKey

setLastName(String) - Method in class eu.europeana.apikey.domain.ApiKey

setManagerClientId(String) - Method in class eu.europeana.apikey.config.KeycloakProperties

setManagerClientSecret(String) - Method in class eu.europeana.apikey.config.KeycloakProperties

setRealm(String) - Method in class eu.europeana.apikey.config.KeycloakProperties

setRealmPublicKey(String) - Method in class eu.europeana.apikey.config.KeycloakProperties

setRegistrationDate(Date) - Method in class eu.europeana.apikey.domain.ApiKey

setSector(String) - Method in class eu.europeana.apikey.domain.ApiKey

setUseResourceRoleMappings(boolean) - Method in class eu.europeana.apikey.config.KeycloakProperties

setWebsite(String) - Method in class eu.europeana.apikey.domain.ApiKey

supports(Class<?>) - Method in class eu.europeana.apikey.keycloak.CustomKeycloakAuthenticationProvider

SwaggerConfig - Class in eu.europeana.apikey.config

Configures swagger on all requests.

SwaggerConfig() - Constructor for class eu.europeana.apikey.config.SwaggerConfig

synchronizeAllMissingClients() - Method in class eu.europeana.apikey.controller.ApiKeyController

This method can be called by a system administrator to automatically create clients in Keycloak for all API keys that do not have a Keycloak client yet.

synchronizeMissingClient(String) - Method in class eu.europeana.apikey.controller.ApiKeyController

This method can be called by a system administrator to automatically create a client in Keycloak for the provided API key.

T

TO_MIGRATE_KEYCLOAKID - Static variable in class eu.europeana.apikey.controller.ApiKeyController

Tools - Class in eu.europeana.apikey.util

toString() - Method in class eu.europeana.apikey.domain.ApiKey

toString() - Method in class eu.europeana.apikey.keycloak.KeycloakPrincipal

toString() - Method in enum eu.europeana.apikey.util.ApiName

U

update(String, ApiKeyRequest) - Method in class eu.europeana.apikey.controller.ApiKeyController

Changes the registration details of an existing API key for the following public and non-generated values when supplied in the JSON request body: - firstName - lastName - email - company - appName - sector

updateClient(KeycloakSecurityContext, ApiKeyRequest, String) - Method in class eu.europeana.apikey.keycloak.KeycloakManager

Create a new client in Keycloak.

V

validate(HttpServletRequest) - Method in class eu.europeana.apikey.controller.ApiKeyController

Validates a given ApiKey.

valueOf(String) - Static method in enum eu.europeana.apikey.util.ApiName

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

values() - Static method in enum eu.europeana.apikey.util.ApiName

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

verifyCaptchaToken(String) - Method in class eu.europeana.apikey.captcha.CaptchaManager

Verify Captcha token by sending request to the verification URL.

View - Class in eu.europeana.apikey.domain

This class supports using @Jsonview annotations, used to filter fields of the ApiKey to be displayed

View() - Constructor for class eu.europeana.apikey.domain.View

View.Public - Interface in eu.europeana.apikey.domain

A C D E F G H I K M N P R S T U V
All Classes All Packages