/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package org.alfresco.repo.version;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.alfresco.model.ContentModel;
import org.alfresco.service.cmr.dictionary.DictionaryService;
import org.alfresco.service.cmr.dictionary.InvalidAspectException;
import org.alfresco.service.cmr.repository.AssociationExistsException;
import org.alfresco.service.cmr.repository.AssociationRef;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.InvalidChildAssociationRefException;
import org.alfresco.service.cmr.repository.InvalidNodeRefException;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.repository.Path;
import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.cmr.repository.NodeRef.Status;
import org.alfresco.service.cmr.search.SearchService;
import org.alfresco.service.namespace.QName;
import org.alfresco.service.namespace.QNamePattern;
import org.alfresco.service.namespace.RegexQNamePattern;
/**
* The light weight version store node service implementation.
*
* @author Roy Wetherall
*/
public class NodeServiceImpl implements NodeService, VersionModel
{
/**
* Error messages
*/
private final static String MSG_UNSUPPORTED =
"This operation is not supported by a version store implementation of the node service.";
/**
* The name of the spoofed root association
*/
private static final QName rootAssocName = QName.createQName(VersionModel.NAMESPACE_URI, "versionedState");
/**
* The db node service, used as the version store implementation
*/
protected NodeService dbNodeService;
/**
* The repository searcher
*/
@SuppressWarnings("unused")
private SearchService searcher;
/**
* The dictionary service
*/
protected DictionaryService dicitionaryService;
/**
* Sets the db node service, used as the version store implementation
*
* @param nodeService the node service
*/
public void setDbNodeService(NodeService nodeService)
{
this.dbNodeService = nodeService;
}
/**
* Sets the searcher
*
* @param searcher the searcher
*/
public void setSearcher(SearchService searcher)
{
this.searcher = searcher;
}
/**
* Sets the dictionary service
*
* @param dictionaryService the dictionary service
*/
public void setDictionaryService(DictionaryService dictionaryService)
{
this.dicitionaryService = dictionaryService;
}
/**
* Delegates to the <code>NodeService</code> used as the version store implementation
*/
public List<StoreRef> getStores()
{
return dbNodeService.getStores();
}
/**
* Delegates to the <code>NodeService</code> used as the version store implementation
*/
public StoreRef createStore(String protocol, String identifier)
{
return dbNodeService.createStore(protocol, identifier);
}
/**
* Delegates to the <code>NodeService</code> used as the version store implementation
*/
public boolean exists(StoreRef storeRef)
{
return dbNodeService.exists(storeRef);
}
/**
* Delegates to the <code>NodeService</code> used as the version store implementation
*/
public boolean exists(NodeRef nodeRef)
{
return dbNodeService.exists(convertNodeRef(nodeRef));
}
/**
* Delegates to the <code>NodeService</code> used as the version store implementation
*/
public Status getNodeStatus(NodeRef nodeRef)
{
return dbNodeService.getNodeStatus(nodeRef);
}
/**
* Convert the incomming node ref (with the version store protocol specified)
* to the internal representation with the workspace protocol.
*
* @param nodeRef the incomming verison protocol node reference
* @return the internal version node reference
*/
private NodeRef convertNodeRef(NodeRef nodeRef)
{
return new NodeRef(new StoreRef(StoreRef.PROTOCOL_WORKSPACE, STORE_ID), nodeRef.getId());
}
/**
* Delegates to the <code>NodeService</code> used as the version store implementation
*/
public NodeRef getRootNode(StoreRef storeRef)
{
return dbNodeService.getRootNode(storeRef);
}
/**
* @throws UnsupportedOperationException always
*/
public ChildAssociationRef createNode(
NodeRef parentRef,
QName assocTypeQName,
QName assocQName,
QName nodeTypeQName) throws InvalidNodeRefException
{
// This operation is not supported for a verion store
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
/**
* @throws UnsupportedOperationException always
*/
public ChildAssociationRef createNode(
NodeRef parentRef,
QName assocTypeQName,
QName assocQName,
QName nodeTypeQName,
Map<QName, Serializable> properties) throws InvalidNodeRefException
{
// This operation is not supported for a verion store
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
/**
* @throws UnsupportedOperationException always
*/
public void deleteNode(NodeRef nodeRef) throws InvalidNodeRefException
{
// This operation is not supported for a verion store
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
/**
* @throws UnsupportedOperationException always
*/
public ChildAssociationRef addChild(NodeRef parentRef,
NodeRef childRef,
QName assocTypeQName,
QName qname) throws InvalidNodeRefException
{
// This operation is not supported for a verion store
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
/**
* @throws UnsupportedOperationException always
*/
public void removeChild(NodeRef parentRef, NodeRef childRef) throws InvalidNodeRefException
{
// This operation is not supported for a verion store
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
/**
* @throws UnsupportedOperationException always
*/
public ChildAssociationRef moveNode(NodeRef nodeToMoveRef, NodeRef newParentRef, QName assocTypeQName, QName assocQName) throws InvalidNodeRefException
{
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
/**
* @throws UnsupportedOperationException always
*/
public void setChildAssociationIndex(ChildAssociationRef childAssocRef, int index) throws InvalidChildAssociationRefException
{
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
/**
* Type translation for version store
*/
public QName getType(NodeRef nodeRef) throws InvalidNodeRefException
{
return (QName)this.dbNodeService.getProperty(convertNodeRef(nodeRef), PROP_QNAME_FROZEN_NODE_TYPE);
}
/**
* @see org.alfresco.service.cmr.repository.NodeService#setType(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName)
*/
public void setType(NodeRef nodeRef, QName typeQName) throws InvalidNodeRefException
{
// This operation is not supported for a version store
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
/**
* @throws UnsupportedOperationException always
*/
public void addAspect(NodeRef nodeRef, QName aspectRef, Map<QName, Serializable> aspectProperties) throws InvalidNodeRefException, InvalidAspectException
{
// This operation is not supported for a verion store
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
/**
* Translation for version store
*/
public boolean hasAspect(NodeRef nodeRef, QName aspectRef) throws InvalidNodeRefException, InvalidAspectException
{
return getAspects(nodeRef).contains(aspectRef);
}
/**
* @throws UnsupportedOperationException always
*/
public void removeAspect(NodeRef nodeRef, QName aspectRef) throws InvalidNodeRefException, InvalidAspectException
{
// This operation is not supported for a verion store
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
/**
* Translation for version store
*/
public Set<QName> getAspects(NodeRef nodeRef) throws InvalidNodeRefException
{
return new HashSet<QName>(
(ArrayList<QName>)this.dbNodeService.getProperty(convertNodeRef(nodeRef), PROP_QNAME_FROZEN_ASPECTS));
}
/**
* Property translation for version store
*/
public Map<QName, Serializable> getProperties(NodeRef nodeRef) throws InvalidNodeRefException
{
Map<QName, Serializable> result = new HashMap<QName, Serializable>();
// TODO should be doing this using a path query ..
Collection<ChildAssociationRef> children = this.dbNodeService.getChildAssocs(convertNodeRef(nodeRef));
for (ChildAssociationRef child : children)
{
if (child.getQName().equals(CHILD_QNAME_VERSIONED_ATTRIBUTES))
{
NodeRef versionedAttribute = child.getChildRef();
// Get the QName and the value
Serializable value = null;
QName qName = (QName)this.dbNodeService.getProperty(versionedAttribute, PROP_QNAME_QNAME);
Boolean isMultiValue = (Boolean)this.dbNodeService.getProperty(versionedAttribute, PROP_QNAME_IS_MULTI_VALUE);
if (isMultiValue.booleanValue() == false)
{
value = this.dbNodeService.getProperty(versionedAttribute, PROP_QNAME_VALUE);
}
else
{
value = this.dbNodeService.getProperty(versionedAttribute, PROP_QNAME_MULTI_VALUE);
}
result.put(qName, value);
}
}
return result;
}
/**
* Property translation for version store
*/
public Serializable getProperty(NodeRef nodeRef, QName qname) throws InvalidNodeRefException
{
// TODO should be doing this with a search ...
Map<QName, Serializable> properties = getProperties(convertNodeRef(nodeRef));
return properties.get(qname);
}
/**
* @throws UnsupportedOperationException always
*/
public void setProperties(NodeRef nodeRef, Map<QName, Serializable> properties) throws InvalidNodeRefException
{
// This operation is not supported for a verion store
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
/**
* @throws UnsupportedOperationException always
*/
public void setProperty(NodeRef nodeRef, QName qame, Serializable value) throws InvalidNodeRefException
{
// This operation is not supported for a verion store
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
/**
* The node will appear to be attached to the root of the version store
*
* @see NodeService#getParentAssocs(NodeRef)
*/
public List<ChildAssociationRef> getParentAssocs(NodeRef nodeRef)
{
return getParentAssocs(nodeRef, RegexQNamePattern.MATCH_ALL, RegexQNamePattern.MATCH_ALL);
}
/**
* The node will apprear to be attached to the root of the version store
*
* @see NodeService#getParentAssocs(NodeRef, QNamePattern, QNamePattern)
*/
public List<ChildAssociationRef> getParentAssocs(NodeRef nodeRef, QNamePattern typeQNamePattern, QNamePattern qnamePattern)
{
List<ChildAssociationRef> result = new ArrayList<ChildAssociationRef>();
if (qnamePattern.isMatch(rootAssocName) == true)
{
result.add(new ChildAssociationRef(
ContentModel.ASSOC_CHILDREN,
dbNodeService.getRootNode(new StoreRef(StoreRef.PROTOCOL_WORKSPACE, STORE_ID)),
rootAssocName,
nodeRef));
}
return result;
}
/**
* @see RegexQNamePattern#MATCH_ALL
* @see #getChildAssocs(NodeRef, QNamePattern, QNamePattern)
*/
public List<ChildAssociationRef> getChildAssocs(NodeRef nodeRef) throws InvalidNodeRefException
{
return getChildAssocs(convertNodeRef(nodeRef), RegexQNamePattern.MATCH_ALL, RegexQNamePattern.MATCH_ALL);
}
/**
* Performs conversion from version store properties to <i>real</i> associations
*/
public List<ChildAssociationRef> getChildAssocs(NodeRef nodeRef, QNamePattern typeQNamePattern, QNamePattern qnamePattern) throws InvalidNodeRefException
{
// Get the child assocs from the version store
List<ChildAssociationRef> childAssocRefs = this.dbNodeService.getChildAssocs(
convertNodeRef(nodeRef),
RegexQNamePattern.MATCH_ALL, CHILD_QNAME_VERSIONED_CHILD_ASSOCS);
List<ChildAssociationRef> result = new ArrayList<ChildAssociationRef>(childAssocRefs.size());
for (ChildAssociationRef childAssocRef : childAssocRefs)
{
// Get the child reference
NodeRef childRef = childAssocRef.getChildRef();
NodeRef referencedNode = (NodeRef)this.dbNodeService.getProperty(childRef, ContentModel.PROP_REFERENCE);
// get the qualified name of the frozen child association and filter out unwanted names
QName qName = (QName)this.dbNodeService.getProperty(childRef, PROP_QNAME_ASSOC_QNAME);
if (qnamePattern.isMatch(qName) == true)
{
// Retrieve the isPrimary and nthSibling values of the forzen child association
QName assocType = (QName)this.dbNodeService.getProperty(childRef, PROP_QNAME_ASSOC_TYPE_QNAME);
boolean isPrimary = ((Boolean)this.dbNodeService.getProperty(childRef, PROP_QNAME_IS_PRIMARY)).booleanValue();
int nthSibling = ((Integer)this.dbNodeService.getProperty(childRef, PROP_QNAME_NTH_SIBLING)).intValue();
// Build a child assoc ref to add to the returned list
ChildAssociationRef newChildAssocRef = new ChildAssociationRef(
assocType,
nodeRef,
qName,
referencedNode,
isPrimary,
nthSibling);
result.add(newChildAssocRef);
}
}
// sort the results so that the order appears to be exactly as it was originally
Collections.sort(result);
return result;
}
/**
* @throws UnsupportedOperationException always
*/
public NodeRef getChildByName(NodeRef nodeRef, QName assocTypeQName, String childName)
{
// This operation is not supported for a verion store
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
/**
* Simulates the node begin attached ot the root node of the version store.
*/
public ChildAssociationRef getPrimaryParent(NodeRef nodeRef) throws InvalidNodeRefException
{
return new ChildAssociationRef(
ContentModel.ASSOC_CHILDREN,
dbNodeService.getRootNode(new StoreRef(StoreRef.PROTOCOL_WORKSPACE, STORE_ID)),
rootAssocName,
nodeRef);
}
/**
* @throws UnsupportedOperationException always
*/
public AssociationRef createAssociation(NodeRef sourceRef, NodeRef targetRef, QName assocTypeQName)
throws InvalidNodeRefException, AssociationExistsException
{
// This operation is not supported for a verion store
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
/**
* @throws UnsupportedOperationException always
*/
public void removeAssociation(NodeRef sourceRef, NodeRef targetRef, QName assocTypeQName)
{
// This operation is not supported for a verion store
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
/**
* @throws UnsupportedOperationException always
*/
public List<AssociationRef> getTargetAssocs(NodeRef sourceRef, QNamePattern qnamePattern)
{
// Get the child assocs from the version store
List<ChildAssociationRef> childAssocRefs = this.dbNodeService.getChildAssocs(
convertNodeRef(sourceRef),
RegexQNamePattern.MATCH_ALL, CHILD_QNAME_VERSIONED_ASSOCS);
List<AssociationRef> result = new ArrayList<AssociationRef>(childAssocRefs.size());
for (ChildAssociationRef childAssocRef : childAssocRefs)
{
// Get the assoc reference
NodeRef childRef = childAssocRef.getChildRef();
NodeRef referencedNode = (NodeRef)this.dbNodeService.getProperty(childRef, ContentModel.PROP_REFERENCE);
// get the qualified type name of the frozen child association and filter out unwanted names
QName qName = (QName)this.dbNodeService.getProperty(childRef, PROP_QNAME_ASSOC_TYPE_QNAME);
if (qnamePattern.isMatch(qName) == true)
{
AssociationRef newAssocRef = new AssociationRef(sourceRef, qName, referencedNode);
result.add(newAssocRef);
}
}
return result;
}
/**
* @throws UnsupportedOperationException always
*/
public List<AssociationRef> getSourceAssocs(NodeRef sourceRef, QNamePattern qnamePattern)
{
// This operation is not supported for a verion store
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
/**
* @throws UnsupportedOperationException always
*/
public Path getPath(NodeRef nodeRef) throws InvalidNodeRefException
{
ChildAssociationRef childAssocRef = getPrimaryParent(nodeRef);
Path path = new Path();
path.append(new Path.ChildAssocElement(childAssocRef));
return path;
}
/**
* @throws UnsupportedOperationException always
*/
public List<Path> getPaths(NodeRef nodeRef, boolean primaryOnly) throws InvalidNodeRefException
{
List<Path> paths = new ArrayList<Path>(1);
paths.add(getPath(nodeRef));
return paths;
}
/**
* @throws UnsupportedOperationException always
*/
public NodeRef getStoreArchiveNode(StoreRef storeRef)
{
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
/**
* @throws UnsupportedOperationException always
*/
public NodeRef restoreNode(NodeRef archivedNodeRef, NodeRef targetParentNodeRef, QName assocTypeQName, QName assocQName)
{
throw new UnsupportedOperationException(MSG_UNSUPPORTED);
}
}