org.openimaj.util.api.auth

Class DefaultTokenFactory

java.lang.Object

org.openimaj.util.api.auth.DefaultTokenFactory

All Implemented Interfaces:

TokenFactory

public class DefaultTokenFactory
extends Object
implements TokenFactory

Default implementation of a TokenFactory that loads the token parameters from the default Java user preference store or interactively queries the user for the required token parameters if the token has not been used before.

Interactive querying is performed via the command-line (using System.err for prompts and System.in for reading user input. As such, this class will only be really useful for interactive querying in console applications. It is possible however to just use this class for manually storing and retrieving tokens with the appropriate methods.

For this class to work in interactive mode, the token class must have a public no-args constructor.

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
<T> void	deleteToken(Class<T> tokenClass) Delete the default token parameters for the given class from the store.
<T> void	deleteToken(Class<T> tokenClass, String name) Delete the named token parameters for the given class from the store.
static <T> T	get(Class<T> tokenClass) Convenience method equivalent to getInstance().getToken(tokenClass).
static <T> T	get(Class<T> tokenClass, String name) Convenience method equivalent to getInstance().getToken(tokenClass, name).
static DefaultTokenFactory	getInstance() Get the default singleton instance
<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.
<T> T	loadToken(Class<T> clz, String name) Load a token with an optional name tag from the backing store.
<T> void	saveToken(T token, String name) Save the parameters of the given token to the backing preference store.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DefaultTokenFactory getInstance()

Get the default singleton instance

Returns:

the default instance

deleteToken

public <T> void deleteToken(Class<T> tokenClass)
                 throws BackingStoreException

Delete the default token parameters for the given class from the store.

Parameters:

tokenClass - the token class

Throws:

BackingStoreException - if a problem occurred communicating with the backing preference store

deleteToken

public <T> void deleteToken(Class<T> tokenClass,
                   String name)
                 throws BackingStoreException

Delete the named token parameters for the given class from the store.

Parameters:

tokenClass - the token class

name - the name of the token, or null for the default token

Throws:

BackingStoreException - if a problem occurred communicating with the backing preference store

getToken

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

Description copied from interface: TokenFactory

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.

Specified by:

getToken in interface TokenFactory

Parameters:

tokenClass - the class of the token to build

Returns:

the token

getToken

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

Description copied from interface: TokenFactory

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.

Specified by:

getToken in interface TokenFactory

Parameters:

tokenClass - the class of the token to build

name - the name of the token

Returns:

the token

saveToken

public <T> void saveToken(T token,
                 String name)
               throws IllegalArgumentException,
                      IllegalAccessException,
                      BackingStoreException

Save the parameters of the given token to the backing preference store.

Parameters:

token - the token to save

name - the name of the token, or null for the default

Throws:

IllegalArgumentException - if the token class isn't annotated with Token.

IllegalAccessException - if an error occurred reading a parameter of the token

BackingStoreException - if a problem occurred communicating with the backing preference store

loadToken

public <T> T loadToken(Class<T> clz,
              String name)
            throws BackingStoreException,
                   InstantiationException,
                   IllegalAccessException

Load a token with an optional name tag from the backing store.

Parameters:

clz - the class of the token

name - the name of the token, or null for the default token

Returns:

a token loaded with the previously saved parameters, or null if the token could not be read

Throws:

BackingStoreException - if a problem occurred communicating with the backing preference store

InstantiationException - if the token could not be constructed

IllegalAccessException - if an error occurred setting a parameter

get

public static <T> T get(Class<T> tokenClass)

Convenience method equivalent to getInstance().getToken(tokenClass).

Parameters:

tokenClass - the class of the token to build

Returns:

the token

See Also:

getToken(Class)

get

public static <T> T get(Class<T> tokenClass,
        String name)

Convenience method equivalent to getInstance().getToken(tokenClass, name).

Parameters:

tokenClass - the class of the token to build

name - the name of the token

Returns:

the token

See Also:

getToken(Class, String)