Package com.inductiveautomation.ignition.common.user

Class BasicAuthChallenge

java.lang.Object

com.inductiveautomation.ignition.common.config.BasicPropertySet

com.inductiveautomation.ignition.common.user.AuthChallenge

com.inductiveautomation.ignition.common.user.BasicAuthChallenge

All Implemented Interfaces:

Countable, Extendable<PropertySet>, Mergable<PropertySet>, MutablePropertyValueSource, ObservablePropertySet, PropertySet, PropertyValueSource, Serializable, Iterable<PropertyValue>

Direct Known Subclasses:

ADSSOAuthChallenge, BadgeAuthChallenge

public class BasicAuthChallenge
extends AuthChallenge

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BasicAuthChallenge.Parser

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.common.user.AuthChallenge

AuthChallenge.AuthChallengeParser

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

BasicPropertySet.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final Property<String>	PasswordEnc
static final Property<String>	UsernameEnc

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

EMPTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BasicAuthChallenge()	Used from the parser - not public
	BasicAuthChallenge(String username, String password)

Method Summary

Modifier and Type	Method	Description
boolean	containsUsernameAndPassword()	Convenience method to see if this is a standard login attempt
void	decrypt()	Called after transport, before authentication.
protected void	decrypt(Property<String> plain, Property<String> cipher)
void	encrypt()	Prepare this auth challenge for transport.
protected void	encrypt(Property<String> plain, Property<String> cipher)	Encrypts the value of plain storing it in cipher
String	getActor()	Return a string representation of the "actor" this auth challenge represents (e.g.
String	toString()

Methods inherited from class com.inductiveautomation.ignition.common.user.AuthChallenge

fromJSON, register, set, set, toJSON, unregister

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

merge

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

merge

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

extend, newDefaultInstance, newExtension

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

getNonNull, getNonNull

Field Details

UsernameEnc

public static final Property<String> UsernameEnc

PasswordEnc

public static final Property<String> PasswordEnc

Constructor Details

BasicAuthChallenge

public BasicAuthChallenge(String username,
 String password)

BasicAuthChallenge

protected BasicAuthChallenge()

Used from the parser - not public

Method Details

getActor

public String getActor()

Description copied from class: AuthChallenge

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

Specified by:

getActor in class AuthChallenge

containsUsernameAndPassword

public boolean containsUsernameAndPassword()

Description copied from class: AuthChallenge

Convenience method to see if this is a standard login attempt

Specified by:

containsUsernameAndPassword in class AuthChallenge

toString

public String toString()

Overrides:

toString in class BasicPropertySet

encrypt

public void encrypt()

Description copied from class: AuthChallenge

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

Specified by:

encrypt in class AuthChallenge

decrypt

public void decrypt()

Description copied from class: AuthChallenge

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

Specified by:

decrypt in class AuthChallenge

encrypt

protected void encrypt(Property<String> plain,
 Property<String> cipher)

Encrypts the value of plain storing it in cipher

decrypt

protected void decrypt(Property<String> plain,
 Property<String> cipher)