org.openimaj.util.api.auth

Annotation Type Token

@Retention(value=RUNTIME)
@Target(value=TYPE)
@Documented
public @interface Token

Metadata describing an API token

Author:

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

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name Get the name of the API with which this token is used
String	url Get the URL at which the API parameters can be obtained (usually by the user registering for an account, etc).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	extraInfo Get any additional information about this token or the mechanism by which a user should go about getting the parameters.

Element Detail

name

public abstract String name

Get the name of the API with which this token is used

Returns:

the name of the API with which this token is used

url

public abstract String url

Get the URL at which the API parameters can be obtained (usually by the user registering for an account, etc).

Returns:

the URL at which the API parameters can be obtained.

extraInfo

public abstract String extraInfo

Get any additional information about this token or the mechanism by which a user should go about getting the parameters. This might displayed to the user by a TokenFactory when querying the user for the Parameters required to access the API.

Returns:

additional information about the API and getting the required Parameters.

Default:

""