org.kuali.rice.xml.ingest

Class IngestXmlExecutable

java.lang.Object

org.kuali.rice.xml.ingest.IngestXmlExecutable

All Implemented Interfaces:

org.kuali.common.util.execute.Executable

public final class IngestXmlExecutable
extends Object
implements org.kuali.common.util.execute.Executable

Locates workflow XML documents available on the classpath and ingests them.

No file system access is required. The XML documents are ingested using Spring's classpath: notation to locate them, open an InputStream, and feed them to the ingester service. Any workflow document failing to be ingested correctly results in an exception being thrown.

If an explicit XmlIngesterService instance is not provided, CoreApiServiceLocator.getXmlIngesterService() must be able to correctly locate XmlIngesterService.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IngestXmlExecutable.Builder Builds this IngestXmlExecutable.

Method Summary

Methods

Modifier and Type	Method and Description
static IngestXmlExecutable.Builder	builder(List<String> xmlDocumentLocations) Returns the builder for this IngestXmlExecutable.
void	execute()
XmlIngesterService	getXmlIngesterService() Returns the XmlIngesterService.

Methods inherited from class java.lang.Object

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

Method Detail

execute

public void execute()

Specified by:

execute in interface org.kuali.common.util.execute.Executable

getXmlIngesterService

public XmlIngesterService getXmlIngesterService()

Returns the XmlIngesterService.

Returns:

the XmlIngesterService

builder

public static IngestXmlExecutable.Builder builder(List<String> xmlDocumentLocations)

Returns the builder for this IngestXmlExecutable.

Parameters:

xmlDocumentLocations - the list of locations with XML documents to ingest

Returns:

the builder for this IngestXmlExecutable