Package com.funnelback.plugin.details.model

Class PluginConfigKeyEncrypted

java.lang.Object

com.funnelback.plugin.details.model.PluginConfigKeyBase

com.funnelback.plugin.details.model.PluginConfigKeyEncrypted

All Implemented Interfaces:

PluginConfigKeyDetails, PluginDetailsBase

public class PluginConfigKeyEncrypted
extends PluginConfigKeyBase

Defines plugin configuration key properties for storing secret information (like passwords) For example, to define configuration key 'plugin.pluginID.encrypted.token'

 new PluginConfigKeyEncrypted("pluginID",  "token", "Key label", "Key desc",  true);
 

or using a builder

 PluginConfigKeyEncrypted.builder()
      .pluginId("pluginID")
      .id("token")
      .label("Key label")
      .description("Key desc")
      .required(true)
      .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PluginConfigKeyEncrypted.PluginConfigKeyEncryptedBuilder

Field Summary

Fields inherited from class com.funnelback.plugin.details.model.PluginConfigKeyBase

id

Fields inherited from interface com.funnelback.plugin.details.model.PluginDetailsBase

PLUGIN_CONFIG_QUALIFIER, PLUGIN_ENCRYPTED_QUALIFIER, PLUGIN_PREFIX

Constructor Summary

Constructors

Constructor	Description
PluginConfigKeyEncrypted(@NonNull String pluginId, @NonNull String id, @NonNull String label, @NonNull String description, boolean required)
PluginConfigKeyEncrypted(@NonNull String pluginId, @NonNull String id, @NonNull String label, @NonNull String description, String longDescription, boolean required)

Method Summary

Modifier and Type	Method	Description
static PluginConfigKeyEncrypted.PluginConfigKeyEncryptedBuilder	builder()
String	getKeyPrefix()

Methods inherited from class com.funnelback.plugin.details.model.PluginConfigKeyBase

getDescription, getKey, getKey, getLabel, getLongDescription, getPluginId, getType, isRequired

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.funnelback.plugin.details.model.PluginConfigKeyDetails

getAllowedValue, getDefaultValue, getShowIfKeyHasValue

Constructor Detail

PluginConfigKeyEncrypted

public PluginConfigKeyEncrypted(@NonNull
                                @NonNull String pluginId,
                                @NonNull
                                @NonNull String id,
                                @NonNull
                                @NonNull String label,
                                @NonNull
                                @NonNull String description,
                                boolean required)

PluginConfigKeyEncrypted

public PluginConfigKeyEncrypted(@NonNull
                                @NonNull String pluginId,
                                @NonNull
                                @NonNull String id,
                                @NonNull
                                @NonNull String label,
                                @NonNull
                                @NonNull String description,
                                String longDescription,
                                boolean required)

Method Detail

getKeyPrefix

public String getKeyPrefix()

builder

public static PluginConfigKeyEncrypted.PluginConfigKeyEncryptedBuilder builder()