Package net.shibboleth.idp.attribute.resolver.dc.rdbms.impl

Class DataSourceValidator

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.idp.attribute.resolver.dc.rdbms.impl.DataSourceValidator

All Implemented Interfaces:

Validator, Component, DestructableComponent, InitializableComponent

public class DataSourceValidator
extends AbstractInitializableComponent
implements Validator

Validator implementation that invokes DataSource.getConnection() to determine if the DataSource is properly configured.

Field Summary

Fields

Modifier and Type	Field	Description
private DataSource	dataSource	JDBC data source to validate.
private final org.slf4j.Logger	log	Class logger.
private boolean	throwOnValidateError	Whether validate should throw, default value is true.

Constructor Summary

Constructors

Constructor	Description
DataSourceValidator()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
DataSource	getDataSource()	Returns the data source.
boolean	isThrowValidateError()	Returns whether Validator.validate() should throw or log errors.
void	setDataSource(DataSource source)	Sets the data source.
void	setThrowValidateError(boolean value)	Sets whether Validator.validate() should throw or log errors.
void	validate()	Probe the data connector and conditionally fails if it is not valid and ready for use.

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Details

log

private final org.slf4j.Logger log

Class logger.

dataSource

@NonnullAfterInit
private DataSource dataSource

JDBC data source to validate.

throwOnValidateError

private boolean throwOnValidateError

Whether validate should throw, default value is true.

Constructor Details

DataSourceValidator

public DataSourceValidator()

Constructor.

Method Details

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

setDataSource

public void setDataSource(@Nonnull
 DataSource source)

Sets the data source.

Parameters:

source - the data source

getDataSource

public DataSource getDataSource()

Returns the data source.

Returns:

data source

setThrowValidateError

public void setThrowValidateError(boolean value)

Sets whether Validator.validate() should throw or log errors.

Specified by:

setThrowValidateError in interface Validator

Parameters:

value - whether Validator.validate() should throw or log errors

isThrowValidateError

public boolean isThrowValidateError()

Returns whether Validator.validate() should throw or log errors.

Specified by:

isThrowValidateError in interface Validator

Returns:

whether Validator.validate() should throw or log errors

validate

public void validate()
              throws ValidationException

Probe the data connector and conditionally fails if it is not valid and ready for use.

Specified by:

validate in interface Validator

Throws:

ValidationException - thrown if validation fails and Validator.isThrowValidateError() is true