Package org.keycloak.provider

Class ProviderConfigurationBuilder.ProviderConfigPropertyBuilder

java.lang.Object

org.keycloak.provider.ProviderConfigurationBuilder.ProviderConfigPropertyBuilder

Enclosing class:

ProviderConfigurationBuilder

public class ProviderConfigurationBuilder.ProviderConfigPropertyBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
ProviderConfigPropertyBuilder()

Method Summary

Modifier and Type	Method	Description
ProviderConfigurationBuilder	add()	Add the current property, and start building the next one
ProviderConfigurationBuilder.ProviderConfigPropertyBuilder	defaultValue(Object defaultValue)	Default value that will be shown when configuring this property for the first time
ProviderConfigurationBuilder.ProviderConfigPropertyBuilder	helpText(String helpText)	Help text that will be shown for this configuration property in the admin console when you hover over the tooltip
ProviderConfigurationBuilder.ProviderConfigPropertyBuilder	label(String label)	Label that will be shown for this configuration property in the admin console
ProviderConfigurationBuilder.ProviderConfigPropertyBuilder	name(String name)
ProviderConfigurationBuilder.ProviderConfigPropertyBuilder	options(String... options)	If configuring a list type, these are the options you can choose from.
ProviderConfigurationBuilder.ProviderConfigPropertyBuilder	options(List<String> options)	If configuring a list type, these are the options you can choose from.
ProviderConfigurationBuilder.ProviderConfigPropertyBuilder	required(boolean required)	If turned on, this property will be marked as required in the admin console
ProviderConfigurationBuilder.ProviderConfigPropertyBuilder	secret(boolean secret)	If turned on, this property is only writable and never readable.
ProviderConfigurationBuilder.ProviderConfigPropertyBuilder	type(String type)	Property type.

Methods inherited from class java.lang.Object

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

Constructor Details

ProviderConfigPropertyBuilder

public ProviderConfigPropertyBuilder()

Method Details

name

public ProviderConfigurationBuilder.ProviderConfigPropertyBuilder name(String name)

label

public ProviderConfigurationBuilder.ProviderConfigPropertyBuilder label(String label)

Label that will be shown for this configuration property in the admin console

Parameters:

label -

Returns:

helpText

public ProviderConfigurationBuilder.ProviderConfigPropertyBuilder helpText(String helpText)

Help text that will be shown for this configuration property in the admin console when you hover over the tooltip

Parameters:

helpText -

Returns:

type

public ProviderConfigurationBuilder.ProviderConfigPropertyBuilder type(String type)

Property type. i.e. boolean, string.

Parameters:

type -

Returns:

See Also:

• ProviderConfigProperty

defaultValue

public ProviderConfigurationBuilder.ProviderConfigPropertyBuilder defaultValue(Object defaultValue)

Default value that will be shown when configuring this property for the first time

Parameters:

defaultValue -

Returns:

options

public ProviderConfigurationBuilder.ProviderConfigPropertyBuilder options(String... options)

If configuring a list type, these are the options you can choose from.

Parameters:

options -

Returns:

options

public ProviderConfigurationBuilder.ProviderConfigPropertyBuilder options(List<String> options)

If configuring a list type, these are the options you can choose from.

Parameters:

options -

Returns:

secret

public ProviderConfigurationBuilder.ProviderConfigPropertyBuilder secret(boolean secret)

If turned on, this property is only writable and never readable. This is useful for things like passwords where you never want an admin to be able to see what the password is.

Parameters:

secret -

Returns:

required

public ProviderConfigurationBuilder.ProviderConfigPropertyBuilder required(boolean required)

If turned on, this property will be marked as required in the admin console

Parameters:

required -

Returns:

add

public ProviderConfigurationBuilder add()

Add the current property, and start building the next one

Returns: