Package com.inductiveautomation.ignition.common.auth.idp

Class IdentityProviderName

java.lang.Object

com.inductiveautomation.ignition.common.auth.idp.IdentityProviderName

All Implemented Interfaces:

Comparable<IdentityProviderName>

@Deprecated(since="8.3.0")
public class IdentityProviderName
extends Object
implements Comparable<IdentityProviderName>

Deprecated.

This class should only be used for special migration related purposes only.

Immutable wrapper around a raw IdP name String. Sanitizes the raw name such that:

1. The first character is replaced with an underscore if it is not an underscore or alphabetical
2. Any remaining characters are replaced with underscores if they are not underscores, alphabetical or numeric

An IdentityProviderName is equal to another if its sanitized name is equal to (ignoring case) the other's sanitized name.

Makes for good consistent hash keys as the hash code is based on the sanitized name converted to all lowercase characters.

When one IdentityProviderName is compared with another, the result is the same as if their sanitized names are compared with each other (ignoring case).

Method Summary

Modifier and Type	Method	Description
int	compareTo(IdentityProviderName that)	Deprecated.
boolean	equals(Object o)	Deprecated.
String	getName()	Deprecated.
int	hashCode()	Deprecated.
static IdentityProviderName	of(String name)	Deprecated. Create a new IdentityProviderName given the raw name as a String
String	toString()	Deprecated.

Methods inherited from class java.lang.Object

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

Method Details

getName

public String getName()

Deprecated.

Returns:

the raw un-sanitized name (never null)

of

public static IdentityProviderName of(String name)

Deprecated.

Create a new IdentityProviderName given the raw name as a String

Parameters:

name - the raw name as a String. must not be null.

Returns:

the IdentityProviderName composed of the raw name as a String. never null.

Throws:

NullPointerException - if the given name is null

equals

public boolean equals(Object o)

Deprecated.

Overrides:

equals in class Object

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

Returns:

the sanitized name (preserving case)

compareTo

public int compareTo(IdentityProviderName that)

Deprecated.

Specified by:

compareTo in interface Comparable<IdentityProviderName>