org.ikasan.component.validator.schematron

Class SchematronValidator

java.lang.Object

org.ikasan.component.validator.schematron.SchematronValidator

All Implemented Interfaces:

org.ikasan.spec.component.endpoint.Broker<Document,ValidationResult<Document,Document>>, org.ikasan.spec.configuration.Configured<SchematronValidatorConfiguration>, org.ikasan.spec.configuration.ConfiguredResource<SchematronValidatorConfiguration>, org.ikasan.spec.management.ManagedResource

public class SchematronValidator
extends Object
implements org.ikasan.spec.component.endpoint.Broker<Document,ValidationResult<Document,Document>>, org.ikasan.spec.management.ManagedResource, org.ikasan.spec.configuration.ConfiguredResource<SchematronValidatorConfiguration>

Validator implementation using pre-compiled XSLT Schematron rules. There are two ways to use this validator: 1. Set throwExceptionOnValidationFailure to true in the configuration, and handle the Exception thrown on failure, or extract the original document downstream from the ValidationResult 2. Use a router component after this to route successful (ValidationResult.Result.VALID) down one route and failed validations (ValidationResult.Result.INVALID) down another In all cases (but not the thrown exception case obviously) the original document is stored in the returned ValidationResult via the getSource() method This class implements ManagedResource in order to cache any XSLT documents. Stopping and starting this component will re-initialise this cache

Constructor Summary

Constructors

Constructor and Description
SchematronValidator()

Method Summary

Methods

Modifier and Type	Method and Description
SchematronValidatorConfiguration	getConfiguration()
String	getConfiguredResourceId()
URIResolver	getUriResolver()
ValidationResult<Document,Document>	invoke(Document document)
boolean	isCriticalOnStartup()
protected void	processValidationResult(SchematronOutputType schematronOutputType, ValidationResult validationResult)
void	setConfiguration(SchematronValidatorConfiguration configuration)
void	setConfiguredResourceId(String id)
void	setCriticalOnStartup(boolean criticalOnStartup)
void	setManagedResourceRecoveryManager(org.ikasan.spec.management.ManagedResourceRecoveryManager managedResourceRecoveryManager)
void	setUriResolver(URIResolver uriResolver)
void	startManagedResource()
void	stopManagedResource()

Methods inherited from class java.lang.Object

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

Constructor Detail

SchematronValidator

public SchematronValidator()

Method Detail

invoke

public ValidationResult<Document,Document> invoke(Document document)
                                           throws org.ikasan.spec.component.endpoint.EndpointException

Specified by:

invoke in interface org.ikasan.spec.component.endpoint.Broker<Document,ValidationResult<Document,Document>>

Throws:

org.ikasan.spec.component.endpoint.EndpointException

processValidationResult

protected void processValidationResult(SchematronOutputType schematronOutputType,
                           ValidationResult validationResult)

startManagedResource

public void startManagedResource()

Specified by:

startManagedResource in interface org.ikasan.spec.management.ManagedResource

stopManagedResource

public void stopManagedResource()

Specified by:

stopManagedResource in interface org.ikasan.spec.management.ManagedResource

setManagedResourceRecoveryManager

public void setManagedResourceRecoveryManager(org.ikasan.spec.management.ManagedResourceRecoveryManager managedResourceRecoveryManager)

Specified by:

setManagedResourceRecoveryManager in interface org.ikasan.spec.management.ManagedResource

isCriticalOnStartup

public boolean isCriticalOnStartup()

Specified by:

isCriticalOnStartup in interface org.ikasan.spec.management.ManagedResource

setCriticalOnStartup

public void setCriticalOnStartup(boolean criticalOnStartup)

Specified by:

setCriticalOnStartup in interface org.ikasan.spec.management.ManagedResource

getConfiguredResourceId

public String getConfiguredResourceId()

Specified by:

getConfiguredResourceId in interface org.ikasan.spec.configuration.ConfiguredResource<SchematronValidatorConfiguration>

setConfiguredResourceId

public void setConfiguredResourceId(String id)

Specified by:

setConfiguredResourceId in interface org.ikasan.spec.configuration.ConfiguredResource<SchematronValidatorConfiguration>

getConfiguration

public SchematronValidatorConfiguration getConfiguration()

Specified by:

getConfiguration in interface org.ikasan.spec.configuration.Configured<SchematronValidatorConfiguration>

setConfiguration

public void setConfiguration(SchematronValidatorConfiguration configuration)

Specified by:

setConfiguration in interface org.ikasan.spec.configuration.Configured<SchematronValidatorConfiguration>

getUriResolver

public URIResolver getUriResolver()

setUriResolver

public void setUriResolver(URIResolver uriResolver)