org.liquibase.maven.plugins

Class MavenResourceAccessor

java.lang.Object

liquibase.AbstractExtensibleObject

liquibase.resource.AbstractResourceAccessor

liquibase.resource.ClassLoaderResourceAccessor

org.liquibase.maven.plugins.MavenResourceAccessor

All Implemented Interfaces:

AutoCloseable, Cloneable, ExtensibleObject, ResourceAccessor

public class MavenResourceAccessor
extends ClassLoaderResourceAccessor

Extension of ClassLoaderResourceAccessor for Maven which will use a default or user specified ClassLoader to load files/resources.

Field Summary

Fields inherited from class liquibase.resource.ClassLoaderResourceAccessor

description, rootPaths

Constructor Summary

Constructors

Constructor and Description
MavenResourceAccessor(ClassLoader classLoader)

Method Summary

Modifier and Type	Method and Description
SortedSet<String>	list(String relativeTo, String path, boolean recursive, boolean includeFiles, boolean includeDirectories) Returns the path to all resources contained in the given path.
InputStreamList	openStreams(String relativeTo, String streamPath) Return the streams for each resource mapped by the given path.

Methods inherited from class liquibase.resource.ClassLoaderResourceAccessor

close, describeLocations, getFinalPath, init, isDirectory, listFromClassLoader, listFromRootPaths, loadRootPaths

Methods inherited from class liquibase.resource.AbstractResourceAccessor

openStream

Methods inherited from class liquibase.AbstractExtensibleObject

clone, describe, equals, get, get, get, getAttributes, getFieldValue, getObjectMetaData, getValuePath, has, hashCode, set, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MavenResourceAccessor

public MavenResourceAccessor(ClassLoader classLoader)

Method Detail

openStreams

public InputStreamList openStreams(String relativeTo,
                                   String streamPath)
                            throws IOException

Description copied from interface: ResourceAccessor

Return the streams for each resource mapped by the given path. The path is often a URL but does not have to be. Should accept both / and \ chars for file paths to be platform-independent. If path points to a compressed resource, return a stream of the uncompressed contents of the file. Returns InputStreamList since multiple resources can map to the same path, such as "META-INF/MAINFEST.MF". Remember to close streams when finished with them.

Specified by:

openStreams in interface ResourceAccessor

Overrides:

openStreams in class ClassLoaderResourceAccessor

Parameters:

relativeTo - Location that streamPath should be found relative to. If null, streamPath is an absolute path

Returns:

Empty list if the resource does not exist.

Throws:

IOException - if there is an error reading an existing path.

list

public SortedSet<String> list(String relativeTo,
                              String path,
                              boolean recursive,
                              boolean includeFiles,
                              boolean includeDirectories)
                       throws IOException

Description copied from interface: ResourceAccessor

Returns the path to all resources contained in the given path. The passed path is not included in the returned set. Returned strings should use "/" for file path separators, regardless of the OS and should accept both / and \ chars for file paths to be platform-independent. Returned set is sorted, normally alphabetically but subclasses can use different comparators. The values returned should be able to be passed into ResourceAccessor.openStreams(String, String) and return the contents. Returned paths should normally be root-relative and therefore not be an absolute path, unless there is a good reason to be absolute.

Specified by:

list in interface ResourceAccessor

Overrides:

list in class ClassLoaderResourceAccessor

Parameters:

relativeTo - Location that streamPath should be found relative to. If null, path is an absolute path

path - The path to lookup resources in.

recursive - Set to true and will return paths to contents in sub directories as well.

includeFiles - Set to true and will return paths to files.

includeDirectories - Set to true and will return paths to directories.

Returns:

empty set if nothing was found

Throws:

IOException - if there is an error reading an existing root.