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

static class

IngestXmlExecutable.Builder

Method Summary

void	execute()
List<String>	getLocationListings()
com.google.common.base.Optional<XmlIngesterService>	getService()
protected List<XmlDocCollection>	getXmlDocCollectionList(List<String> locationListings)
protected Collection<XmlDocCollection>	ingest(List<XmlDocCollection> collections)
boolean	isSkip()
protected void	validateNoFailures(Collection<XmlDocCollection> failures)

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

getXmlDocCollectionList

protected List<XmlDocCollection> getXmlDocCollectionList(List<String> locationListings)

validateNoFailures

protected void validateNoFailures(Collection<XmlDocCollection> failures)

ingest

protected Collection<XmlDocCollection> ingest(List<XmlDocCollection> collections)

getService

public com.google.common.base.Optional<XmlIngesterService> getService()

getLocationListings

public List<String> getLocationListings()

isSkip

public boolean isSkip()