com.dtolabs.rundeck.core.storage

Interface ExtTree<S,T extends org.rundeck.storage.api.ContentMeta>

All Known Subinterfaces:

AuthStorageTree, AuthTree<T>

All Known Implementing Classes:

AuthRundeckStorageTree

public interface ExtTree<S,T extends org.rundeck.storage.api.ContentMeta>

ExtTree extends each tree method with additional parameter

Since:

2014-04-03

Method Summary

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

Method Detail

hasPath

boolean hasPath(S extra,
                org.rundeck.storage.api.Path path)

Return true if the path exists

Parameters:

path - path

extra - extra component

Returns:

true if it exists

hasResource

boolean hasResource(S extra,
                    org.rundeck.storage.api.Path path)

Return true if a resource at the path exists

Parameters:

path - path

extra - extra component

Returns:

true if a resource exists

hasDirectory

boolean hasDirectory(S extra,
                     org.rundeck.storage.api.Path path)

Return true if a directory at the path exists

Parameters:

path - path

extra - extra component

Returns:

true if the path is a directory

getPath

org.rundeck.storage.api.Resource<T> getPath(S extra,
                                            org.rundeck.storage.api.Path path)

Return the resource or directory at the path

Parameters:

path - path

extra - extra component

Returns:

Resource or directory

getResource

org.rundeck.storage.api.Resource<T> getResource(S extra,
                                                org.rundeck.storage.api.Path path)

Return the resource at the path

Parameters:

path - path

extra - extra component

Returns:

Resource

Throws:

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

listDirectoryResources

java.util.Set<org.rundeck.storage.api.Resource<T>> listDirectoryResources(S extra,
                                                                          org.rundeck.storage.api.Path path)

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

Parameters:

path - path

extra - extra component

Returns:

set of resources

listDirectory

java.util.Set<org.rundeck.storage.api.Resource<T>> listDirectory(S extra,
                                                                 org.rundeck.storage.api.Path path)

Return the set of resources at the directory path

Parameters:

path - path

extra - extra component

Returns:

set of resources

listDirectorySubdirs

java.util.Set<org.rundeck.storage.api.Resource<T>> listDirectorySubdirs(S extra,
                                                                        org.rundeck.storage.api.Path path)

Return the set of sub directory resources within the directory path

Parameters:

path - directory path

extra - extra component

Returns:

set of subdirectories

deleteResource

boolean deleteResource(S extra,
                       org.rundeck.storage.api.Path path)

Delete a resource at a path

Parameters:

path - path

extra - extra component

Returns:

true if the resource was deleted

Throws:

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

createResource

org.rundeck.storage.api.Resource<T> createResource(S extra,
                                                   org.rundeck.storage.api.Path path,
                                                   T content)

Create a resource

Parameters:

path - path

extra - extra component

content - content

Returns:

the resource

Throws:

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

updateResource

org.rundeck.storage.api.Resource<T> updateResource(S extra,
                                                   org.rundeck.storage.api.Path path,
                                                   T content)

Update an existing resource

Parameters:

path - path

extra - extra component

content - content

Returns:

the resource

Throws:

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