Package liquibase.resource

Class CompositeResourceAccessor

java.lang.Object

liquibase.AbstractExtensibleObject

liquibase.resource.AbstractResourceAccessor

liquibase.resource.CompositeResourceAccessor

All Implemented Interfaces:

AutoCloseable, Cloneable, ExtensibleObject, ResourceAccessor

Direct Known Subclasses:

AntResourceAccessor, FileSystemResourceAccessor, SearchPathResourceAccessor

public class CompositeResourceAccessor
extends AbstractResourceAccessor

A ResourceAccessor that contains multiple sub-accessors and combines the results of all of them. For the "overall" aggregate resource accessor, integrations should generally use SearchPathResourceAccessor instead of this.

Nested Class Summary

Nested classes/interfaces inherited from interface liquibase.resource.ResourceAccessor

ResourceAccessor.NotFoundResource, ResourceAccessor.SearchOptions

Constructor Summary

Constructors

Constructor	Description
CompositeResourceAccessor(Collection<ResourceAccessor> resourceAccessors)
CompositeResourceAccessor(ResourceAccessor... resourceAccessors)

Method Summary

Modifier and Type	Method	Description
CompositeResourceAccessor	addResourceAccessor(ResourceAccessor resourceAccessor)
void	close()
List<String>	describeLocations()	Returns a description of the places this classloader will look for paths.
List<Resource>	getAll(String path)	Returns all Resources at the given path.
void	removeResourceAccessor(ResourceAccessor resourceAccessor)
List<Resource>	search(String path, boolean recursive)	Returns the path to all resources contained in the given path.
List<Resource>	search(String path, ResourceAccessor.SearchOptions searchOptions)	Returns the path to all resources contained in the given path that match the searchOptions criteria.

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

Methods inherited from interface liquibase.resource.ResourceAccessor

get, getExisting, handleDuplicateFileModeLogging, list, openStream, openStreams

Constructor Details

CompositeResourceAccessor

public CompositeResourceAccessor(ResourceAccessor... resourceAccessors)

CompositeResourceAccessor

public CompositeResourceAccessor(Collection<ResourceAccessor> resourceAccessors)

Method Details

close

public void close()
           throws Exception

Throws:

Exception

addResourceAccessor

public CompositeResourceAccessor addResourceAccessor(ResourceAccessor resourceAccessor)

removeResourceAccessor

public void removeResourceAccessor(ResourceAccessor resourceAccessor)

search

public List<Resource> search(String path,
 ResourceAccessor.SearchOptions searchOptions)
                      throws IOException

Description copied from interface: ResourceAccessor

Returns the path to all resources contained in the given path that match the searchOptions criteria. Multiple resources may be returned with the same path, but only if they are actually unique files. Order is important to pay attention to, they should be returned in a user-expected manner based on this resource accessor.

Should return an empty list if:

• Path does not exist or maxDepth less or equals than zero

Should throw an exception if:

• Path is null
• Path is not a "directory"
• Path exists but cannot be read from

Parameters:

path - The path to lookup resources in.

searchOptions - A set of criteria for how resources should be found/filtered

Returns:

empty set if nothing was found

Throws:

IOException - if there is an error searching the system.

search

public List<Resource> search(String path,
 boolean recursive)
                      throws IOException

Description copied from interface: ResourceAccessor

Returns the path to all resources contained in the given path. Multiple resources may be returned with the same path, but only if they are actually unique files. Order is important to pay attention to, they should be returned in a user-expected manner based on this resource accessor.

Should return an empty list if:

• Path does not exist

Should throw an exception if:

• Path is null
• Path is not a "directory"
• Path exists but cannot be read from

Parameters:

path - The path to lookup resources in.

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

Returns:

empty set if nothing was found

Throws:

IOException - if there is an error searching the system.

getAll

public List<Resource> getAll(String path)
                      throws IOException

Description copied from interface: ResourceAccessor

Returns all Resources at the given path. For many resource accessors (such as a file system), only one resource can exist at a given spot, but some accessors (such as CompositeResourceAccessor or ClassLoaderResourceAccessor) can have multiple resources for a single path.

If the resourceAccessor returns multiple values, the returned List should be considered sorted for that resource accessor. For example, ClassLoaderResourceAccessor returns them in order based on the configured classloader. Order is important to pay attention to, because users may set GlobalConfiguration.DUPLICATE_FILE_MODE to pick the "best" file which is defined as "the first file from this function".

Returns:

null if no resources match the path

Throws:

IOException - if there is an unexpected error determining what is at the path

describeLocations

public List<String> describeLocations()

Description copied from interface: ResourceAccessor

Returns a description of the places this classloader will look for paths. Used in error messages and other troubleshooting cases.