Package org.wikidata.wdtk.wikibaseapi

Enum LoginValue

java.lang.Object

java.lang.Enum<LoginValue>

org.wikidata.wdtk.wikibaseapi.LoginValue

All Implemented Interfaces:

Serializable, Comparable<LoginValue>, java.lang.constant.Constable

public enum LoginValue
extends Enum<LoginValue>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAILED	String value in the result field of the JSON response if the password was wrong.
LOGIN_BLOCKED	String value in the result field of the JSON response if the user is blocked.
LOGIN_CREATE_BLOCKED	String value in the result field of the JSON response if the wiki tried to automatically create a new account for you, but your IP address has been blocked from account creation.
LOGIN_EMPTY_PASS	String value in the result field of the JSON response if password is empty.
LOGIN_ILLEGAL	String value in the result field of the JSON response if the username is illegal.
LOGIN_NEEDTOKEN	String value in the result field of the JSON response if token or session ID is missing.
LOGIN_NO_NAME	String value in the result field of the JSON response if no username was given.
LOGIN_NOT_EXISTS	String value in the result field of the JSON response if given username does not exist.
LOGIN_RESULT_SUCCESS	String value in the result field of the JSON response if the login was successful.
LOGIN_THROTTLED	String value in the result field of the JSON response if there were too many logins in a short time.
LOGIN_WRONG_PASS	String value in the result field of the JSON response if the password was wrong.
LOGIN_WRONG_PLUGIN_PASS	String value in the result field of the JSON response if the password was rejected by an authentication plugin.
LOGIN_WRONG_TOKEN	String value in the result field of the JSON response if token is wrong.
PARAM_LOGIN_PASSWORD	Name of the HTTP parameter to submit a password to the API.
PARAM_LOGIN_TOKEN	Name of the HTTP parameter to submit a login token to the API.
PARAM_LOGIN_USERNAME	Name of the HTTP parameter to submit a password to the API.
UNKNOWN	Value for unknown response text

Method Summary

Modifier and Type	Method	Description
String	getClientLoginText()
String	getLoginText()
String	getMessage(String loginType)
static LoginValue	of(String text)
static LoginValue	valueOf(String name)	Returns the enum constant of this type with the specified name.
static LoginValue[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PARAM_LOGIN_USERNAME

public static final LoginValue PARAM_LOGIN_USERNAME

Name of the HTTP parameter to submit a password to the API.

PARAM_LOGIN_PASSWORD

public static final LoginValue PARAM_LOGIN_PASSWORD

Name of the HTTP parameter to submit a password to the API.

PARAM_LOGIN_TOKEN

public static final LoginValue PARAM_LOGIN_TOKEN

Name of the HTTP parameter to submit a login token to the API.

LOGIN_RESULT_SUCCESS

public static final LoginValue LOGIN_RESULT_SUCCESS

String value in the result field of the JSON response if the login was successful.

LOGIN_WRONG_PASS

public static final LoginValue LOGIN_WRONG_PASS

String value in the result field of the JSON response if the password was wrong.

FAILED

public static final LoginValue FAILED

String value in the result field of the JSON response if the password was wrong.

LOGIN_WRONG_PLUGIN_PASS

public static final LoginValue LOGIN_WRONG_PLUGIN_PASS

String value in the result field of the JSON response if the password was rejected by an authentication plugin.

LOGIN_NO_NAME

public static final LoginValue LOGIN_NO_NAME

String value in the result field of the JSON response if no username was given.

LOGIN_NOT_EXISTS

public static final LoginValue LOGIN_NOT_EXISTS

String value in the result field of the JSON response if given username does not exist.

LOGIN_ILLEGAL

public static final LoginValue LOGIN_ILLEGAL

String value in the result field of the JSON response if the username is illegal.

LOGIN_THROTTLED

public static final LoginValue LOGIN_THROTTLED

String value in the result field of the JSON response if there were too many logins in a short time.

LOGIN_EMPTY_PASS

public static final LoginValue LOGIN_EMPTY_PASS

String value in the result field of the JSON response if password is empty.

LOGIN_CREATE_BLOCKED

public static final LoginValue LOGIN_CREATE_BLOCKED

String value in the result field of the JSON response if the wiki tried to automatically create a new account for you, but your IP address has been blocked from account creation.

LOGIN_BLOCKED

public static final LoginValue LOGIN_BLOCKED

String value in the result field of the JSON response if the user is blocked.

LOGIN_NEEDTOKEN

public static final LoginValue LOGIN_NEEDTOKEN

String value in the result field of the JSON response if token or session ID is missing.

LOGIN_WRONG_TOKEN

public static final LoginValue LOGIN_WRONG_TOKEN

String value in the result field of the JSON response if token is wrong.

UNKNOWN

public static final LoginValue UNKNOWN

Value for unknown response text

Method Details

values

public static LoginValue[] values()

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

Returns:

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

valueOf

public static LoginValue 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

of

public static LoginValue of(String text)

getLoginText

public String getLoginText()

getClientLoginText

public String getClientLoginText()

getMessage

public String getMessage(String loginType)