eu.europeana.apikey.client

Class Connector

java.lang.Object

eu.europeana.apikey.client.Connector

public class Connector
extends Object

Utility to facilitate connecting to the Apikey Service and checking Apikeys for validity

Constructor Summary

Constructors

Constructor and Description
Connector()

Method Summary

Modifier and Type	Method and Description
ValidationResult	validateApiKey(String adminKey, String adminSecretKey, String apikey, String api) Wrapper method without the method parameter
ValidationResult	validateApiKey(String adminKey, String adminSecretKey, String apikey, String api, String method) convenience method for validateApiKey() method that creates the ValidationRequest object with separate parameters
ValidationResult	validateApiKey(ValidationRequest validationRequest) Takes a ValidationRequest object containing the authentication details, the apikey to be checked, the calling API and the method (optional).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Connector

public Connector()

Method Detail

validateApiKey

public ValidationResult validateApiKey(ValidationRequest validationRequest)
                                throws ApiKeyValidationException

Takes a ValidationRequest object containing the authentication details, the apikey to be checked, the calling API and the method (optional). Returns a ValidationResult object containing the HTTP status returned by the Apikey Service, the remaining number of requests for this period, the number of seconds until that number is reset, possible error messages plus booleans representing the validity of the ApiKey, the connection status and a discriminator between a 404 status caused by 'page not found' and one caused by 'Apikey not found'

Parameters:

validationRequest - object

Returns:

ValidationResult object

Throws:

ApiKeyValidationException

validateApiKey

public ValidationResult validateApiKey(String adminKey,
                                       String adminSecretKey,
                                       String apikey,
                                       String api,
                                       String method)
                                throws ApiKeyValidationException

convenience method for validateApiKey() method that creates the ValidationRequest object with separate parameters

Parameters:

adminKey - apikey with level set to ADMIN

adminSecretKey - secret key associated with adminKey

apikey - the apikey to be validated

api - the API for which the apikey needs to be validated

method - the method for which the apikey needs to be validated

Returns:

ValidationResult object

Throws:

ApiKeyValidationException

validateApiKey

public ValidationResult validateApiKey(String adminKey,
                                       String adminSecretKey,
                                       String apikey,
                                       String api)
                                throws ApiKeyValidationException

Wrapper method without the method parameter

Parameters:

adminKey - apikey with level set to ADMIN

adminSecretKey - secret key associated with adminKey

apikey - the apikey to be validated

api - the API for which the apikey needs to be validated

Returns:

ValidationResult object

Throws:

ApiKeyValidationException