org.apache.avalon.phoenix.components.configuration.validator
Class JarvConfigurationValidator

java.lang.Object
  |
  +--AbstractLogEnabled
        |
        +--org.apache.avalon.phoenix.components.configuration.validator.JarvConfigurationValidator

All Implemented Interfaces:

ConfigurationValidator, ConfigurationValidatorMBean

public class JarvConfigurationValidator

extends AbstractLogEnabled

implements ConfigurationValidator, ConfigurationValidatorMBean

A validator that is capable of validating any schema supported by the JARV engine. http://iso-relax.sourceforge.net/

Author:

Peter Royal

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.avalon.phoenix.interfaces.ConfigurationValidator

ROLE

Constructor Summary

JarvConfigurationValidator()

Method Summary

void	addSchema(String application, String block, String schemaType, String url) Add configuration schema to validator
void	configure(Configuration configuration) There are two possible configuration options for this class.
String	getSchema(String application, String block) Get the XML that represents the schema for the specified application and block.
String	getSchemaType(String application, String block) Get the schema type for the specified application and block.
void	initialize()
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

Methods inherited from class java.lang.Object

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

Constructor Detail

JarvConfigurationValidator

public JarvConfigurationValidator()

Method Detail

configure

public void configure(Configuration configuration)
               throws ConfigurationException

There are two possible configuration options for this class. They are mutually exclusive.

1. <schema-language>schema language uri</schema-language>
2. <verifier-factory-class>classname</verifier-factory-class>
   The fully-qualified classname to use as a verifier factory.

ConfigurationException

See Also:

initialize

public void initialize()
                throws Exception

Exception

addSchema

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

Description copied from interface: ConfigurationValidator

Add configuration schema to validator

Specified by:

addSchema in interface ConfigurationValidator

Parameters:

application - Application name

block - Block name to store configuration for

url - url that the schema may be located at

ConfigurationException

isFeasiblyValid

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

Description copied from interface: ConfigurationValidator

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

Specified by:

isFeasiblyValid in interface ConfigurationValidator

Parameters:

application - Application name

block - Block name to store configuration for

configuration - Configuration to check

Returns:

true if configuration is feasibly valid

ConfigurationException

isValid

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

Description copied from interface: ConfigurationValidator

Check to see if configuration is valid.

Specified by:

isValid in interface ConfigurationValidator

Parameters:

application - Application name

block - Block name to store configuration for

configuration - Configuration to check

Returns:

true if configuration is valid

ConfigurationException

removeSchema

public void removeSchema(String application,
                         String block)

Description copied from interface: ConfigurationValidator

Add configuration schema to validator

Specified by:

removeSchema in interface ConfigurationValidator

Parameters:

application - Application name

block - Block name to store configuration for

getSchemaType

public String getSchemaType(String application,
                            String block)

Description copied from interface: ConfigurationValidatorMBean

Get the schema type for the specified application and block. Returns null if no schema

Specified by:

getSchemaType in interface ConfigurationValidatorMBean

Parameters:

application - to get schema for

block - to get schema for

Returns:

schema type, or null if none exists

getSchema

public String getSchema(String application,
                        String block)

Description copied from interface: ConfigurationValidatorMBean

Get the XML that represents the schema for the specified application and block. Returns null if no schema.

Specified by:

getSchema in interface ConfigurationValidatorMBean

Parameters:

application - to get schema for

block - to get schema for

Returns:

schema as string, or null if none exists