com.inductiveautomation.ignition.common.user

Class AuthChallenge

java.lang.Object

com.inductiveautomation.ignition.common.config.BasicPropertySet

com.inductiveautomation.ignition.common.user.AuthChallenge

All Implemented Interfaces:

Countable, Extendable<PropertySet>, Mergable<PropertySet>, MutablePropertyValueSource, ObservablePropertySet, PropertySet, PropertyValueSource, java.io.Serializable, java.lang.Iterable<PropertyValue>

Direct Known Subclasses:

BasicAuthChallenge

public abstract class AuthChallenge
extends BasicPropertySet

An authentication challenge represents an attempt to log-in. This may contain a username and password, but could be something else, for example a badge swipe. Due to serialization requirements, all auth challenge properties must be string properties.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AuthChallenge.AuthChallengeParser

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.common.config.BasicPropertySet

BasicPropertySet.Builder

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.common.config.PropertySet

EMPTY

Constructor Summary

Constructors

Constructor and Description
AuthChallenge()

Method Summary

Modifier and Type	Method and Description
abstract boolean	containsUsernameAndPassword() Convenience method to see if this is a standard login attempt
abstract void	decrypt() Called after transport, before authentication.
abstract void	encrypt() Prepare this auth challenge for transport.
static AuthChallenge	fromJSON(java.lang.String jsonString)
abstract java.lang.String	getActor() Return a string representation of the "actor" this auth challenge represents (e.g.
static void	register(AuthChallenge.AuthChallengeParser parser)
<T> void	set(Property<T> prop, T value)
void	set(PropertyValue propValue)
java.lang.String	toJSON()
static void	unregister(AuthChallenge.AuthChallengeParser parser)

Methods inherited from class com.inductiveautomation.ignition.common.config.BasicPropertySet

addPropertyChangeListener, addPropertyChangeListener, change, coerceValue, contains, equals, firePropertyChange, get, getCount, getExtension, getOrDefault, getOrElse, getProperties, getRaw, getRawValueMap, getValues, isExtended, isInherited, iterator, of, remove, removePropertyChangeListener, removePropertyChangeListener, setDirect, setImpl, setRawValueMap, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertySet

builder, extend, newDefaultInstance, newExtension

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.inductiveautomation.ignition.common.config.MutablePropertyValueSource

merge

Methods inherited from interface com.inductiveautomation.ignition.common.config.Mergable

merge

Constructor Detail

AuthChallenge

public AuthChallenge()

Method Detail

register

public static void register(AuthChallenge.AuthChallengeParser parser)

unregister

public static void unregister(AuthChallenge.AuthChallengeParser parser)

fromJSON

public static AuthChallenge fromJSON(java.lang.String jsonString)
                              throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

containsUsernameAndPassword

public abstract boolean containsUsernameAndPassword()

Convenience method to see if this is a standard login attempt

getActor

public abstract java.lang.String getActor()

Return a string representation of the "actor" this auth challenge represents (e.g. a username)

encrypt

public abstract void encrypt()

Prepare this auth challenge for transport. After this is called, there should not be any sensitive plaintext information in the property set.

decrypt

public abstract void decrypt()

Called after transport, before authentication. After this is called, sensitive information may appear in plaintext in this object

set

public <T> void set(Property<T> prop,
                    T value)

Specified by:

set in interface MutablePropertyValueSource

Overrides:

set in class BasicPropertySet

set

public void set(PropertyValue propValue)

Specified by:

set in interface MutablePropertyValueSource

Overrides:

set in class BasicPropertySet

toJSON

public java.lang.String toJSON()