org.fcrepo.server.validation
Class DOValidatorModule

java.lang.Object
  org.fcrepo.server.Parameterized
      org.fcrepo.server.Pluggable
          org.fcrepo.server.Module
              org.fcrepo.server.validation.DOValidatorModule

All Implemented Interfaces:

Constants, DOValidator

public class DOValidatorModule
extends Module
implements DOValidator

Module Wrapper for DOValidatorImpl.

Author:

Sandy Payette

Nested Class Summary

Nested classes/interfaces inherited from interface org.fcrepo.common.Constants

Constants.FedoraHome

Field Summary

Fields inherited from interface org.fcrepo.server.validation.DOValidator

PHASE_INGEST, PHASE_STORE, VALIDATE_ALL, VALIDATE_NONE, VALIDATE_SCHEMATRON, VALIDATE_XML_SCHEMA

Fields inherited from interface org.fcrepo.common.Constants

ACCESS, ACTION, API, ATOM_APIM1_0, ATOM_ZIP1_1, ATOM1_1, AUDIT, AUDIT1_0, BATCH_MODIFY, BATCH_MODIFY1_1, BE_SECURITY, BE_SECURITY1_0, BINDING_SPEC, DATASTREAM, DC, DISSEMINATOR, DS_COMPOSITE_MODEL, DS_COMPOSITE_MODEL1_0, DS_INPUT_SPEC1_0, DS_INPUT_SPEC1_1, ENVIRONMENT, FCFG, FEDORA, FEDORA_APP_CONTEXT_NAME, FEDORA_DEFAULT_APP_CONTEXT, FEDORA_HOME, FEDORA_REPOSITORY_PID, FOXML, FOXML1_0, FOXML1_0_LEGACY, FOXML1_1, HTTP_REQUEST, MANAGEMENT, METHOD_MAP, METS, METS_EXT, METS_EXT1_0, METS_EXT1_0_LEGACY, METS_EXT1_1, MODEL, MULGARA, OAI_DC, OAI_DC2_0, OAI_FRIENDS, OAI_FRIENDS2_0, OAI_IDENTIFIER, OAI_IDENTIFIER2_0, OAI_PMH, OAI_PMH2_0, OAI_PROV, OAI_PROV2_0, OBJ_DATASTREAMS1_0, OBJ_HISTORY1_0, OBJ_ITEMS1_0, OBJ_METHODS1_0, OBJ_PROFILE1_0, OBJ_VALIDATION1_0, OBJECT, OLD_XLINK, PID_LIST1_0, RDF, RDF_XSD, RECOVERY, RELS_EXT, RELS_EXT1_0, RELS_INT1_0, REPO_DESC1_0, RESOURCE, SDEF, SDEF_METHOD_MAP1_0, SDEP, SDEP_METHOD_MAP1_0, SDEP_METHOD_MAP1_1, SERVICE_PROFILE, SOAP, SOAP_ENC, SUBJECT, TYPES, VIEW, WSDL, WSDL_HTTP, WSDL_MIME, XACML_POLICY, XACML_POLICY1_0, XACML1, XACML1_ACTION, XACML1_POLICY, XACML1_RESOURCE, XACML1_SUBJECT, XACML2_POLICY_SCHEMA, XLINK, XML_XSD, XMLNS, XSI

Constructor Summary

DOValidatorModule(Map<String,String> moduleParameters, Server server, String role)
Constructs a new DOValidatorModule

Method Summary

void	postInitModule() Second stage of Module initialization.
void	validate(File objectAsFile, String format, int validationType, String phase) Validates a digital object.
void	validate(InputStream objectAsStream, String format, int validationType, String phase) Validates a digital object.

Methods inherited from class org.fcrepo.server.Module

getRole, getServer, initModule, shutdownModule

Methods inherited from class org.fcrepo.server.Pluggable

getHelp, getOptionalParameters, getParameterHelp, getRequiredModuleRoles, getRequiredParameters

Methods inherited from class org.fcrepo.server.Parameterized

getParameter, getParameter, getParameter, getParameterList, getParameters, getParameters, parameterNames, setParameter, setParameters, setParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

DOValidatorModule

public DOValidatorModule(Map<String,String> moduleParameters,
                         Server server,
                         String role)
                  throws ModuleInitializationException,
                         ServerException

Constructs a new DOValidatorModule

Parameters:

moduleParameters - The name/value pair map of module parameters.

server - The server instance.

role - The module role name.

Throws:

ModuleInitializationException - If initialization values are invalid or initialization fails for some other reason.

ServerException

Method Detail

postInitModule

public void postInitModule()
                    throws ModuleInitializationException

Description copied from class: Module

Second stage of Module initialization. This is guaranteed to run after all Modules' initModule() methods have run.

Overrides:

postInitModule in class Module

Throws:

ModuleInitializationException - If initialization values are invalid or initialization fails for some other reason.

validate

public void validate(InputStream objectAsStream,
                     String format,
                     int validationType,
                     String phase)
              throws ServerException

Validates a digital object.

Specified by:

validate in interface DOValidator

Parameters:

objectAsStream - The digital object provided as a bytestream.

validationType - The level of validation to perform on the digital object. This is an integer from 0-2 with the following meanings: 0 = VALIDATE_ALL (do all validation levels) 1 = VALIDATE_XML_SCHEMA (perform only XML Schema validation) 2 = VALIDATE_SCHEMATRON (perform only Schematron Rules validation)

phase - The stage in the work flow for which the validation should be contextualized. "ingest" = the object is in the submission format for the ingest stage phase "store" = the object is in the authoritative format for the final storage phase

Throws:

ServerException - If validation fails for any reason.

validate

public void validate(File objectAsFile,
                     String format,
                     int validationType,
                     String phase)
              throws ServerException

Validates a digital object.

Specified by:

validate in interface DOValidator

Parameters:

objectAsFile - The digital object provided as a file.

validationType - The level of validation to perform on the digital object. This is an integer from 0-2 with the following meanings: 0 = VALIDATE_ALL (do all validation levels) 1 = VALIDATE_XML_SCHEMA (perform only XML Schema validation) 2 = VALIDATE_SCHEMATRON (perform only Schematron Rules validation)

phase - The stage in the work flow for which the validation should be contextualized. "ingest" = the object is in the submission format for the ingest stage phase "store" = the object is in the authoritative format for the final storage phase

Throws:

ServerException - If validation fails for any reason.