WorkspaceStorageConnection (eXo Platform - Java API Documentation 4.3.1-W46 API)

```
public interface WorkspaceStorageConnection
```
Created by The eXo Platform SAS
Includes methods for direct read (by identifier and qPath), node child traversing, reference access as well as write single item methods (add, update, delete) and batch operations support. Valid (workable) connection state is "opened" (isOpened() == true). Newly created connection should have "opened" state. The connection becomes "closed" (invalid for using) after calling commit() or rollback() methods. In this case methods calling will cause an IllegalStateException Connection object intends to be as "light" as possible i.e. connection creation SHOULD NOT be expensive operation, so better NOT to open/close potentially EXPENSIVE resources using by Connection (WorkspaceDataContainer should be responsible for that). The Connection IS NOT a thread-safe object and normally SHOULD NOT be pooled/cached.

Version:

$Id: WorkspaceStorageConnection.java 11907 2008-03-13 15:36:21Z ksm $

Author:

Gennady Azarenkov

Level API:

Unsupported

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(org.exoplatform.services.jcr.datamodel.NodeData data)` Adds single `NodeData`.
`void`	`add(org.exoplatform.services.jcr.datamodel.PropertyData data, org.exoplatform.services.jcr.impl.dataflow.persistent.ChangedSizeHandler sizeHandler)` Adds single `PropertyData`.
`void`	`close()` Close connection.
`void`	`commit()` Persist changes and closes connection.
`void`	`delete(org.exoplatform.services.jcr.datamodel.NodeData data)` Deletes `NodeData`.
`void`	`delete(org.exoplatform.services.jcr.datamodel.PropertyData data, org.exoplatform.services.jcr.impl.dataflow.persistent.ChangedSizeHandler sizeHandler)` Deletes `PropertyData`.
`List<org.exoplatform.services.jcr.impl.dataflow.persistent.ACLHolder>`	`getACLHolders()` Returns all the nodes that hold some ACL info like owner or permissions
`int`	`getChildNodesCount(org.exoplatform.services.jcr.datamodel.NodeData parent)` Reads count of `parent child nodes.`
`List<org.exoplatform.services.jcr.datamodel.NodeData>`	`getChildNodesData(org.exoplatform.services.jcr.datamodel.NodeData parent)` Reads `List` of `NodeData` from the storage using item's parent location.
`List<org.exoplatform.services.jcr.datamodel.NodeData>`	`getChildNodesData(org.exoplatform.services.jcr.datamodel.NodeData parent, List<org.exoplatform.services.jcr.impl.core.itemfilters.QPathEntryFilter> pattern)` Reads `List` of `NodeData` from the storage using item's parent location, and name filter.
`boolean`	`getChildNodesDataByPage(org.exoplatform.services.jcr.datamodel.NodeData parent, int fromOrderNum, int offset, int pageSize, List<org.exoplatform.services.jcr.datamodel.NodeData> childs)` Get child Nodes of the parent node.
`List<org.exoplatform.services.jcr.datamodel.PropertyData>`	`getChildPropertiesData(org.exoplatform.services.jcr.datamodel.NodeData parent)` Reads `List` of `PropertyData` from the storage using item's parent location.
`List<org.exoplatform.services.jcr.datamodel.PropertyData>`	`getChildPropertiesData(org.exoplatform.services.jcr.datamodel.NodeData parent, List<org.exoplatform.services.jcr.impl.core.itemfilters.QPathEntryFilter> pattern)` Reads `List` of `PropertyData` from the storage using item's parent location.
`ItemData`	`getItemData(org.exoplatform.services.jcr.datamodel.NodeData parentData, org.exoplatform.services.jcr.datamodel.QPathEntry name, org.exoplatform.services.jcr.datamodel.ItemType itemType)` Reads `ItemData` from the storage using item's parent and name relative the parent location of a given type.
`ItemData`	`getItemData(String identifier)` Reads `ItemData` from the storage by item identifier.
`int`	`getLastOrderNumber(org.exoplatform.services.jcr.datamodel.NodeData parent)` Reads order number of last `parent child nodes.`
`long`	`getNodeDataSize(String nodeIdentifier)` Calculate node data size.
`long`	`getNodesCount()` Reads count of nodes in workspace.
`List<org.exoplatform.services.jcr.datamodel.PropertyData>`	`getReferencesData(String nodeIdentifier)` Reads `List` of `PropertyData` from the storage using item's parent location.
`long`	`getWorkspaceDataSize()` Calculate workspace data size.
`boolean`	`hasItemData(org.exoplatform.services.jcr.datamodel.NodeData parentData, org.exoplatform.services.jcr.datamodel.QPathEntry name, org.exoplatform.services.jcr.datamodel.ItemType itemType)` Checks if `ItemData` exists into the storage using item's parent and name relative the parent location of define type.
`boolean`	`isOpened()` Returns true if connection can be used.
`List<org.exoplatform.services.jcr.datamodel.PropertyData>`	`listChildPropertiesData(org.exoplatform.services.jcr.datamodel.NodeData parent)` Reads `List` of `PropertyData` with empty `ValueData` from the storage using item's parent location.
`void`	`prepare()` Prepare the commit phase.
`void`	`rename(org.exoplatform.services.jcr.datamodel.NodeData data)` Renames `NodeData` using Node identifier and new name and index from the data.
`void`	`rollback()` Refuses persistent changes and closes connection.
`void`	`update(org.exoplatform.services.jcr.datamodel.NodeData data)` Updates `NodeData`.
`void`	`update(org.exoplatform.services.jcr.datamodel.PropertyData data, org.exoplatform.services.jcr.impl.dataflow.persistent.ChangedSizeHandler sizeHandler)` Updates `PropertyData`.

- Method Detail
  - hasItemData
```
boolean hasItemData(org.exoplatform.services.jcr.datamodel.NodeData parentData,
                  org.exoplatform.services.jcr.datamodel.QPathEntry name,
                  org.exoplatform.services.jcr.datamodel.ItemType itemType)
                    throws javax.jcr.RepositoryException,
                           IllegalStateException
