Class QAuthenticationMetaData

java.lang.Object

com.kingsrook.qqq.backend.core.model.metadata.authentication.QAuthenticationMetaData

All Implemented Interfaces:

MetaDataProducerOutput, QMetaDataObject, TopLevelMetaDataInterface, Serializable

Direct Known Subclasses:

Auth0AuthenticationMetaData, OAuth2AuthenticationMetaData, TableBasedAuthenticationMetaData

public class QAuthenticationMetaData
extends Object
implements TopLevelMetaDataInterface

Meta-data to provide details of an authentication provider (e.g., google, saml, etc) within a qqq instance

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
QAuthenticationMetaData()

Method Summary

Modifier and Type	Method	Description
void	addSelfToInstance(QInstance qInstance)	call the appropriate methods on a QInstance to add ourselves to it.
QCodeReference	getCustomizer()	Getter for customizer
String	getName()
Boolean	getSessionStoreEnabled()	Getter for sessionStoreEnabled
QAuthenticationType	getType()	Getter for type
String	getValue(String key)
Map<String,String>	getValues()
void	setCustomizer(QCodeReference customizer)	Setter for customizer
void	setName(String name)
void	setSessionStoreEnabled(Boolean sessionStoreEnabled)	Setter for sessionStoreEnabled
void	setType(QAuthenticationType type)	Setter for type
void	setValue(String key, String value)
void	setValues(Map<String,String> values)
void	validate(QInstance qInstance, QInstanceValidator qInstanceValidator)
QAuthenticationMetaData	withCustomizer(QCodeReference customizer)	Fluent setter for customizer
QAuthenticationMetaData	withName(String name)
QAuthenticationMetaData	withSessionStoreEnabled(Boolean sessionStoreEnabled)	Fluent setter for sessionStoreEnabled
QAuthenticationMetaData	withType(QAuthenticationType type)
QAuthenticationMetaData	withValue(String key, String value)
QAuthenticationMetaData	withValues(Map<String,String> values)

Methods inherited from class java.lang.Object

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

Constructor Details

QAuthenticationMetaData

public QAuthenticationMetaData()

Method Details

getValue

public String getValue(String key)

setValue

public void setValue(String key,
 String value)

withValue

public QAuthenticationMetaData withValue(String key,
 String value)

getName

public String getName()

Specified by:

getName in interface TopLevelMetaDataInterface

setName

public void setName(String name)

withName

public QAuthenticationMetaData withName(String name)

getType

public QAuthenticationType getType()

Getter for type

setType

public void setType(QAuthenticationType type)

Setter for type

withType

public QAuthenticationMetaData withType(QAuthenticationType type)

getValues

public Map<String,String> getValues()

setValues

public void setValues(Map<String,String> values)

withValues

public QAuthenticationMetaData withValues(Map<String,String> values)

addSelfToInstance

public void addSelfToInstance(QInstance qInstance)

Description copied from interface: MetaDataProducerOutput

call the appropriate methods on a QInstance to add ourselves to it.

Specified by:

addSelfToInstance in interface MetaDataProducerOutput

Specified by:

addSelfToInstance in interface TopLevelMetaDataInterface

getCustomizer

public QCodeReference getCustomizer()

Getter for customizer

setCustomizer

public void setCustomizer(QCodeReference customizer)

Setter for customizer

withCustomizer

public QAuthenticationMetaData withCustomizer(QCodeReference customizer)

Fluent setter for customizer

validate

public void validate(QInstance qInstance,
 QInstanceValidator qInstanceValidator)

getSessionStoreEnabled

public Boolean getSessionStoreEnabled()

Getter for sessionStoreEnabled

setSessionStoreEnabled

public void setSessionStoreEnabled(Boolean sessionStoreEnabled)

Setter for sessionStoreEnabled

withSessionStoreEnabled

public QAuthenticationMetaData withSessionStoreEnabled(Boolean sessionStoreEnabled)

Fluent setter for sessionStoreEnabled

Parameters:

sessionStoreEnabled - whether to use the QSessionStore QBit for caching sessions