eu.europeana.api2.v2.utils

Class ControllerUtils

java.lang.Object

eu.europeana.api2.v2.utils.ControllerUtils

public class ControllerUtils
extends Object

Class containing a number of useful controller utilities

Constructor Summary

Constructors

Constructor and Description
ControllerUtils()

Method Summary

Modifier and Type	Method and Description
void	addAccessControlHeaders(javax.servlet.http.HttpServletResponse response) Add the access control headers to the response, allowing origin '*', methods 'POST' and max age '1000'
void	addCharacterEncoding(javax.servlet.http.HttpServletResponse response) Add the 'UTF-8' character encoding to the response
void	addResponseHeaders(javax.servlet.http.HttpServletResponse response) Bundling method for adding both character encoding and access control headers to the response with one call
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

ControllerUtils

public ControllerUtils()

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

apiCall - The REST endpoint of the call

recordType - The type of record, defined by RecordType

profile - The profile used

Returns:

A LimitResponse consisting of the apiKey and current request number

Throws:

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

ApiLimitException

addResponseHeaders

public void addResponseHeaders(javax.servlet.http.HttpServletResponse response)

Bundling method for adding both character encoding and access control headers to the response with one call

Parameters:

response - The response to add the encoding and headers to

addCharacterEncoding

public void addCharacterEncoding(javax.servlet.http.HttpServletResponse response)

Add the 'UTF-8' character encoding to the response

Parameters:

response - The response to add the character encoding to

addAccessControlHeaders

public void addAccessControlHeaders(javax.servlet.http.HttpServletResponse response)

Add the access control headers to the response, allowing origin '*', methods 'POST' and max age '1000'

Parameters:

response - The response to add access control headers to