eu.europeana.api.commons.oauth2.service

Interface ApiKeyService

public interface ApiKeyService

Method Summary

Modifier and Type	Method and Description
List<ApiKey>	findByApplicationName(String applicationName) Find all API keys by applicationName
ApiKey	findByKey(String apiKey) Find all API keys by ApiKey

Method Detail

findByKey

ApiKey findByKey(String apiKey)
          throws CommonServiceException,
                 CommonServiceRuntimeException

Find all API keys by ApiKey

Parameters:

apiKey - the value of the apiKey

Returns:

matching api key

Throws:

CommonServiceException - catched exception if a logical problem occurs during the execution

CommonServiceRuntimeException - runtime exception if a configuration related exception occur

findByApplicationName

List<ApiKey> findByApplicationName(String applicationName)
                            throws CommonServiceException,
                                   CommonServiceRuntimeException

Find all API keys by applicationName

Parameters:

applicationName - application name registered with the api key(s)

Returns:

all matching api keys

Throws:

CommonServiceException - catched exception if a logical problem occurs during the execution

CommonServiceRuntimeException - runtime exception if a configuration related exception occur