Top Description Fields Constructors Methods
liquibase.resource

public Class CompositeResourceAccessor

extends AbstractResourceAccessor
Class Inheritance
Known Direct Subclasses
liquibase.resource.FileSystemResourceAccessor, liquibase.resource.SearchPathResourceAccessor, liquibase.integration.ant.AntResourceAccessor
Imports
liquibase.Scope, liquibase.util.CollectionUtil, java.io.IOException, java.util.*
A liquibase.resource.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.

Field Summary

Modifier and TypeField and Description
private final List<ResourceAccessor>
resourceAccessors

Constructor Summary

AccessConstructor and Description
public
CompositeResourceAccessor(ResourceAccessor... resourceAccessors)

public
CompositeResourceAccessor(Collection<ResourceAccessor> resourceAccessors)

Method Summary

Modifier and TypeMethod and Description
public CompositeResourceAccessor
addResourceAccessor(ResourceAccessor resourceAccessor)

public void
close()

Implements java.lang.AutoCloseable.close.

Closes this resource, relinquishing any underlying resources.

public List<String>
describeLocations()

Implements liquibase.resource.ResourceAccessor.describeLocations.

Returns a description of the places this classloader will look for paths.

public List<Resource>
getAll(String path)

Implements liquibase.resource.ResourceAccessor.getAll.

Returns all Resources at the given path.

public void
removeResourceAccessor(ResourceAccessor resourceAccessor)

public List<Resource>
search(String
The path to lookup resources in.
path, ResourceAccessor.SearchOptions
A set of criteria for how resources should be found/filtered
searchOptions)

Overrides default liquibase.resource.ResourceAccessor.search.

Returns the path to all resources contained in the given path that match the searchOptions criteria.

public List<Resource>
search(String
The path to lookup resources in.
path, boolean
Set to true and will return paths to contents in subdirectories as well.
recursive)

Implements liquibase.resource.ResourceAccessor.search.

Returns the path to all resources contained in the given path.

Field Detail

resourceAccessorsback to summary
private final List<ResourceAccessor> resourceAccessors

Constructor Detail

CompositeResourceAccessorback to summary
public CompositeResourceAccessor(ResourceAccessor... resourceAccessors)
CompositeResourceAccessorback to summary
public CompositeResourceAccessor(Collection<ResourceAccessor> resourceAccessors)

Method Detail

addResourceAccessorback to summary
public CompositeResourceAccessor addResourceAccessor(ResourceAccessor resourceAccessor)
closeback to summary
public void close() throws Exception

Implements java.lang.AutoCloseable.close.

Doc from java.lang.AutoCloseable.close.

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Annotations
@Override
Exceptions
Exception:
if this resource cannot be closed
describeLocationsback to summary
public List<String> describeLocations()

Implements liquibase.resource.ResourceAccessor.describeLocations.

Doc from liquibase.resource.ResourceAccessor.describeLocations.

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

Annotations
@Override
getAllback to summary
public List<Resource> getAll(String path) throws IOException

Implements liquibase.resource.ResourceAccessor.getAll.

Doc from liquibase.resource.ResourceAccessor.getAll.

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:List<Resource>

null if no resources match the path

Annotations
@Override
Exceptions
IOException:
if there is an unexpected error determining what is at the path
removeResourceAccessorback to summary
public void removeResourceAccessor(ResourceAccessor resourceAccessor)
searchback to summary
public List<Resource> search(String path, ResourceAccessor.SearchOptions searchOptions) throws IOException

Overrides default liquibase.resource.ResourceAccessor.search.

Doc from liquibase.resource.ResourceAccessor.search.

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:String

The path to lookup resources in.

searchOptions:ResourceAccessor.SearchOptions

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

Returns:List<Resource>

empty set if nothing was found

Annotations
@Override
Exceptions
IOException:
if there is an error searching the system.
searchback to summary
public List<Resource> search(String path, boolean recursive) throws IOException

Implements liquibase.resource.ResourceAccessor.search.

Doc from liquibase.resource.ResourceAccessor.search.

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:String

The path to lookup resources in.

recursive:boolean

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

Returns:List<Resource>

empty set if nothing was found

Annotations
@Override
Exceptions
IOException:
if there is an error searching the system.