Package org.sourceid.saml20.adapter.gui

Class JdbcDatastoreFieldDescriptor

java.lang.Object

org.sourceid.saml20.adapter.gui.FieldDescriptor

org.sourceid.saml20.adapter.gui.AbstractSelectionFieldDescriptor

org.sourceid.saml20.adapter.gui.SelectFieldDescriptor

org.sourceid.saml20.adapter.gui.JdbcDatastoreFieldDescriptor

All Implemented Interfaces:

Serializable

public class JdbcDatastoreFieldDescriptor
extends SelectFieldDescriptor

A field descriptor that will render (in GUI configuration screen) a drop down selection of all the configured JDBC data stores.

The value of this field in the Configuration will be the JNDI name of the Data Store (datasource).

To access a Connection object that is created from the JNDI name, you can use the DataSourceAccessor class. You can also use this JNDI name to perform your own lookup. Here is some example code if you want to do it on your own:

FieldDescriptor jdbcFieldDescriptor = conf.getField( "MyJDBCDatastoreFieldDescriptorName" );
String jndiName = jdbcFieldDescriptor.getValue();

DataSourceAccessor ds = new DataSourceAccessor();

Connection conn = ds.getConnection(jndiName);
...

See Also:

DataSourceAccessor.getConnection(String), GuiConfigDescriptor.addField(FieldDescriptor), GuiConfigDescriptor.addAdvancedField(FieldDescriptor), TableDescriptor.addRowField(FieldDescriptor), Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.sourceid.saml20.adapter.gui.AbstractSelectionFieldDescriptor

AbstractSelectionFieldDescriptor.OptionValue

Nested classes/interfaces inherited from class org.sourceid.saml20.adapter.gui.FieldDescriptor

FieldDescriptor.FieldValidationWrapper

Field Summary

Fields inherited from class org.sourceid.saml20.adapter.gui.SelectFieldDescriptor

DEFAULT, SELECT_ONE

Fields inherited from class org.sourceid.saml20.adapter.gui.AbstractSelectionFieldDescriptor

NONE_SELECTED

Constructor Summary

Constructors

Constructor	Description
JdbcDatastoreFieldDescriptor(String name, String description)	Create a new JdbcDatastoreFieldDescriptor.

Method Summary

Modifier and Type	Method	Description
List<AbstractSelectionFieldDescriptor.OptionValue>	getOptionValues()	Gets the option values list constructed from all the JDBC data sources configured in the system.

Methods inherited from class org.sourceid.saml20.adapter.gui.AbstractSelectionFieldDescriptor

getFormattedValue, setOptionValues

Methods inherited from class org.sourceid.saml20.adapter.gui.FieldDescriptor

addValidator, addValidator, getDefaultForLegacyConfig, getDefaultValue, getDescription, getLabel, getName, getValidationChain, isHidden, setDefaultForLegacyConfig, setDefaultValue, setHidden, setLabel

Methods inherited from class java.lang.Object

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

Constructor Detail

JdbcDatastoreFieldDescriptor

public JdbcDatastoreFieldDescriptor(String name,
                                    String description)

Create a new JdbcDatastoreFieldDescriptor.

Parameters:

name - The field name (must be unique per AdapterConfigurationGuiDescriptor or TableDescriptor). This name will also be used as the label for the field in the administrative console. To ensure configuration can be read in future releases of a plugin, it is recommended to not change the names - instead use a label to rename a field in the administrative console.

description - The field description displayed in the administrative console.

Method Detail

getOptionValues

public List<AbstractSelectionFieldDescriptor.OptionValue> getOptionValues()

Gets the option values list constructed from all the JDBC data sources configured in the system.

Overrides:

getOptionValues in class AbstractSelectionFieldDescriptor

Returns:

the option value list.