com.exalead.mercury.mami.master.v10

Class IdentityProviderConfig

java.lang.Object

com.exalead.mercury.mami.master.v10.IdentityProviderConfig

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class IdentityProviderConfig
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Definition of an identity provider.
Used, for example, by the admin ui components to define a common login API.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_SESSION_INACTIVITY_TIMEOUT_S
java.lang.String	filterFactoryClassId
java.util.List<KeyValue>	keyValue
java.lang.String	name
java.lang.String	securitySource
long	sessionInactivityTimeoutS

Constructor Summary

Constructors

Constructor and Description
IdentityProviderConfig()
IdentityProviderConfig(IdentityProviderConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this IdentityProviderConfig.
static IdentityProviderConfig	fromString(java.lang.String s) String representation of this IdentityProviderConfig.
java.lang.String	getFilterFactoryClassId() Optional classId of a specific FilterFactory to use instead of the default one. It is used to create a specific SecurityFilter to change the authentication method.
java.util.List<KeyValue>	getKeyValue()
java.lang.String	getName() Identity provider name.
java.lang.String	getSecuritySource() Associated security source.
long	getSessionInactivityTimeoutS() Sessions will time out after this time.
IdentityProviderConfig	makeCopy() Creates and returns a deep copy of this IdentityProviderConfig.
static IdentityProviderConfig	readFrom(java.io.InputStream is) Read this IdentityProviderConfig from an XML fragment.
void	setFilterFactoryClassId(java.lang.String filterFactoryClassId) Optional classId of a specific FilterFactory to use instead of the default one. It is used to create a specific SecurityFilter to change the authentication method.
void	setName(java.lang.String name) Identity provider name.
void	setSecuritySource(java.lang.String securitySource) Associated security source.
void	setSessionInactivityTimeoutS(long sessionInactivityTimeoutS) Sessions will time out after this time.
java.lang.String	toString() String representation of this IdentityProviderConfig.
IdentityProviderConfig	withFilterFactoryClassId(java.lang.String filterFactoryClassId)
IdentityProviderConfig	withKeyValue(java.util.Collection<KeyValue> __values)
IdentityProviderConfig	withKeyValue(KeyValue... __values)
IdentityProviderConfig	withName(java.lang.String name)
IdentityProviderConfig	withSecuritySource(java.lang.String securitySource)
IdentityProviderConfig	withSessionInactivityTimeoutS(long sessionInactivityTimeoutS)
IdentityProviderConfig	withSessionInactivityTimeoutS(java.lang.Long sessionInactivityTimeoutS)
void	writeTo(java.io.OutputStream os) Write this IdentityProviderConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

keyValue

public java.util.List<KeyValue> keyValue

name

public java.lang.String name

filterFactoryClassId

public java.lang.String filterFactoryClassId

securitySource

public java.lang.String securitySource

sessionInactivityTimeoutS

public long sessionInactivityTimeoutS

DEFAULT_SESSION_INACTIVITY_TIMEOUT_S

public static final long DEFAULT_SESSION_INACTIVITY_TIMEOUT_S

See Also:

Constant Field Values

Constructor Detail

IdentityProviderConfig

public IdentityProviderConfig()

IdentityProviderConfig

public IdentityProviderConfig(IdentityProviderConfig o)

Copy constructor

Method Detail

getKeyValue

public java.util.List<KeyValue> getKeyValue()

withKeyValue

public IdentityProviderConfig withKeyValue(KeyValue... __values)

withKeyValue

public IdentityProviderConfig withKeyValue(java.util.Collection<KeyValue> __values)

setName

public void setName(java.lang.String name)

Identity provider name.

getName

public java.lang.String getName()

Identity provider name.

withName

public IdentityProviderConfig withName(java.lang.String name)

setFilterFactoryClassId

public void setFilterFactoryClassId(java.lang.String filterFactoryClassId)

Optional classId of a specific FilterFactory to use instead of the default one.
It is used to create a specific SecurityFilter to change the authentication method.

getFilterFactoryClassId

public java.lang.String getFilterFactoryClassId()

Optional classId of a specific FilterFactory to use instead of the default one.
It is used to create a specific SecurityFilter to change the authentication method.

withFilterFactoryClassId

public IdentityProviderConfig withFilterFactoryClassId(java.lang.String filterFactoryClassId)

setSecuritySource

public void setSecuritySource(java.lang.String securitySource)

Associated security source.

getSecuritySource

public java.lang.String getSecuritySource()

Associated security source.

withSecuritySource

public IdentityProviderConfig withSecuritySource(java.lang.String securitySource)

setSessionInactivityTimeoutS

public void setSessionInactivityTimeoutS(long sessionInactivityTimeoutS)

Sessions will time out after this time. -1 for no timeout

getSessionInactivityTimeoutS

public long getSessionInactivityTimeoutS()

Sessions will time out after this time. -1 for no timeout

withSessionInactivityTimeoutS

public IdentityProviderConfig withSessionInactivityTimeoutS(long sessionInactivityTimeoutS)

withSessionInactivityTimeoutS

public IdentityProviderConfig withSessionInactivityTimeoutS(java.lang.Long sessionInactivityTimeoutS)

makeCopy

public IdentityProviderConfig makeCopy()

Creates and returns a deep copy of this IdentityProviderConfig.

readFrom

public static IdentityProviderConfig readFrom(java.io.InputStream is)
                                       throws javax.xml.bind.JAXBException

Read this IdentityProviderConfig from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this IdentityProviderConfig as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static IdentityProviderConfig fromString(java.lang.String s)
                                         throws javax.xml.bind.JAXBException,
                                                java.io.UnsupportedEncodingException

String representation of this IdentityProviderConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this IdentityProviderConfig.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this IdentityProviderConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException