Index

A B C D E F G H I J K M N P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

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

Create a Keycloak client linked to the supplied Apikey.

ANNOTATION - Enum constant in enum class eu.europeana.apikey.util.ApiName

Annotation api name.

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

constructor

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.

APIKEY_DEPRECATED - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant APIKEY_DEPRECATED.

APIKEY_MISSING - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant APIKEY_MISSING.

APIKEY_NOT_DEPRECATED - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant APIKEY_NOT_DEPRECATED.

APIKEY_NOT_REGISTERED - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant APIKEY_NOT_REGISTERED.

APIKEY_PATTERN - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant APIKEY_PATTERN.

ApiKeyApplication - Class in eu.europeana.apikey

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

ApiKeyController - Class in eu.europeana.apikey.controller

Handles incoming requests for Apikeys that aren't coupled with a Keycloak client Authentication is done using Keycloak authentication, but additional constraints my be checked (for example if the account is a manager account).

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

Constructor

ApikeyDefinitions - Class in eu.europeana.apikey.config

Created by luthien on 10/11/2020.

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

Instantiates a new Api key deprecated exception.

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

Instantiates a new Api key exists exception.

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

Instantiates a new Api key not deprecated exception.

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

Instantiates a new Api key not found exception.

ApiKeyRepo - Interface in eu.europeana.apikey.repos

The interface Api key repo.

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

Instantiates a new Api key request.

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

ApiName - Enum Class in eu.europeana.apikey.util

The enum Api name.

AUTH_FAILED_CLIENT - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant AUTH_FAILED_CLIENT.

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

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

Authenticate admin client authentication.

authenticateClient(String, String) - Method in class eu.europeana.apikey.keycloak.KeycloakClientManager

Authenticate the client that executed the request.

B

BAD_EMAIL_FORMAT - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant BAD_EMAIL_FORMAT.

BuildInfo - Class in eu.europeana.apikey.config

Makes build information and the application name and description from the project's pom.xml available.

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

C

CAPTCHA_MISSING - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant CAPTCHA_MISSING.

CAPTCHA_PATTERN - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant CAPTCHA_PATTERN.

CAPTCHA_VERIFICATION_FAILED - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant CAPTCHA_VERIFICATION_FAILED.

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

Instantiates a new Captcha exception.

CaptchaManager - Class in eu.europeana.apikey.captcha

The type Captcha manager.

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

checkifClientExists(String, KeycloakSecurityContext) - Method in class eu.europeana.apikey.keycloak.KeycloakClientManager

Check whether the client with a given clientId (apiKey) exists in Keycloak, and if so, return its id

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

Check if key exists api key.

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

Check key deprecated.

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

Check key email app name exist.

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

Check manager credentials keycloak authentication token.

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

Check manager or owner credentials.

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

Check mandatory fields and trim api key request.

ClasspathResourceUtils - Class in eu.europeana.apikey.util

The type Classpath resource utils.

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

Clean.

CLIENT_DESCRIPTION - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

Template for client description

CLIENT_IS_ALREADY - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant CLIENT_IS_ALREADY.

CLIENT_NAME - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

Template for client name

CLIENT_NO_MANAGER - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant CLIENT_NO_MANAGER.

CLIENT_SECRET_ENDPOINT - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

Template for client-secret endpoint

CLIENTS_ENDPOINT - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

Template for clients endpoint

CLIENTS_UPDATE_ENDPOINT - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

Template for clients update endpoint

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

Close.

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

configureMessageConverters(List<HttpMessageConverter<?>>) - Method in class eu.europeana.apikey.config.WebMvcConfig

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

The Context.

copyValuesToApiKey(ApiKey, ApiKeyRequest) - Method in class eu.europeana.apikey.controller.ApiKeyController

Copy values to api key.

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

createClient(KeycloakSecurityContext, ApiKey) - Method in class eu.europeana.apikey.keycloak.KeycloakClientManager

Creates a new Keycloak client linked to the provided Apikey.

