Class AuthenticationStatus

• Object
  • dw.customer.AuthenticationStatus

Holds the status of an authentication process.

Constants

AUTH_OK : String = "AUTH_OK"

Authentication was successful

ERROR_CUSTOMER_DISABLED : String = "ERROR_CUSTOMER_DISABLED"

customer could be found, but is disabled. Password was not verified.

ERROR_CUSTOMER_LOCKED : String = "ERROR_CUSTOMER_LOCKED"

customer could be found, but is locked (too many failed login attempts). Password was verified before.

ERROR_CUSTOMER_NOT_FOUND : String = "ERROR_CUSTOMER_NOT_FOUND"

customer could not be found

ERROR_PASSWORD_EXPIRED : String = "ERROR_PASSWORD_EXPIRED"

Password does match, but is expired.

ERROR_PASSWORD_MISMATCH : String = "ERROR_PASSWORD_MISMATCH"

the used password is not correct

ERROR_UNKNOWN : String = "ERROR_UNKNOWN"

Any other error

Properties

authenticated : boolean Read Only

checks whether the authentication was successful or not

customer : Customer Read Only

The customer, corresponding to the login used during authentication. This customer is not logged in after authentication.

status : String Read Only

the status code (see the constants above)

Constructor Summary

This class does not have a constructor, so you cannot create it directly.

Method Summary

getCustomer() : Customer

The customer, corresponding to the login used during authentication.

getStatus() : String

the status code (see the constants above)

isAuthenticated() : boolean

checks whether the authentication was successful or not

Methods inherited from class Object

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Method Detail

getCustomer

getCustomer() : Customer

The customer, corresponding to the login used during authentication. This customer is not logged in after authentication.

Returns:

the customer described by the login

getStatus

getStatus() : String

the status code (see the constants above)

Returns:

the status code

isAuthenticated

isAuthenticated() : boolean

checks whether the authentication was successful or not

Returns:

the when the authentication was successful