org.wso2.carbon.registry.core.jdbc.dao
Class ResourceVersionDAO

java.lang.Object
  extended by org.wso2.carbon.registry.core.jdbc.dao.ResourceVersionDAO

public class ResourceVersionDAO
extends Object

Data Access Object for Resources when versioning for resources has been enabled.


Constructor Summary
ResourceVersionDAO()
          Default constructor
 
Method Summary
 void createSnapshot(int pathId, String name, InputStream versionsStream)
           
 void fillChildren(CollectionImpl collectionImpl, VersionRetriever versionRetriever, int parentVersionIndex, int start, int pageLen, long snapshotID)
          Fill the children for a resource that already filled with meta data.
 void fillResourceContentArchived(ResourceImpl resourceImpl)
          Fill the archived content to the resource object.
 ResourceImpl get(ResourceIDImpl resourceID, long snapshotID)
          Returns the resource in the given path filled with meta-data and access to the content.
 CollectionImpl get(ResourceIDImpl resourceID, long snapshotID, int start, int pageLen)
          Return a collection with children only at the range of the intersect of the given range and resource existence range provided the resource path.
 int getChildCount(String resourceID, long versionNumber, Connection conn)
          Method to return a child count of a collection (database connection should also be provided)
 String[] getChildPaths(ResourceIDImpl resourceID, VersionRetriever versionRetriever, int parentVersionIndex, int start, int pageLen, long snapshotID, Connection conn)
          Get the child paths of a resource, (should be a collection)
 Long[] getSnapshotIDs(String resourcePath)
          Get the identifiers of the snapshots created for a given path.
 VersionRetriever getVersionList(long snapshotID)
          Creates version retriever that can be used to get the list of versions of a given snapshot, which includes the versions of the children.
 VersionRetriever getVersionList(ResourceIDImpl resourceID, long snapshotID)
          Creates version retriever that can be used to get the list of versions of a given snapshot, which includes the versions of the children if this was a collection.
 boolean isContentHistoryExist(int contentId)
          Check whether the content is already in the history.
 boolean isResourceHistoryExist(long version)
          Check whether the resource is already in the history with the give version
 boolean isResourceHistoryExist(ResourceIDImpl resourceID)
          Check whether the resource is already in the history with the give resourceID
 boolean isResourceHistoryExist(String path)
          Check whether the resource is already in the history with the give path
 void putResourceToHistory(ResourceDO resourceDO)
          Method to Archive Resource.
 String restoreResources(long version)
          Restore the resource to the given version.
 void versionResource(ResourceDO resourceDO, boolean keepProperties)
          Create a version of the given resource.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResourceVersionDAO

public ResourceVersionDAO()
Default constructor

Method Detail

getSnapshotIDs

public Long[] getSnapshotIDs(String resourcePath)
                      throws RegistryException
Get the identifiers of the snapshots created for a given path.

Parameters:
resourcePath - the resource path
Returns:
a list of identifiers
Throws:
RegistryException - if an error occurs.

fillResourceContentArchived

public void fillResourceContentArchived(ResourceImpl resourceImpl)
                                 throws RegistryException
Fill the archived content to the resource object.

Parameters:
resourceImpl - the resource object.
Throws:
RegistryException - if an error occurs.

get

public ResourceImpl get(ResourceIDImpl resourceID,
                        long snapshotID)
                 throws RegistryException
Returns the resource in the given path filled with meta-data and access to the content. If a resource does not exist in the given resourceID, null is returned.

Parameters:
resourceID - the resource id
snapshotID - the snapshot id
Returns:
resource object.
Throws:
RegistryException - throws if resource retrieval failed.

getVersionList

public VersionRetriever getVersionList(ResourceIDImpl resourceID,
                                       long snapshotID)
                                throws RegistryException
Creates version retriever that can be used to get the list of versions of a given snapshot, which includes the versions of the children if this was a collection.

Parameters:
resourceID - the resource id
snapshotID - the snapshot id
Returns:
version retriever instance.
Throws:
RegistryException - if the operation failed.
See Also:
VersionRetriever

getVersionList

public VersionRetriever getVersionList(long snapshotID)
                                throws RegistryException
Creates version retriever that can be used to get the list of versions of a given snapshot, which includes the versions of the children.

Parameters:
snapshotID - the snapshot id
Returns:
version retriever instance.
Throws:
RegistryException - if the operation failed.
See Also:
VersionRetriever

