de.samply.common.mdrclient

Class CacheKey

java.lang.Object

de.samply.common.mdrclient.CacheKey

public class CacheKey
extends Object

Key class for the caching of MDR json requests.

Author:

diogo

Constructor Summary

Constructors

Constructor and Description
CacheKey(String path, String languageCode) A key used to identify a cache entry.
CacheKey(String path, String languageCode, String accessToken, String userAuthId) A key used to identify a cache entry.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAccessToken() Get the access token that should be used on REST calls to the MDR when a user is logged in.
String	getLanguageCode() Get the language code for the request.
String	getPath() Get the MDR REST path to call.
String	getUserAuthId() Get the user authentication server id.
int	hashCode()
void	setAccessToken(String accessToken) Set the access token that should be used on REST calls to the MDR when a user is logged in.
void	setLanguageCode(String languageCode) Set the language code for the request.
void	setPath(String path) Set the MDR REST path to call.
void	setUserAuthId(String userAuthId) Set the user authentication server id.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CacheKey

public CacheKey(String path,
                String languageCode)

A key used to identify a cache entry.

Parameters:

path - the MDR REST path to call

languageCode - the language code for the request

CacheKey

public CacheKey(String path,
                String languageCode,
                String accessToken,
                String userAuthId)

A key used to identify a cache entry.

Parameters:

path - the MDR REST path to call

languageCode - the language code for the request

accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.

userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.

Method Detail

getPath

public final String getPath()

Get the MDR REST path to call.

Returns:

the MDR REST path to call

setPath

public final void setPath(String path)

Set the MDR REST path to call.

Parameters:

path - the MDR REST path to call

getLanguageCode

public final String getLanguageCode()

Get the language code for the request.

Returns:

the language code for the request

setLanguageCode

public final void setLanguageCode(String languageCode)

Set the language code for the request.

Parameters:

languageCode - the language code for the request

getAccessToken

public final String getAccessToken()

Get the access token that should be used on REST calls to the MDR when a user is logged in.

Returns:

The access token, obtained from OSSE.Auth.

setAccessToken

public final void setAccessToken(String accessToken)

Set the access token that should be used on REST calls to the MDR when a user is logged in.

Parameters:

accessToken - Access token, obtained from OSSE.Auth.

getUserAuthId

public final String getUserAuthId()

Get the user authentication server id. It is used for the cache loader key - the user specific calls are cached across sessions.

Returns:

The user authentication server id of the user who is logged in, or null for anonymous access.

setUserAuthId

public final void setUserAuthId(String userAuthId)

Set the user authentication server id. It is used for the cache loader key - the user specific calls are cached across sessions.

Parameters:

userAuthId - the user authentication server id of the user who is logged in. Use null for anonymous access.

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object