createKey(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

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

Create a new API key - Keycloak Client pair, with the following mandatory values supplied in a JSON request body: - firstName - lastName - email - appName - company

CustomKeycloakAuthenticationProvider - Class in eu.europeana.apikey.keycloak

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

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

Instantiates a new Custom keycloak authentication provider.

D

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

This method deletes the apikey identified by the supplied string.

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

Deletes a client from Keycloak

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

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

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

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

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

Email address

EMAIL_APPNAME_EXISTS - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant EMAIL_APPNAME_EXISTS.

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

The Email sender.

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

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

ENTITY - Enum constant in enum class eu.europeana.apikey.util.ApiName

Entity api name.

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

ERROR_COMMUNICATING_WITH_KEYCLOAK - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant ERROR_COMMUNICATING_WITH_KEYCLOAK.

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

Deprecated.

(The migration feature for all apikeys to Keycloak clients was abandoned)

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

Find by email optional.

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

Find by email and app name list.

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

Find by keycloak id optional.

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

Instantiates a new Forbidden exception.

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

Instantiates a new Forbidden exception.

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

Instantiates a new Forbidden exception.

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

Generate pass phrase string.

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

Generate a new Apikey (public ID).

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

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

getAppDescription() - Method in class eu.europeana.apikey.config.BuildInfo

Gets app description.

getAppName() - Method in class eu.europeana.apikey.config.BuildInfo

Gets app name.

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

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

Gets app name.

getAppVersion() - Method in class eu.europeana.apikey.config.BuildInfo

Gets app version.

getAuthorities(AccessToken) - Method in class eu.europeana.apikey.keycloak.KeycloakClientManager

Get resource authorities from the access token

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

Gets auth server url.

getBuildNumber() - Method in class eu.europeana.apikey.config.BuildInfo

Gets build number.

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

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

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

Gets company.

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

Gets email.

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

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

Gets first name.

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

For combined api keys / keycloak clients only

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

Gets last name.

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

Gets master public key.

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

Gets realm.

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

Gets realm public key.

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

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

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

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

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

getResponseStatus() - Method in exception eu.europeana.apikey.exception.CaptchaException

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

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

getResponseStatus() - Method in exception eu.europeana.apikey.exception.KCException

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

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

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

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

getResponseStatus() - Method in exception eu.europeana.apikey.exception.SendMailException

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

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

Gets sector.

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

Gets status.

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

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

Gets website.

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

handleException(HttpMessageNotReadableException, HttpServletRequest) - Method in class eu.europeana.apikey.exception.GlobalExceptionHandler

Handle exception response entity.

handleInvalidMediaType(HttpMediaTypeNotSupportedException, HttpServletRequest) - Method in class eu.europeana.apikey.exception.GlobalExceptionHandler

Handle invalid media type response entity.

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

I

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

Init.

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

Init.

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

Checks whether the token was issued for a manager client

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

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

Is use resource role mappings boolean.

J

jacksonMessageConverter() - Method in class eu.europeana.apikey.config.WebMvcConfig

Jackson message converter mapping jackson 2 http message converter.

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

Instantiates a new Kc client exists exception.

KCException - Exception in eu.europeana.apikey.exception

Exception thrown when there are problems communicating with Keycloak

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

Instantiates a new Kc exception.

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

Instantiates a new Kc exception.

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

Instantiates a new Kc id not empty exception.

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

Instantiates a new Kc id not empty exception.

KeycloakAuthenticationToken - Class in eu.europeana.apikey.keycloak

The type Keycloak authentication token.

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

Instantiates a new Keycloak authentication token.

KeycloakAuthenticationToken(KeycloakPrincipal<KeycloakSecurityContext>, Collection<? extends GrantedAuthority>) - Constructor for class eu.europeana.apikey.keycloak.KeycloakAuthenticationToken

Instantiates a new Keycloak authentication token.

KeycloakClientManager - Class in eu.europeana.apikey.keycloak

Class for working with Keycloak and it's Rest Admin API.

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

Instantiates a new Keycloak client manager.

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

Instantiates a new Keycloak properties.

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

Instantiates a new Keycloak properties.

KeycloakSecurityContext - Class in eu.europeana.apikey.keycloak

The type Keycloak security context.

KeycloakTokenVerifier - Class in eu.europeana.apikey.keycloak

Class used for verifying token signature.

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

Instantiates a new Keycloak token verifier.

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

Instantiates a new Keycloak token verifier.

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

MANAGE_CLIENTS_ROLE - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

Role for managing clients used to authorize access by Manager Client

MISSING_PARAMETER - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant MISSING_PARAMETER.

MissingDataException - Exception in eu.europeana.apikey.exception

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

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

Instantiates a new Missing data exception.

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

Instantiates a new Missing kc client exception.

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

Instantiates a new Missing key exception.

N

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

The Name.

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

Nvl string.

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

Nvl string.

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

Nvl string.

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

RECEIVED - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant RECEIVED.

RETRIEVE_TOKEN_FAILED_FOR - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant RETRIEVE_TOKEN_FAILED_FOR.

S

SEARCH - Enum constant in enum class eu.europeana.apikey.util.ApiName

Search api name.

SecurityConfig - Class in eu.europeana.apikey.config

The type Security config.

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

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

Send api key and client email.

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

Send api key email.

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

Send deleted user email boolean.

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

Instantiates a new Send mail exception.

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

Send user problem email boolean.

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

Sets auth server url.

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

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

For combined api keys / keycloak clients only

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

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

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

Sets master public key.

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

Sets realm.

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

Sets realm public key.

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

Sets use resource role mappings.

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

SpringDocConfig - Class in eu.europeana.apikey.config

The type Spring doc config.

SpringDocConfig(BuildInfo) - Constructor for class eu.europeana.apikey.config.SpringDocConfig

Initialize SpringDoc with API build information

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

T

TO_MIGRATE_KEYCLOAKID - Static variable in class eu.europeana.apikey.config.ApikeyDefinitions

The constant TO_MIGRATE_KEYCLOAKID.

Tools - Class in eu.europeana.apikey.util

The type Tools.

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

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

toString() - Method in enum class 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:

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

Updates the client representation with the new values supplied with the update request.

userServiceOpenAPI() - Method in class eu.europeana.apikey.config.SpringDocConfig

User service open api open api.

V

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

Validates a given ApiKey.

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

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

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

Returns an array containing the constants of this enum class, 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

Public constructor .

W

WebMvcConfig - Class in eu.europeana.apikey.config

The type Web mvc config.

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

A B C D E F G H I J K M N P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form