org.keycloak.provider.ProviderConfigProperty クラス

org.keycloak.provider.ProviderConfigProperty 連携図

公開メンバ関数
	ProviderConfigProperty ()
	ProviderConfigProperty (String name, String label, String helpText, String type, Object defaultValue)
	ProviderConfigProperty (String name, String label, String helpText, String type, Object defaultValue, String... options)
	ProviderConfigProperty (String name, String label, String helpText, String type, Object defaultValue, boolean secret)
String	getName ()
void	setName (String name)
String	getLabel ()
void	setLabel (String label)
String	getType ()
void	setType (String type)
Object	getDefaultValue ()
void	setDefaultValue (Object defaultValue)
List< String >	getOptions ()
void	setOptions (List< String > options)
String	getHelpText ()
void	setHelpText (String helpText)
boolean	isSecret ()
void	setSecret (boolean secret)

静的公開変数類
static final String	BOOLEAN_TYPE ="boolean"
static final String	STRING_TYPE ="String"
static final String	MULTIVALUED_STRING_TYPE ="MultivaluedString"
static final String	SCRIPT_TYPE ="Script"
static final String	FILE_TYPE ="File"
static final String	ROLE_TYPE ="Role"
static final String	LIST_TYPE ="List"
static final String	MULTIVALUED_LIST_TYPE ="MultivaluedList"
static final String	CLIENT_LIST_TYPE ="ClientList"
static final String	PASSWORD ="Password"

限定公開変数類
String	name
String	label
String	helpText
String	type = STRING_TYPE
Object	defaultValue
List< String >	options
boolean	secret

詳解

Configuration property metadata. Used to render generic configuration pages for Keycloak extensions in the admin console.

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

ProviderConfigProperty() [1/4]

org.keycloak.provider.ProviderConfigProperty.ProviderConfigProperty ( )

inline

                                    {
    }

ProviderConfigProperty() [2/4]

org.keycloak.provider.ProviderConfigProperty.ProviderConfigProperty ( String  name, String  label, String  helpText, String  type, Object  defaultValue  )

inline

                                                                                                                {
        this.name = name;
        this.label = label;
        this.helpText = helpText;
        this.type = type;
        this.defaultValue = defaultValue;
    }

ProviderConfigProperty() [3/4]

org.keycloak.provider.ProviderConfigProperty.ProviderConfigProperty ( String  name, String  label, String  helpText, String  type, Object  defaultValue, String...  options  )

inline

                                                                                                                                   {
        this.name = name;
        this.label = label;
        this.helpText = helpText;
        this.type = type;
        this.defaultValue = defaultValue;
        this.options = Arrays.asList(options);
    }

ProviderConfigProperty() [4/4]

org.keycloak.provider.ProviderConfigProperty.ProviderConfigProperty ( String  name, String  label, String  helpText, String  type, Object  defaultValue, boolean  secret  )

inline

                                                                                                                                {
        this(name, label, helpText, type, defaultValue);
        this.secret = secret;
    }

関数詳解

getDefaultValue()

Object org.keycloak.provider.ProviderConfigProperty.getDefaultValue ( )

inline

Default value for the variable

戻り値

                                    {
        return defaultValue;
    }

getHelpText()

String org.keycloak.provider.ProviderConfigProperty.getHelpText ( )

inline

Help text that will be displayed in the admin console tooltip

戻り値

                                {
        return helpText;
    }

getLabel()

String org.keycloak.provider.ProviderConfigProperty.getLabel ( )

inline

Label shown in the admin console when configuring the variable

戻り値

                             {
        return label;
    }

getName()

String org.keycloak.provider.ProviderConfigProperty.getName ( )

inline

Name of the config variable stored in the database

戻り値

                            {
        return name;
    }

getOptions()

List<String> org.keycloak.provider.ProviderConfigProperty.getOptions ( )

inline

For list types, this is a list of choices to choose from.

