/*
* Copyright (C) 2009 eXo Platform SAS.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.exoplatform.services.jcr.core;
import org.exoplatform.services.jcr.access.AccessControlList;
import org.exoplatform.services.jcr.datamodel.InternalQName;
import java.security.AccessControlException;
import java.util.Map;
import javax.jcr.AccessDeniedException;
import javax.jcr.InvalidItemStateException;
import javax.jcr.Node;
import javax.jcr.NodeIterator;
import javax.jcr.RepositoryException;
import javax.jcr.UnsupportedRepositoryOperationException;
import javax.jcr.lock.Lock;
import javax.jcr.lock.LockException;
/**
* Created by The eXo Platform SAS<br>
*
* This interface provides advanced methods that are not part of the Node Interface
* defined in the specification JSR-170.
*
* @author Gennady Azarenkov
* @version $Id: ExtendedNode.java 11907 2008-03-13 15:36:21Z ksm $
* @LevelAPI Experimental
*/
public interface ExtendedNode extends Node
{
/**
* Sets permission.
*
* @param permissions
* @throws RepositoryException
* @throws AccessControlException
*/
void setPermissions(Map<String, String[]> permissions) throws RepositoryException, AccessControlException;
/**
* @return Access Control List
*/
AccessControlList getACL() throws RepositoryException;
/**
* Get unique node identifier.
*
* @return node identifier
* @throws RepositoryException if any repository errors occurs
*/
String getIdentifier() throws RepositoryException;
/**
* Clears Access Control List.
*
* @throws RepositoryException
* @throws AccessControlException
*/
void clearACL() throws RepositoryException, AccessControlException;
/**
* Removes permissions for particular identity.
*
* @param identity
* @throws RepositoryException
* @throws AccessControlException
*/
void removePermission(String identity) throws RepositoryException, AccessControlException;
/**
* Removes specified permission for particular identity.
*
* @param identity
* @throws RepositoryException
* @throws AccessControlException
*/
void removePermission(String identity, String permission) throws RepositoryException, AccessControlException;
/**
* Sets permissions for particular identity.
*
* @param identity
* @param permission
* @throws RepositoryException
* @throws AccessControlException
*/
void setPermission(String identity, String[] permission) throws RepositoryException, AccessControlException;
/**
* Checks if there are permission to perform some actions.
*
* @param actions
* @throws AccessControlException
* if no such permissions found
* @throws RepositoryException
*/
void checkPermission(String actions) throws AccessControlException, RepositoryException;
boolean isNodeType(InternalQName qName) throws RepositoryException;
/**
* Places a lock on this node.
*
*/
Lock lock(boolean isDeep, long timeOut) throws UnsupportedRepositoryOperationException, LockException,
AccessDeniedException, InvalidItemStateException, RepositoryException;
/**
* Returns the number of children nodes.
*
* @throws RepositoryException If an error occurs.
*/
public long getNodesCount() throws RepositoryException;
/**
* Returns a <code>NodeIterator</code> over all child <code>Node</code>s of
* this <code>Node</code>. Does <i>not</i> include properties of this
* <code>Node</code>. If this node has no child nodes, then an empty iterator is returned.
*
* @return A <code>NodeIterator</code> over all child <code>Node</code>s of
* this <code>Node</code>.
* @throws RepositoryException If an error occurs.
*/
public NodeIterator getNodesLazily() throws RepositoryException;
/**
* Returns a <code>NodeIterator</code> over all child <code>Node</code>s of
* this <code>Node</code>. Does <i>not</i> include properties of this
* <code>Node</code>. If this node has no child nodes, then an empty iterator is returned.
*
* @param pageSize
* the amount of the nodes which can be retrieved from the storage per request
* @return A <code>NodeIterator</code> over all child <code>Node</code>s of
* this <code>Node</code>.
* @throws RepositoryException If an error occurs.
*/
public NodeIterator getNodesLazily(int pageSize) throws RepositoryException;
}