eu.europeana.api2.v2.utils

Class ApiKeyUtils

java.lang.Object

eu.europeana.api2.v2.utils.ApiKeyUtils

public class ApiKeyUtils
extends Object

Utility class for checking API client keys

Author:

Patrick Ehlert on 13-6-17.

Constructor Summary

Constructors

Constructor and Description
ApiKeyUtils()

Method Summary

Modifier and Type	Method and Description
LimitResponse	checkLimit(String wskey, String url, eu.europeana.corelib.db.entity.enums.RecordType recordType, String profile) Check the number requests made to the API in the last (rolling) 24 hours.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiKeyUtils

public ApiKeyUtils()

Method Detail

checkLimit

public LimitResponse checkLimit(String wskey,
                                String url,
                                eu.europeana.corelib.db.entity.enums.RecordType recordType,
                                String profile)
                         throws ApiLimitException

Check the number requests made to the API in the last (rolling) 24 hours. This is a per-user limit (default: 10000) set in the myEuropeana database that is used as a throttling mechanism.

NOTE: This functionality has currently been disabled (ticket #1742); this method now always returns the user's apikey and a request number of '999' (unless it's a unregistered user).

Parameters:

wskey - The user's API web service key

url - The requested URL

recordType - The type of record, defined by RecordType

profile - The profile used

Returns:

A LimitResponse consisting of the apiKey and current request number

Throws:

ApiLimitException - ApiLimitException if an unregistered or unauthorised key is provided, or if the daily limit has been reached