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

Class ConnectionFactoryValidator

java.lang.Object

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

net.shibboleth.idp.attribute.resolver.dc.ldap.impl.ConnectionFactoryValidator

All Implemented Interfaces:

Validator, Component, DestructableComponent, InitializableComponent

public class ConnectionFactoryValidator
extends AbstractInitializableComponent
implements Validator

Validator implementation that invokes Connection.open() to determine if the ConnectionFactory is properly configured.

Field Summary

Fields

Modifier and Type	Field	Description
private ConnectionFactory	connectionFactory	Connection factory 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
ConnectionFactoryValidator()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
ConnectionFactory	getConnectionFactory()	Returns the connection factory.
boolean	isThrowValidateError()	Returns whether Validator.validate() should throw or log errors.
void	setConnectionFactory(ConnectionFactory factory)	Sets the connection factory.
void	setThrowValidateError(boolean what)	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.

connectionFactory

@Nonnull
private ConnectionFactory connectionFactory

Connection factory to validate.

throwOnValidateError

private boolean throwOnValidateError

Whether validate should throw, default value is true.

Constructor Details

ConnectionFactoryValidator

public ConnectionFactoryValidator()

Constructor.

Method Details

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

setConnectionFactory

@Nonnull
public void setConnectionFactory(@Nonnull
 ConnectionFactory factory)

Sets the connection factory.

Parameters:

factory - the connection factory

getConnectionFactory

@Nonnull
public ConnectionFactory getConnectionFactory()

Returns the connection factory.

Returns:

connection factory

setThrowValidateError

public void setThrowValidateError(boolean what)

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

Specified by:

setThrowValidateError in interface Validator

Parameters:

what - 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