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

Class IdentityProviderMeta

java.lang.Object

com.inductiveautomation.ignition.common.auth.idp.IdentityProviderMeta

All Implemented Interfaces:

Serializable

public class IdentityProviderMeta
extends Object
implements Serializable

Immutable meta information about an Identity Provider

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
Optional<String>	getDescription()
String	getName()
String	getType()
static IdentityProviderMeta	of(String name, String description, String type)	Factory method for creating new instances of IdentityProviderMeta

Methods inherited from class java.lang.Object

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

Method Details

of

public static IdentityProviderMeta of(String name,
 String description,
 String type)

Factory method for creating new instances of IdentityProviderMeta

Parameters:

name - the IdP name. must not be null.

description - the IdP description. may be null.

type - the IdP type. must not be null.

Returns:

the new instance of IdentityProviderMeta with the given name, description, and type

Throws:

NullPointerException - if the given name or type arguments are null

getName

public String getName()

Returns:

the name of the IdP. never null.

getDescription

public Optional<String> getDescription()

Returns:

the optional IdP description. never null.

getType

public String getType()

Returns:

the IdP type. never null.