org.openimaj.util.api.auth

Interface TokenFactory

All Known Implementing Classes:

DefaultTokenFactory

public interface TokenFactory

Interface describing a class capable of providing API tokens. See the DefaultTokenFactory for an implementation that stores tokens in the Java Preference system and can interactively query the user for the required parameters if they don't have a saved token.

The tokens produced by a TokenFactory must be instances of a class which is annotated with Token, and with fields annotated with Parameter.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	getToken(Class<T> tokenClass) Get the default token for the given class.
<T> T	getToken(Class<T> tokenClass, String name) Get the token for the given class, tagged with a specific name.

Method Detail

getToken

<T> T getToken(Class<T> tokenClass)

Get the default token for the given class.

If a predefined token is unavailable, the token might be built by the underlying implementation; for example by interacting with the user.

Parameters:

tokenClass - the class of the token to build

Returns:

the token

getToken

<T> T getToken(Class<T> tokenClass,
             String name)

Get the token for the given class, tagged with a specific name. This is useful if you have are multiple authentication tokens for the same API and want to refer to a specific one.

If a predefined token is unavailable, the token might be built by the underlying implementation; for example by interacting with the user.

Parameters:

tokenClass - the class of the token to build

name - the name of the token

Returns:

the token