org.apache.avalon.phoenix.interfaces
Interface ConfigurationValidator

All Known Implementing Classes:

DelegatingConfigurationValidator, JarvConfigurationValidator, NoopConfigurationValidator

public interface ConfigurationValidator

Handles parsing of configuration schema and validation against schema

Version:

CVS $Revision: 1.4 $ $Date: 2002/07/26 09:49:22 $

Author:

Peter Royal

Field Summary

static String

ROLE

Method Summary

void	addSchema(String application, String block, String schemaType, String url) Add configuration schema to validator
boolean	isFeasiblyValid(String application, String block, Configuration configuration) Check to see if configuration is feasibly valid.
boolean	isValid(String application, String block, Configuration configuration) Check to see if configuration is valid.
void	removeSchema(String application, String block) Add configuration schema to validator

Field Detail

ROLE

public static final String ROLE

Method Detail

addSchema

public void addSchema(String application,
                      String block,
                      String schemaType,
                      String url)
               throws ConfigurationException

Add configuration schema to validator

Parameters:

application - Application name

block - Block name to store configuration for

url - url that the schema may be located at

Throws:

ConfigurationException - if schema is invalid

removeSchema

public void removeSchema(String application,
                         String block)

Add configuration schema to validator

Parameters:

application - Application name

block - Block name to store configuration for

Throws:

ConfigurationException - if schema is invalid

isFeasiblyValid

public boolean isFeasiblyValid(String application,
                               String block,
                               Configuration configuration)
                        throws ConfigurationException

Check to see if configuration is feasibly valid. That is, does this configuration match the schema in its current state, but not neccessarily fullfill the requirements of the schema. Implementations are not required to support checking feasibility. If feasibility cannot be checked, the implementation should always return true

Parameters:

application - Application name

block - Block name to store configuration for

configuration - Configuration to check

Returns:

true if configuration is feasibly valid

Throws:

ConfigurationException - if no schema is found

isValid

public boolean isValid(String application,
                       String block,
                       Configuration configuration)
                throws ConfigurationException

Check to see if configuration is valid.

Parameters:

application - Application name

block - Block name to store configuration for

configuration - Configuration to check

Returns:

true if configuration is valid

Throws:

ConfigurationException - if no schema is found