get

public CollectionImpl get(ResourceIDImpl resourceID,
                          long snapshotID,
                          int start,
                          int pageLen)
                   throws RegistryException
Return a collection with children only at the range of the intersect of the given range and resource existence range provided the resource path. Use for resource browser pagination.

Parameters:
resourceID - resource id of the collection.
snapshotID - snapshot id of the collection.
start - start value of the range of children.
pageLen - the length of the children to retrieve
Returns:
an instance of collection with child
Throws:
RegistryException - throws if resource retrieval failed.

fillChildren

public void fillChildren(CollectionImpl collectionImpl,
                         VersionRetriever versionRetriever,
                         int parentVersionIndex,
                         int start,
                         int pageLen,
                         long snapshotID)
                  throws RegistryException
Fill the children for a resource that already filled with meta data. Children are filled only at the at of the intersect of the given range and resource existence range.

Parameters:
collectionImpl - collection to fill the children and properties.
versionRetriever - the version retriever used to get the versions.
parentVersionIndex - the version index of the parent.
start - start value of the range of children.
pageLen - the length of the children to retrieve.
snapshotID - the snapshot id.
Throws:
RegistryException - if the operation failed.

getChildCount

public int getChildCount(String resourceID,
                         long versionNumber,
                         Connection conn)
                  throws RegistryException
Method to return a child count of a collection (database connection should also be provided)

Parameters:
resourceID - the resource id of the collection object which the children are calculated.
versionNumber - the version number.
conn - the database connection.
Returns:
the child count.
Throws:
RegistryException - throws if the operation failed.

getChildPaths

public String[] getChildPaths(ResourceIDImpl resourceID,
                              VersionRetriever versionRetriever,
                              int parentVersionIndex,
                              int start,
                              int pageLen,
                              long snapshotID,
                              Connection conn)
                       throws RegistryException
Get the child paths of a resource, (should be a collection)

Parameters:
resourceID - the resource id of the collection.
versionRetriever - the version retriever to be used.
snapshotID - the snapshot id.
start - start value of the range of children.
pageLen - the length of the children to retrieve.
parentVersionIndex - the version index of the parent.
conn - the database connection.
Returns:
an array of child paths.
Throws:
RegistryException - throws if the operation failed.

createSnapshot

public void createSnapshot(int pathId,
                           String name,
                           InputStream versionsStream)
                    throws RegistryException
Throws:
RegistryException

isResourceHistoryExist

public boolean isResourceHistoryExist(long version)
                               throws RegistryException
Check whether the resource is already in the history with the give version

Parameters:
version - the version
Returns:
whether the resource exists in the history.
Throws:
RegistryException - if the operation failed.

isResourceHistoryExist

public boolean isResourceHistoryExist(String path)
                               throws RegistryException
Check whether the resource is already in the history with the give path

Parameters:
path - the resource path
Returns:
whether the resource exists in the history.
Throws:
RegistryException - if the operation failed.

isResourceHistoryExist

public boolean isResourceHistoryExist(ResourceIDImpl resourceID)
                               throws RegistryException
Check whether the resource is already in the history with the give resourceID

Parameters:
resourceID - the resource identifier.
Returns:
whether the resource exists in the history.
Throws:
RegistryException - if the operation failed.

isContentHistoryExist

public boolean isContentHistoryExist(int contentId)
                              throws RegistryException
Check whether the content is already in the history.

Parameters:
contentId - the content identifier.
Returns:
true if it exist in history, false otherwise.
Throws:
RegistryException - if the operation failed.

restoreResources

public String restoreResources(long version)
                        throws RegistryException
Restore the resource to the given version.

Parameters:
version - the version.
Returns:
the resource path.
Throws:
RegistryException - if the operation failed.

versionResource

public void versionResource(ResourceDO resourceDO,
                            boolean keepProperties)
                     throws RegistryException
Create a version of the given resource.

Parameters:
resourceDO - the resource data object.
keepProperties - whether to keep properties or not.
Throws:
RegistryException - if the operation failed.
See Also:
putResourceToHistory(org.wso2.carbon.registry.core.jdbc.dataobjects.ResourceDO)

putResourceToHistory

public void putResourceToHistory(ResourceDO resourceDO)
                          throws RegistryException
Method to Archive Resource.

Parameters:
resourceDO - the resource data object.
Throws:
RegistryException - if the operation failed.


Copyright © 2010. All Rights Reserved.