|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CoreRegistry
CoreRegistry is the central get/put API for the Registry. This is typically what you want if you're a Java programmer wanting to simply store and manage Resources. Since it's an interface, you don't care if the results come from (say) an embedded file-based Registry or a remote one - that decision (and the resulting cache dynamics, exception throwing, etc) can be made by a factory or dependency injection.
If you want programmatic access to features like tags/comments/ratings/versions, please have a look at the full Registry interface which extends this one.
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 |
Methods inherited from interface org.wso2.carbon.registry.api.CoreRegistry |
---|
put |
Method Detail |
---|
Resource newResource() throws RegistryException
newResource
in interface org.wso2.carbon.registry.api.CoreRegistry
RegistryException
- if the operation failed.Collection newCollection() throws RegistryException
newCollection
in interface org.wso2.carbon.registry.api.CoreRegistry
RegistryException
- if the operation failed.Resource get(String path) throws RegistryException
get
in interface org.wso2.carbon.registry.api.CoreRegistry
path
- Path of the resource. e.g. /project1/server/deployment.xml
RegistryException
- is thrown if the resource is not in the registryCollection get(String path, int start, int pageSize) throws RegistryException
get
in interface org.wso2.carbon.registry.api.CoreRegistry
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
resourceExists
in interface org.wso2.carbon.registry.api.CoreRegistry
path
- Path of the resource to be checked
RegistryException
- if an error occursString 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
delete
in interface org.wso2.carbon.registry.api.CoreRegistry
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 |