com.worklight.wlclient.api

Enum WLErrorCode

java.lang.Object

java.lang.Enum<WLErrorCode>

com.worklight.wlclient.api.WLErrorCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WLErrorCode>

public enum WLErrorCode
extends java.lang.Enum<WLErrorCode>

An enumeration of error messages that arrive from the MobileFirst Platform Server.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPLICATION_DISABLED This error code is returned when there is remote disable enabled for the application .(The Access disable option is enabled on Management tab of the application in MobileFirst server console which indicates that the particular app or particular verison of the app is no more available on the server and it pops up a dialogue to upgrade the application .
APPLICATION_NOT_REGISTERED This error is returned when the client tries to set/get client details from the server before the client is registered on the MobileFirst server.
AUTHORIZATION_FAILURE This error is returned due to o-auth process failure, when the client tries to obtain an access token or tries to access a resource from the server.
CHALLENGE_HANDLING_CANCELED This error is returned when a challenge is cancelled midway by invoking an API BaseChallengeHAndler.cancel().
ILLEGAL_ARGUMENT_EXCEPTION This error is returned to indicate that a method has been passed with an illegal or inappropriate argument.
LOGIN_ALREADY_IN_PROCESS This error is returned during the client registration when an attempt is made to login and there is an authorization process to login already in progress.
LOGOUT_ALREADY_IN_PROCESS This error is returned when an attempt is made to logout and there is an authorization process to logout already in progress.
MINIMUM_SERVER This error is returned when the MFP server version is older than 8.0.0.0-IF201701250919 and the client sdk version is the higher than 8.0.0.0-IF201701250919.
MISSING_CHALLENGE_HANDLER This error is returned when the challenge handler is not registered.
REQUEST_TIMEOUT This error is returned when the client tries to connect to the MobileFirst server but the request gets timed out.
SERVER_ERROR This is the default server error.
UNEXPECTED_ERROR This error is returned when the server is reachable but the client does not receive a valid response from the server.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() This method retrieves the WLErrorCode message.
static WLErrorCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WLErrorCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNEXPECTED_ERROR

public static final WLErrorCode UNEXPECTED_ERROR

This error is returned when the server is reachable but the client does not receive a valid response from the server. Use WLFailResponse.getErrorMsg to get more information about the error.

REQUEST_TIMEOUT

public static final WLErrorCode REQUEST_TIMEOUT

This error is returned when the client tries to connect to the MobileFirst server but the request gets timed out. eg:1.When timeout is set in WLResourceRequest WLResourceRequest and there is a delay in adapter response that is more than timeout value. 2.If the server is not accessible on the IP address/port specified in mfpclient.properties file.

AUTHORIZATION_FAILURE

public static final WLErrorCode AUTHORIZATION_FAILURE

This error is returned due to o-auth process failure, when the client tries to obtain an access token or tries to access a resource from the server.

CHALLENGE_HANDLING_CANCELED

public static final WLErrorCode CHALLENGE_HANDLING_CANCELED

This error is returned when a challenge is cancelled midway by invoking an API BaseChallengeHAndler.cancel().

MISSING_CHALLENGE_HANDLER

public static final WLErrorCode MISSING_CHALLENGE_HANDLER

This error is returned when the challenge handler is not registered. To fix this error ,register the challenge handler using an api WLClient.registerChallengeHandler(challengeHandlerName).

ILLEGAL_ARGUMENT_EXCEPTION

public static final WLErrorCode ILLEGAL_ARGUMENT_EXCEPTION

This error is returned to indicate that a method has been passed with an illegal or inappropriate argument. Use WLFailResponse.getErrorMsg to get more information about the error.

LOGIN_ALREADY_IN_PROCESS

public static final WLErrorCode LOGIN_ALREADY_IN_PROCESS

This error is returned during the client registration when an attempt is made to login and there is an authorization process to login already in progress. eg:Multiple login attempts before receiving the response from the server.

LOGOUT_ALREADY_IN_PROCESS

public static final WLErrorCode LOGOUT_ALREADY_IN_PROCESS

This error is returned when an attempt is made to logout and there is an authorization process to logout already in progress.

APPLICATION_NOT_REGISTERED

public static final WLErrorCode APPLICATION_NOT_REGISTERED

This error is returned when the client tries to set/get client details from the server before the client is registered on the MobileFirst server. To resolve this error register the client using either MobileFirst CLI or Mobilefirst console.

SERVER_ERROR

public static final WLErrorCode SERVER_ERROR

This is the default server error. This error is returned when the request to the MobileFirst server fails. Use WLFailResponse.getErrorMsg to get more information about the error.

MINIMUM_SERVER

public static final WLErrorCode MINIMUM_SERVER

This error is returned when the MFP server version is older than 8.0.0.0-IF201701250919 and the client sdk version is the higher than 8.0.0.0-IF201701250919. To fix this error upgrade the server to 8.0.0.0-IF201701250919 or later version.

APPLICATION_DISABLED

public static final WLErrorCode APPLICATION_DISABLED

This error code is returned when there is remote disable enabled for the application .(The Access disable option is enabled on Management tab of the application in MobileFirst server console which indicates that the particular app or particular verison of the app is no more available on the server and it pops up a dialogue to upgrade the application .

Method Detail

values

public static WLErrorCode[] 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 (WLErrorCode c : WLErrorCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static WLErrorCode valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getDescription

public java.lang.String getDescription()

This method retrieves the WLErrorCode message.

Returns:

The WLErrorCode message.