Uses of Class
eu.europeana.apikey.exception.ApiKeyException

Packages that use ApiKeyException

Package	Description
eu.europeana.apikey.captcha
eu.europeana.apikey.controller
eu.europeana.apikey.exception
eu.europeana.apikey.keycloak

Uses of ApiKeyException in eu.europeana.apikey.captcha

Methods in eu.europeana.apikey.captcha that throw ApiKeyException

Modifier and Type	Method	Description
boolean	CaptchaManager.verifyCaptchaToken(String captchaToken)	Verify Captcha token by sending request to the verification URL.

Uses of ApiKeyException in eu.europeana.apikey.controller

Methods in eu.europeana.apikey.controller that throw ApiKeyException

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity	ApiKeyController.create(ApiKeyRequest newKeyRequest)	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.
org.springframework.http.ResponseEntity	ApiKeyController.createCaptcha(javax.servlet.http.HttpServletRequest httpServletRequest, ApiKeyRequest newKeyRequest)	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.
org.springframework.http.ResponseEntity	ApiKeyController.delete(String id)	This method deletes BOTH the apikey identified by the supplied string AND the linked Keycloak client.
org.springframework.http.ResponseEntity	ApiKeyController.disable(String id)	Disables / deprecates a given ApiKey.
ApiKey	ApiKeyController.enable(String id)	Re-enables a given invalid ApiKey (of which the deprecationdate column has previously been set to a past time).
ApiKey	ApiKeyController.read(String id)	Retrieves the details associated with the registration of a given ApiKey
org.springframework.http.ResponseEntity	ApiKeyController.synchronizeAllMissingClients()	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.
org.springframework.http.ResponseEntity	ApiKeyController.synchronizeMissingClient(String apiKey)	This method can be called by a system administrator to automatically create a client in Keycloak for the provided API key.
ApiKey	ApiKeyController.update(String id, ApiKeyRequest apiKeyUpdate)	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
org.springframework.http.ResponseEntity	ApiKeyController.validate(javax.servlet.http.HttpServletRequest httpServletRequest)	Validates a given ApiKey.

Uses of ApiKeyException in eu.europeana.apikey.exception

Subclasses of ApiKeyException in eu.europeana.apikey.exception

Modifier and Type	Class	Description
class	ApiKeyDeprecatedException	Exception thrown when trying to perform an action on a deprecated API key
class	ApiKeyExistsException	Exception thrown when trying to create a new API key for an application name and email address that is already in use
class	ApiKeyNotDeprecatedException	Exception thrown when trying to enable an API key that was not disabled/deprecated
class	ApiKeyNotFoundException	Exception thrown when there the requested API key cannot be found
class	CaptchaException	Exception thrown when the captcha could not be validated
class	ForbiddenException	Exception thrown when there is not enough information, e.g.
class	KCClientExistsException	Exception thrown when we try to create a keycloak client that already exists
class	KCIdNotEmptyException	Exception thrown when we try to recreate a keycloak client for an apikey that already has a keycloakId set
class	MissingDataException	Exception thrown when there is not enough information, e.g.
class	MissingKCClientException	Exception thrown when the keycloak client could not be found
class	MissingKeyException	Exception thrown when no API key was specified (in a validate request)
class	SendMailException	Exception thrown when an email cannot be sent (e.g.

Methods in eu.europeana.apikey.exception with parameters of type ApiKeyException

Modifier and Type	Method	Description
void	GlobalExceptionHandler.handleApiKeyException(javax.servlet.http.HttpServletResponse response, ApiKeyException e)	Checks if we should log an error (and its stacktrace) and rethrows it

Methods in eu.europeana.apikey.exception that throw ApiKeyException

Modifier and Type	Method	Description
void	GlobalExceptionHandler.handleApiKeyException(javax.servlet.http.HttpServletResponse response, ApiKeyException e)	Checks if we should log an error (and its stacktrace) and rethrows it

Uses of ApiKeyException in eu.europeana.apikey.keycloak

Methods in eu.europeana.apikey.keycloak that throw ApiKeyException

Modifier and Type	Method	Description
ApiKeySecret	KeycloakManager.createClient(KeycloakSecurityContext securityContext, ApiKeyRequest requestClient)	Create a new client in Keycloak.
void	KeycloakManager.deleteClient(KeycloakSecurityContext securityContext, String apiKey)	Deletes a client from Keycloak
void	KeycloakManager.disableClient(String clientId, KeycloakSecurityContext securityContext)	Disables the client in Keycloak, but only if it is enabled
void	KeycloakManager.enableClient(String clientId, KeycloakSecurityContext securityContext)	Enables the client in Keycloak, but only if it was disabled
String	KeycloakManager.recreateClient(KeycloakSecurityContext securityContext, String apiKey, ApiKeyRequest requestClient)	Used for creating a new keycloak client based on an already existing apikey (missing client synchronization)
void	KeycloakManager.updateClient(KeycloakSecurityContext securityContext, ApiKeyRequest apiKeyUpdate, String apiKey)	Create a new client in Keycloak.