org.rundeck.storage.api

Interface Tree<T extends ContentMeta>

All Known Subinterfaces:

SelectiveTree<T>, StoragePlugin, StorageTree

All Known Implementing Classes:

BaseDelegateTree, ConverterTree, DelegateTree, EmptyTree, FileTree, ListenerTree, LockingTree, MemoryTree, StorageTreeImpl, StringToPathTree, SubPathTree, TreeStack

public interface Tree<T extends ContentMeta>

Stores content in a hierarchy

Method Summary

Modifier and Type	Method and Description
Resource<T>	createResource(Path path, T content) Create a resource
Resource<T>	createResource(java.lang.String path, T content)
boolean	deleteResource(Path path) Delete a resource at a path
boolean	deleteResource(java.lang.String path)
Resource<T>	getPath(Path path) Return the resource or directory at the path
Resource<T>	getPath(java.lang.String path)
Resource<T>	getResource(Path path) Return the resource at the path
Resource<T>	getResource(java.lang.String path)
boolean	hasDirectory(Path path) Return true if a directory at the path exists
boolean	hasDirectory(java.lang.String path)
boolean	hasPath(Path path) Return true if the path exists
boolean	hasPath(java.lang.String path)
boolean	hasResource(Path path) Return true if a resource at the path exists
boolean	hasResource(java.lang.String path)
java.util.Set<Resource<T>>	listDirectory(Path path) Return the set of resources at the directory path
java.util.Set<Resource<T>>	listDirectory(java.lang.String path)
java.util.Set<Resource<T>>	listDirectoryResources(Path path) Return the set of non-directory resources at the directory path
java.util.Set<Resource<T>>	listDirectoryResources(java.lang.String path)
java.util.Set<Resource<T>>	listDirectorySubdirs(Path path) Return the set of sub directory resources within the directory path
java.util.Set<Resource<T>>	listDirectorySubdirs(java.lang.String path)
Resource<T>	updateResource(Path path, T content) Update an existing resource
Resource<T>	updateResource(java.lang.String path, T content)

Method Detail

hasPath

boolean hasPath(Path path)

Return true if the path exists

Parameters:

path - path

Returns:

true if it exists

hasPath

boolean hasPath(java.lang.String path)

hasResource

boolean hasResource(Path path)

Return true if a resource at the path exists

Parameters:

path - path

Returns:

true if a resource exists

hasResource

boolean hasResource(java.lang.String path)

hasDirectory

boolean hasDirectory(Path path)

Return true if a directory at the path exists

Parameters:

path - path

Returns:

true if the path is a directory

hasDirectory

boolean hasDirectory(java.lang.String path)

getPath

Resource<T> getPath(Path path)

Return the resource or directory at the path

Parameters:

path - path

Returns:

Resource or directory

getPath

Resource<T> getPath(java.lang.String path)

getResource

Resource<T> getResource(Path path)

Return the resource at the path

Parameters:

path - path

Returns:

Resource

Throws:

java.lang.IllegalArgumentException - if the path is a directory or does not exist

getResource

Resource<T> getResource(java.lang.String path)

listDirectoryResources

java.util.Set<Resource<T>> listDirectoryResources(Path path)

Return the set of non-directory resources at the directory path

Parameters:

path - path

Returns:

set of resources

listDirectoryResources

java.util.Set<Resource<T>> listDirectoryResources(java.lang.String path)

listDirectory

java.util.Set<Resource<T>> listDirectory(Path path)

Return the set of resources at the directory path

Parameters:

path - path

Returns:

set of resources

listDirectory

java.util.Set<Resource<T>> listDirectory(java.lang.String path)

listDirectorySubdirs

java.util.Set<Resource<T>> listDirectorySubdirs(Path path)

Return the set of sub directory resources within the directory path

Parameters:

path - directory path

Returns:

set of subdirectories

listDirectorySubdirs

java.util.Set<Resource<T>> listDirectorySubdirs(java.lang.String path)

deleteResource

boolean deleteResource(Path path)

Delete a resource at a path

Parameters:

path - path

Returns:

true if the resource was deleted

Throws:

java.lang.IllegalArgumentException - if the path is a directory or does not exist

deleteResource

boolean deleteResource(java.lang.String path)

createResource

Resource<T> createResource(Path path,
                           T content)

Create a resource

Parameters:

path - path

content - resource content

Returns:

the resource

Throws:

java.lang.IllegalArgumentException - if the path is a directory

createResource

Resource<T> createResource(java.lang.String path,
                           T content)

updateResource

Resource<T> updateResource(Path path,
                           T content)

Update an existing resource

Parameters:

path - path

content - resource content

Returns:

the resource

Throws:

java.lang.IllegalArgumentException - if the path is a directory or does not exist

updateResource

Resource<T> updateResource(java.lang.String path,
                           T content)