```
    Checks if ItemData exists into the storage using item's parent and name relative the parent location of define type.
    
    Parameters:
    parentData - - the item's parent NodeData
    name - - item's path entry (QName + index)
    itemType - item type
    
    Returns:
    - true if ItemData exists and false otherwise
    
    Throws:
    
    javax.jcr.RepositoryException - if some exception occurred
    
    IllegalStateException - if connection is closed
  - getItemData
```
ItemData getItemData(org.exoplatform.services.jcr.datamodel.NodeData parentData,
                   org.exoplatform.services.jcr.datamodel.QPathEntry name,
                   org.exoplatform.services.jcr.datamodel.ItemType itemType)
                     throws javax.jcr.RepositoryException,
                            IllegalStateException
```
    Reads ItemData from the storage using item's parent and name relative the parent location of a given type.
    
    Parameters:
    parentData - - the item's parent NodeData
    name - - item's path entry (QName + index)
    itemType - item type
    
    Returns:
    - stored ItemData which has exact the same path Entry (name+index) inside the parent; or null if not such an item data found
    
    Throws:
    
    javax.jcr.RepositoryException - if some exception occurred
    
    IllegalStateException - if connection is closed
  - getItemData
```
ItemData getItemData(String identifier)
                     throws javax.jcr.RepositoryException,
                            IllegalStateException
```
    Reads ItemData from the storage by item identifier.
    
    Parameters:
    identifier - - Item identifier
    
    Returns:
    stored ItemData or null if no item found with given id. Basically used for Session.getNodeByUUID but not necessarily refers to jcr:uuid property (In fact, this identifier should not necessary be equal of referenceable node's UUID if any) thereby can return NodeData for not referenceable node data or PropertyData.
    
    Throws:
    
    javax.jcr.RepositoryException - if some exception occurred
    
    IllegalStateException - if connection is closed
  - getChildNodesData
```
List<org.exoplatform.services.jcr.datamodel.NodeData> getChildNodesData(org.exoplatform.services.jcr.datamodel.NodeData parent)
                                                                        throws javax.jcr.RepositoryException,
                                                                               IllegalStateException
