edu.cornell.mannlib.orcidclient.context

Enum OrcidClientContext.Setting

java.lang.Object

java.lang.Enum<OrcidClientContext.Setting>

edu.cornell.mannlib.orcidclient.context.OrcidClientContext.Setting

All Implemented Interfaces:

Serializable, Comparable<OrcidClientContext.Setting>

Enclosing class:

OrcidClientContext

public static enum OrcidClientContext.Setting
extends Enum<OrcidClientContext.Setting>

Enum Constant Summary

Enum Constants

Enum Constant and Description
API_ENVIRONMENT Environement - public or sandbox
API_VERSION Version - e.g.
CALLBACK_PATH Where should ORCID call back to during the auth dance? Path within this webapp.
CLIENT_ID ID assigned by ORCID to the application.
CLIENT_SECRET Secret code assigned by ORCID to the application.
WEBAPP_BASE_URL The base URL for contacting this webapp (including context path.

Method Summary

Modifier and Type	Method and Description
static OrcidClientContext.Setting	valueOf(String name) Returns the enum constant of this type with the specified name.
static OrcidClientContext.Setting[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CLIENT_ID

public static final OrcidClientContext.Setting CLIENT_ID

ID assigned by ORCID to the application.

CLIENT_SECRET

public static final OrcidClientContext.Setting CLIENT_SECRET

Secret code assigned by ORCID to the application.

API_VERSION

public static final OrcidClientContext.Setting API_VERSION

Version - e.g. 1.2, 2.0

API_ENVIRONMENT

public static final OrcidClientContext.Setting API_ENVIRONMENT

Environement - public or sandbox

WEBAPP_BASE_URL

public static final OrcidClientContext.Setting WEBAPP_BASE_URL

The base URL for contacting this webapp (including context path. Used when building the redirect URL for the browser.

CALLBACK_PATH

public static final OrcidClientContext.Setting CALLBACK_PATH

Where should ORCID call back to during the auth dance? Path within this webapp.

Method Detail

values

public static OrcidClientContext.Setting[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OrcidClientContext.Setting c : OrcidClientContext.Setting.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OrcidClientContext.Setting valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null