|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface CoreRegistry
This represents the most fundamental API for the Registry. This is typically what you want if you're a Java programmer wanting to simply store and manage Resources. This interface can be used to perform all basic registry operations, and can also be used to implement a simple registry implementation. Being an interface, this gives the developers the flexibility of using this without having to worry about the implementation.
If you want programmatic access to features like tags, comments, ratings, and versions, please have a look at the fullRegistry interface which extends this.
| Method Summary | |
|---|---|
void |
delete(String path)
Deletes the resource at the given path. |
Resource |
get(String path)
Returns the resource at the given path. |
Collection |
get(String path,
int start,
int pageSize)
Returns the Collection at the given path, with the content paginated according to the arguments. |
Collection |
newCollection()
Creates a new collection. |
Resource |
newResource()
Creates a new resource. |
String |
put(String suggestedPath,
Resource resource)
Adds or updates resources in the registry. |
boolean |
resourceExists(String path)
Check whether a resource exists at the given path |
| Method Detail |
|---|
Resource newResource()
throws RegistryException
RegistryException - if the operation failed.
Collection newCollection()
throws RegistryException
RegistryException - if the operation failed.
Resource get(String path)
throws RegistryException
path - Path of the resource. e.g. /project1/server/deployment.xml
RegistryException - is thrown if the resource is not in the registry
Collection get(String path,
int start,
int pageSize)
throws RegistryException
path - the path of the collection. MUST point to a collection!start - the initial index of the child to return. If there are fewer children than
the specified value, a RegistryException will be thrown.pageSize - the maximum number of results to return
RegistryException - if the resource is not found, or if the path does not reference a
Collection, or if the start index is greater than the number of
children.
boolean resourceExists(String path)
throws RegistryException
path - Path of the resource to be checked
RegistryException - if an error occurs
String put(String suggestedPath,
Resource resource)
throws RegistryException
suggestedPath - the path which we'd like to use for the new resource.resource - Resource instance for the new resource
RegistryException - is thrown depending on the implementation.
void delete(String path)
throws RegistryException
path - Path of the resource to be deleted.
RegistryException - is thrown depending on the implementation.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||