```
    Reads List of NodeData from the storage using item's parent location.
    
    Parameters:
    parent - NodeData
    
    Returns:
    child nodes data or empty List
    
    Throws:
    
    javax.jcr.RepositoryException - if some exception occurred
    
    IllegalStateException - if connection is closed
  - getChildNodesData
```
List<org.exoplatform.services.jcr.datamodel.NodeData> getChildNodesData(org.exoplatform.services.jcr.datamodel.NodeData parent,
                                                                      List<org.exoplatform.services.jcr.impl.core.itemfilters.QPathEntryFilter> pattern)
                                                                        throws javax.jcr.RepositoryException,
                                                                               IllegalStateException
```
    Reads List of NodeData from the storage using item's parent location, and name filter.
    
    Parameters:
    parent - NodeData
    pattern - - list of QPathEntryFilters
    
    Returns:
    child nodes data or empty List
    
    Throws:
    
    javax.jcr.RepositoryException - if some exception occurred
    
    IllegalStateException - if connection is closed
  - getChildNodesCount
```
int getChildNodesCount(org.exoplatform.services.jcr.datamodel.NodeData parent)
                       throws javax.jcr.RepositoryException
```
    Reads count of parent child nodes.
    Parameters: parent - NodeData Returns: long, childs count Throws: javax.jcr.RepositoryException - if error occurs
  getLastOrderNumber int getLastOrderNumber(org.exoplatform.services.jcr.datamodel.NodeData parent) throws javax.jcr.RepositoryException Reads order number of last parent child nodes. Parameters: parent - NodeData Returns: long, order number of last parent's child node. Throws: javax.jcr.RepositoryException - if error occurs getChildPropertiesData List<org.exoplatform.services.jcr.datamodel.PropertyData> getChildPropertiesData(org.exoplatform.services.jcr.datamodel.NodeData parent) throws javax.jcr.RepositoryException, IllegalStateException Reads List of PropertyData from the storage using item's parent location. Parameters: parent - NodeData Returns: child properties data or empty List Throws: javax.jcr.RepositoryException - if some exception occurred IllegalStateException - if connection is closed getChildPropertiesData List<org.exoplatform.services.jcr.datamodel.PropertyData> getChildPropertiesData(org.exoplatform.services.jcr.datamodel.NodeData parent, List<org.exoplatform.services.jcr.impl.core.itemfilters.QPathEntryFilter> pattern) throws javax.jcr.RepositoryException, IllegalStateException Reads List of PropertyData from the storage using item's parent location. Parameters: parent - NodeData pattern - String[] list of wild card names Returns: child properties data or empty List Throws: javax.jcr.RepositoryException - if some exception occurred IllegalStateException - if connection is closed listChildPropertiesData List<org.exoplatform.services.jcr.datamodel.PropertyData> listChildPropertiesData(org.exoplatform.services.jcr.datamodel.NodeData parent) throws javax.jcr.RepositoryException, IllegalStateException Reads List of PropertyData with empty ValueData from the storage using item's parent location. This method specially dedicated for non-content modification operations (e.g. Items delete). Parameters: parent - NodeData Returns: child properties data (with empty data) or empty List Throws: javax.jcr.RepositoryException - if some exception occurred IllegalStateException - if connection is closed getReferencesData List<org.exoplatform.services.jcr.datamodel.PropertyData> getReferencesData(String nodeIdentifier) throws javax.jcr.RepositoryException, IllegalStateException, UnsupportedOperationException Reads List of PropertyData from the storage using item's parent location. It's REFERENCE type Properties referencing Node with given nodeIdentifier. See more Node.getReferences() Parameters: nodeIdentifier - of referenceable Node Returns: list of referenced property data or empty List Throws: javax.jcr.RepositoryException - if some exception occurred IllegalStateException - if connection is closed UnsupportedOperationException - if operation is not supported getChildNodesDataByPage boolean getChildNodesDataByPage(org.exoplatform.services.jcr.datamodel.NodeData parent, int fromOrderNum, int offset, int pageSize, List<org.exoplatform.services.jcr.datamodel.NodeData> childs) throws javax.jcr.RepositoryException Get child Nodes of the parent node. Parameters: parent - the parent data fromOrderNum - the returned list of child nodes should not contain the node with order number less than fromOrderNum offset - the position of the first element to retrieve. pageSize - the total amount of element expected per page. childs - will contain the resulted child nodes Returns: true if there are data to retrieve for next request and false in other case Throws: javax.jcr.RepositoryException add void add(org.exoplatform.services.jcr.datamodel.NodeData data) throws javax.jcr.RepositoryException, UnsupportedOperationException, javax.jcr.InvalidItemStateException, IllegalStateException Adds single NodeData. Parameters: data - - the new data Throws: javax.jcr.InvalidItemStateException - if the item already exists UnsupportedOperationException - if operation is not supported (it is container for level 1) javax.jcr.RepositoryException - if some exception occurred IllegalStateException - if connection is closed add void add(org.exoplatform.services.jcr.datamodel.PropertyData data, org.exoplatform.services.jcr.impl.dataflow.persistent.ChangedSizeHandler sizeHandler) throws javax.jcr.RepositoryException, UnsupportedOperationException, javax.jcr.InvalidItemStateException, IllegalStateException Adds single PropertyData. Parameters: data - - the new data sizeHandler - accumulate changed size Throws: javax.jcr.InvalidItemStateException - if the item already exists UnsupportedOperationException - if operation is not supported (it is container for level 1) javax.jcr.RepositoryException - if some exception occurred IllegalStateException - if connection is closed update void update(org.exoplatform.services.jcr.datamodel.NodeData data) throws javax.jcr.RepositoryException, UnsupportedOperationException, javax.jcr.InvalidItemStateException, IllegalStateException Updates NodeData. Parameters: data - - the new data Throws: javax.jcr.InvalidItemStateException - (1)if the data is already updated, i.e. persisted version value of persisted data >= of new data's persisted version value (2) if the persisted data is not NodeData (i.e. it is PropertyData). It means that some other process deleted original data and replace it with other type of data. UnsupportedOperationException - if operation is not supported (it is container for level 1) javax.jcr.RepositoryException - if some exception occurred IllegalStateException - if connection is closed update void update(org.exoplatform.services.jcr.datamodel.PropertyData data, org.exoplatform.services.jcr.impl.dataflow.persistent.ChangedSizeHandler sizeHandler) throws javax.jcr.RepositoryException, UnsupportedOperationException, javax.jcr.InvalidItemStateException, IllegalStateException Updates PropertyData. Parameters: data - - the new data sizeHandler - accumulates changed size Throws: javax.jcr.InvalidItemStateException - (1)if the data is already updated, i.e. persisted version value of persisted data >= of new data's persisted version value (2) if the persisted data is not PropertyData (i.e. it is NodeData). It means that some other process deleted original data and replace it with other type of data. UnsupportedOperationException - if operation is not supported (it is container for level 1) javax.jcr.RepositoryException - if some exception occurred IllegalStateException - if connection is closed rename void rename(org.exoplatform.services.jcr.datamodel.NodeData data) throws javax.jcr.RepositoryException, UnsupportedOperationException, javax.jcr.InvalidItemStateException, IllegalStateException Renames NodeData using Node identifier and new name and index from the data. Parameters: data - - NodeData to be renamed Throws: javax.jcr.InvalidItemStateException - (1)if the data is already updated, i.e. persisted version value of persisted data >= of new data's persisted version value (2) if the persisted data is not PropertyData (i.e. it is NodeData). It means that some other process deleted original data and replace it with other type of data. UnsupportedOperationException - if operation is not supported (it is container for level 1) javax.jcr.RepositoryException - if some exception occurred IllegalStateException - if connection is closed delete void delete(org.exoplatform.services.jcr.datamodel.NodeData data) throws javax.jcr.RepositoryException, UnsupportedOperationException, javax.jcr.InvalidItemStateException, IllegalStateException Deletes NodeData. Parameters: data - that identifies data to be deleted Throws: javax.jcr.InvalidItemStateException - if the data is already deleted UnsupportedOperationException - if operation is not supported (it is container for level 1) javax.jcr.RepositoryException - if some exception occurred IllegalStateException - if connection is closed delete void delete(org.exoplatform.services.jcr.datamodel.PropertyData data, org.exoplatform.services.jcr.impl.dataflow.persistent.ChangedSizeHandler sizeHandler) throws javax.jcr.RepositoryException, UnsupportedOperationException, javax.jcr.InvalidItemStateException, IllegalStateException Deletes PropertyData. Parameters: data - that identifies data to be deleted sizeHandler - accumulate changed size Throws: javax.jcr.InvalidItemStateException - if the data is already deleted UnsupportedOperationException - if operation is not supported (it is container for level 1) javax.jcr.RepositoryException - if some exception occurred IllegalStateException - if connection is closed prepare void prepare() throws IllegalStateException, javax.jcr.RepositoryException Prepare the commit phase. Throws: IllegalStateException - if connection is already closed javax.jcr.RepositoryException - if some exception occurred commit void commit() throws IllegalStateException, javax.jcr.RepositoryException Persist changes and closes connection. It can be database transaction commit for instance etc. Throws: IllegalStateException - if connection is already closed javax.jcr.RepositoryException - if some exception occurred rollback void rollback() throws IllegalStateException, javax.jcr.RepositoryException Refuses persistent changes and closes connection. It can be database transaction rollback for instance etc. Throws: IllegalStateException - if connection is already closed javax.jcr.RepositoryException - if some exception occurred close void close() throws IllegalStateException, javax.jcr.RepositoryException Close connection. Throws: IllegalStateException - if connection is already closed javax.jcr.RepositoryException - if some exception occurred isOpened boolean isOpened() Returns true if connection can be used. Returns: boolean, true if connection is open and ready, false - otherwise getACLHolders List<org.exoplatform.services.jcr.impl.dataflow.persistent.ACLHolder> getACLHolders() throws javax.jcr.RepositoryException, IllegalStateException, UnsupportedOperationException Returns all the nodes that hold some ACL info like owner or permissions Returns: a list of all the ACL holders for this workspace Throws: javax.jcr.RepositoryException - if some exception occurred IllegalStateException - if connection is closed UnsupportedOperationException - if operation is not supported getNodesCount long getNodesCount() throws javax.jcr.RepositoryException Reads count of nodes in workspace. Returns: nodes count Throws: javax.jcr.RepositoryException - if a database access error occurs getWorkspaceDataSize long getWorkspaceDataSize() throws javax.jcr.RepositoryException Calculate workspace data size. Throws: javax.jcr.RepositoryException getNodeDataSize long getNodeDataSize(String nodeIdentifier) throws javax.jcr.RepositoryException Calculate node data size. Parameters: nodeIdentifier - node identifier which size need to calculate Throws: javax.jcr.RepositoryException

Interface WorkspaceStorageConnection

Method Summary

Method Detail

hasItemData

getItemData

getItemData

getChildNodesData

getChildNodesData

getChildNodesCount

getLastOrderNumber

getChildPropertiesData

getChildPropertiesData

listChildPropertiesData

getReferencesData

getChildNodesDataByPage

add

add

update

update

rename

delete

delete

prepare

commit

rollback

close

isOpened

getACLHolders

getNodesCount

getWorkspaceDataSize

getNodeDataSize