戻り値

                                     {
        return options;
    }

getType()

String org.keycloak.provider.ProviderConfigProperty.getType ( )

inline

Type of the variable. i.e. boolean, string etc. See the constants declared in this class for what your choices are.

戻り値

                            {
        return type;
    }

isSecret()

boolean org.keycloak.provider.ProviderConfigProperty.isSecret ( )

inline

If true, this variable is only writeable. It will never be viewable. This is important for things like passwords in which you never want to display them on the screen.

戻り値

                              {
        return secret;
    }

setDefaultValue()

void org.keycloak.provider.ProviderConfigProperty.setDefaultValue ( Object  defaultValue )

inline

                                                     {
        this.defaultValue = defaultValue;
    }

setHelpText()

void org.keycloak.provider.ProviderConfigProperty.setHelpText ( String  helpText )

inline

                                             {
        this.helpText = helpText;
    }

setLabel()

void org.keycloak.provider.ProviderConfigProperty.setLabel ( String  label )

inline

                                       {
        this.label = label;
    }

setName()

void org.keycloak.provider.ProviderConfigProperty.setName ( String  name )

inline

                                     {
        this.name = name;
    }

setOptions()

void org.keycloak.provider.ProviderConfigProperty.setOptions ( List< String >  options )

inline

                                                 {
        this.options = options;
    }

setSecret()

void org.keycloak.provider.ProviderConfigProperty.setSecret ( boolean  secret )

inline

                                          {
        this.secret = secret;
    }

setType()

void org.keycloak.provider.ProviderConfigProperty.setType ( String  type )

inline

                                     {
        this.type = type;
    }

メンバ詳解

BOOLEAN_TYPE

final String org.keycloak.provider.ProviderConfigProperty.BOOLEAN_TYPE ="boolean"

static

CLIENT_LIST_TYPE

final String org.keycloak.provider.ProviderConfigProperty.CLIENT_LIST_TYPE ="ClientList"

static

defaultValue

Object org.keycloak.provider.ProviderConfigProperty.defaultValue

protected

FILE_TYPE

final String org.keycloak.provider.ProviderConfigProperty.FILE_TYPE ="File"

static

helpText

String org.keycloak.provider.ProviderConfigProperty.helpText

protected

label

String org.keycloak.provider.ProviderConfigProperty.label

protected

LIST_TYPE

final String org.keycloak.provider.ProviderConfigProperty.LIST_TYPE ="List"

static

Possibility to configure single String value, which needs to be chosen from the list of predefined values (HTML select)

MULTIVALUED_LIST_TYPE

final String org.keycloak.provider.ProviderConfigProperty.MULTIVALUED_LIST_TYPE ="MultivaluedList"

static

Possibility to configure multiple String values, which needs to be chosen from the list of predefined values (HTML select with multiple)

MULTIVALUED_STRING_TYPE

final String org.keycloak.provider.ProviderConfigProperty.MULTIVALUED_STRING_TYPE ="MultivaluedString"

static

Possibility to configure multiple String values of any value (something like "redirect_uris" for clients)

name

String org.keycloak.provider.ProviderConfigProperty.name

protected

options

List<String> org.keycloak.provider.ProviderConfigProperty.options

protected

PASSWORD

final String org.keycloak.provider.ProviderConfigProperty.PASSWORD ="Password"

static

ROLE_TYPE

final String org.keycloak.provider.ProviderConfigProperty.ROLE_TYPE ="Role"

static

SCRIPT_TYPE

final String org.keycloak.provider.ProviderConfigProperty.SCRIPT_TYPE ="Script"

static

secret

boolean org.keycloak.provider.ProviderConfigProperty.secret

protected

STRING_TYPE

final String org.keycloak.provider.ProviderConfigProperty.STRING_TYPE ="String"

static

type

String org.keycloak.provider.ProviderConfigProperty.type = STRING_TYPE

protected

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/provider/ProviderConfigProperty.java