org.wso2.carbon.registry.core
Interface CoreRegistry

All Superinterfaces:
org.wso2.carbon.registry.api.CoreRegistry
All Known Subinterfaces:
Registry

public interface CoreRegistry
extends org.wso2.carbon.registry.api.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

newResource

Resource newResource()
                     throws RegistryException
Creates a new resource.

Specified by:
newResource in interface org.wso2.carbon.registry.api.CoreRegistry
Returns:
the created resource.
Throws:
RegistryException - if the operation failed.

newCollection

Collection newCollection()
                         throws RegistryException
Creates a new collection.

Specified by:
newCollection in interface org.wso2.carbon.registry.api.CoreRegistry
Returns:
the created collection.
Throws:
RegistryException - if the operation failed.

get

Resource get(String path)
             throws RegistryException
Returns the resource at the given path.

Specified by:
get in interface org.wso2.carbon.registry.api.CoreRegistry
Parameters:
path - Path of the resource. e.g. /project1/server/deployment.xml
Returns:
Resource instance
Throws:
RegistryException - is thrown if the resource is not in the registry

get

Collection get(String path,
               int start,
               int pageSize)
               throws RegistryException
Returns the Collection at the given path, with the content paginated according to the arguments.

Specified by:
get in interface org.wso2.carbon.registry.api.CoreRegistry
Parameters:
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
Returns:
a Collection containing the specified results in the content
Throws:
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.

resourceExists

boolean resourceExists(String path)
                       throws RegistryException
Check whether a resource exists at the given path

Specified by:
resourceExists in interface org.wso2.carbon.registry.api.CoreRegistry
Parameters:
path - Path of the resource to be checked
Returns:
true if a resource exists at the given path, false otherwise.
Throws:
RegistryException - if an error occurs

put

String put(String suggestedPath,
           Resource resource)
           throws RegistryException
Adds or updates resources in the registry. If there is no resource at the given path, resource is added. If a resource already exist at the given path, it will be replaced with the new resource.

Parameters:
suggestedPath - the path which we'd like to use for the new resource.
resource - Resource instance for the new resource
Returns:
@return the actual path that the server chose to use for our Resource, When an handler is used for the put operation the actual path needs to be set properly within the handler
Throws:
RegistryException - is thrown depending on the implementation.

delete

void delete(String path)
            throws RegistryException
Deletes the resource at the given path. If the path refers to a directory, all child resources of the directory will also be deleted.

Specified by:
delete in interface org.wso2.carbon.registry.api.CoreRegistry
Parameters:
path - Path of the resource to be deleted.
Throws:
RegistryException - is thrown depending on the implementation.


Copyright © 2014 WSO2 Inc. All Rights Reserved.