jetspeeddescriptorsstore.java

jetspeed源代码

/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *    "Apache Jetspeed" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact [e-mail].
 *
 * 5. Products derived from this software may not be called "Apache",
 *    "Apache Jetspeed", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package org.apache.jetspeed.services.cms.repository.slide;

//JDK
import java.lang.reflect.Constructor;
import java.util.Hashtable;
import java.util.Enumeration;
import java.util.Vector;
import java.util.List;
import java.util.Iterator;
import java.util.Date;

// Slide
import org.apache.slide.common.AbstractSimpleService;
import org.apache.slide.common.ServiceConnectionFailedException;
import org.apache.slide.common.ServiceDisconnectionFailedException;
import org.apache.slide.common.NamespaceAccessToken;
import org.apache.slide.common.ServiceInitializationFailedException;
import org.apache.slide.common.ServiceResetFailedException;
import org.apache.slide.common.ServiceAccessException;
import org.apache.slide.common.Uri;
import org.apache.slide.common.ServiceParameterErrorException;
import org.apache.slide.common.ServiceParameterMissingException;

import org.apache.slide.store.LockStore;
import org.apache.slide.store.NodeStore;
import org.apache.slide.store.RevisionDescriptorsStore;
import org.apache.slide.store.RevisionDescriptorStore;
import org.apache.slide.store.SecurityStore;

import org.apache.slide.structure.ObjectNode;
import org.apache.slide.structure.ObjectNotFoundException;
import org.apache.slide.structure.ObjectAlreadyExistsException;

import org.apache.slide.security.NodePermission;

import org.apache.slide.lock.NodeLock;
import org.apache.slide.lock.LockTokenNotFoundException;

import org.apache.slide.content.NodeRevisionDescriptors;
import org.apache.slide.content.NodeRevisionDescriptor;
import org.apache.slide.content.RevisionContentNotFoundException;
import org.apache.slide.content.RevisionDescriptorNotFoundException;
import org.apache.slide.content.NodeRevisionNumber;

import javax.transaction.xa.XAException;
import javax.transaction.xa.Xid;

// Turbine

import org.apache.torque.util.Criteria;
import org.apache.turbine.services.TurbineServices;
import org.apache.turbine.util.Log;


// Jetspeed
import org.apache.jetspeed.services.security.JetspeedSecurityService;
import org.apache.jetspeed.services.security.GroupManagement;
import org.apache.jetspeed.om.security.turbine.TurbineUserGroupRole;
import org.apache.jetspeed.om.security.turbine.TurbineUserGroupRolePeer;
import org.apache.jetspeed.om.security.turbine.TurbineUserPeer;
import org.apache.jetspeed.om.security.turbine.TurbineUser;
import org.apache.jetspeed.om.security.turbine.TurbineGroup;
import org.apache.jetspeed.om.security.turbine.TurbineGroupPeer;
import org.apache.jetspeed.om.security.Group;
import org.apache.jetspeed.om.security.JetspeedUser;


/**
 * Jetspeed security compliant store implementation.
 *
 * This Slide store is using only to retrieve jetspeed user/group info.
 * It is not used to update a jetspeed user/group. You have to use the  Jetspeed application
 * for doing that
 *
 * TODO :
 *  + This class has to be review. Check if it possible to be more "Turbine independent".
 *    Use in this store the new Jetspeed security stuff.
 *  + Check if the interface NodeStore is not sufficient.
 *
 * @author <a href="mailto:[e-mail]">Christophe Lombart</a>
 */
public class JetspeedDescriptorsStore
	extends AbstractSimpleService
	implements
		LockStore,
		NodeStore,
		RevisionDescriptorsStore,
		RevisionDescriptorStore,
		SecurityStore
{

	// Structure descriptors

	protected static final int OBJECTS_URI = 1;
	protected static final int OBJECTS_CLASS = 2;

	protected static final int CHILDREN_URI = 1;
	protected static final int CHILDREN_CHILDURI = 2;

	protected static final int LINKS_LINK = 1;
	protected static final int LINKS_LINKTO = 2;

	// Security descriptors

	protected static final int PERMISSIONS_OBJECT = 1;
	protected static final int PERMISSIONS_REVISION_NUMBER = 2;
	protected static final int PERMISSIONS_SUBJECT = 3;
	protected static final int PERMISSIONS_ACTION = 4;
	protected static final int PERMISSIONS_INHERITABLE = 5;
	protected static final int PERMISSIONS_NEGATIVE = 6;

	// Lock descriptors

	protected static final int LOCKS_ID = 1;
	protected static final int LOCKS_OBJECT = 2;
	protected static final int LOCKS_SUBJECT = 3;
	protected static final int LOCKS_TYPE = 4;
	protected static final int LOCKS_EXPIRATIONDATE = 5;
	protected static final int LOCKS_INHERITABLE = 6;
	protected static final int LOCKS_EXCLUSIVE = 7;

	// Content descriptors

	protected static final int REVISIONS_URI = 1;
	protected static final int REVISIONS_ISVERSIONED = 2;
	protected static final int REVISIONS_INITIALREVISION = 3;

	protected static final int WORKINGREVISION_URI = 1;
	protected static final int WORKINGREVISION_BASEREVISION = 2;
	protected static final int WORKINGREVISION_NUMBER = 3;

	protected static final int LATESTREVISIONS_URI = 1;
	protected static final int LATESTREVISIONS_BRANCHNAME = 2;
	protected static final int LATESTREVISIONS_NUMBER = 3;

	protected static final int BRANCHES_URI = 1;
	protected static final int BRANCHES_NUMBER = 2;
	protected static final int BRANCHES_CHILDNUMBER = 3;

	protected static final int REVISION_URI = 1;
	protected static final int REVISION_NUMBER = 2;
	protected static final int REVISION_BRANCHNAME = 3;

	protected static final int LABEL_URI = 1;
	protected static final int LABEL_NUMBER = 2;
	protected static final int LABEL_LABEL = 3;

	protected static final int PROPERTY_URI = 1;
	protected static final int PROPERTY_NUMBER = 2;
	protected static final int PROPERTY_NAME = 3;
	protected static final int PROPERTY_VALUE = 4;
	protected static final int PROPERTY_NAMESPACE = 5;
	protected static final int PROPERTY_TYPE = 6;
	protected static final int PROPERTY_PROTECTED = 7;


	// ----------------------------------------------- DescriptorsStore Methods

	/**
	 * Retrieve an object.
	 *
	 * @param uri Uri of the object we want to retrieve
	 * @exception ServiceAccessException Error accessing the Service
	 * @exception ObjectNotFoundException The object to retrieve was not found
	 */
	public ObjectNode retrieveObject(Uri uri)
		throws ServiceAccessException, ObjectNotFoundException
	{

		ObjectNode result = null;

		try
		{
			// Check if parent uri name = the turbine group uri root
			if (uri.getParentUri()
				   .toString()
				   .equals(Utility.getGroupParentUri()))
			{
				String groupName = uri.toString().substring(uri.toString().lastIndexOf('/') + 1);
                GroupManagement groupService = (GroupManagement)TurbineServices.getInstance()
                									.getService("GroupManagement");

				Criteria criteria = new Criteria();
				criteria.addJoin(
					TurbineGroupPeer.GROUP_ID,
					TurbineUserGroupRolePeer.GROUP_ID);
				criteria.addJoin(
					TurbineUserGroupRolePeer.USER_ID,
					TurbineUserPeer.USER_ID);
				criteria.add(TurbineGroupPeer.GROUP_NAME, groupName);
				criteria.setDistinct();
				List users = TurbineUserPeer.doSelectUsers(criteria);

				if (Log.getLogger().isDebugEnabled())
				{
					Log.debug("TurbineDescriptorStore -  Group size : " + users.size());
				}
				Vector childrenVector = new Vector();
				Vector linksVector = new Vector();

				// Get  users from the UserGroupRole info
				Iterator iterator = users.iterator();
				while (iterator.hasNext())
				{
					JetspeedUser user = (JetspeedUser)iterator.next();
                    childrenVector.addElement(
						Utility.getUserParentUri() + "/" + user.getUserName());
				}

				Class objclass =
					Class.forName("org.apache.slide.structure.GroupNode");

				Class[] argClasses =
					{
						Class.forName("java.lang.String"),
						Class.forName("java.util.Vector"),
						Class.forName("java.util.Vector")
					};
				Object[] arguments =
					{
						uri.toString(),
						childrenVector,
						linksVector
					};

				Constructor constructor = objclass.getConstructor(argClasses);

				result = (ObjectNode)constructor.newInstance(arguments);

            // Check if parent uri name = the jetspeed user uri root
			}
			else if (uri.getParentUri()
						.toString()
						.equals(Utility.getUserParentUri()))
			{

                // Retrieve Jetspeed users
				String userName =
					uri.toString().substring(
						uri.toString().lastIndexOf('/') + 1);

                JetspeedSecurityService service = (JetspeedSecurityService) TurbineServices.getInstance().
                                         getService(JetspeedSecurityService.SERVICE_NAME);
                JetspeedUser user = service.getUser(userName);

                // Create and populate a Slide ObjectNode for this user
				Vector childrenVector = new Vector();
				Vector linksVector = new Vector();

				Class objclass = Class.forName("slideroles.basic.UserRoleImpl");

				Class[] argClasses =
					{
						Class.forName("java.lang.String"),
						Class.forName("java.util.Vector"),
						Class.forName("java.util.Vector")
					};
				Object[] arguments =
					{
						uri.toString(),
						childrenVector,
						linksVector
					};
				Constructor constructor = objclass.getConstructor(argClasses);
				result = (ObjectNode)constructor.newInstance(arguments);
			}
			else
			{
				//if (uri.toString().equals(Utility.getUserParentUri())) {
				// Slide engine ask first information on uri like '/users/turbine/' or
				// 'users/turbine/users' or '/users/turbine/groups'
				Vector childrenVector = new Vector();
				Vector linksVector = new Vector();

				Class objclass = Class.forName("slideroles.basic.UserRoleImpl");

				Class[] argClasses =
					{
						Class.forName("java.lang.String"),
						Class.forName("java.util.Vector"),
						Class.forName("java.util.Vector")
					};
				Object[] arguments =
					{
						uri.toString(),
						childrenVector,
						linksVector
					};
				Constructor constructor = objclass.getConstructor(argClasses);
				result = (ObjectNode)constructor.newInstance(arguments);
			}
		}
		catch (Exception e)
		{
			//Log.debug("TurbineDescriptorStore Exception - retrieveObject : " +
			//          e.getMessage());
			e.printStackTrace();
			throw new ObjectNotFoundException(uri);
		}

		return result;
	}

/*********************************************************************************
 *
 *   OTHER METHODE ARE NOT USED IN THIS STORE
 *
 */



	// -------------------------------------------------------- Service Methods

	/**
	 * Initializes the data source with a set of parameters.
	 *
	 * @param parameters Hashtable containing the parameters' name
	 * and associated value
	 * @exception ServiceParameterErrorException Incorrect service parameter
	 * @exception ServiceParameterMissingException Service parameter missing
	 */
	/*
	   public void setParameters(Hashtable parameters)
	       throws ServiceParameterErrorException,
	       ServiceParameterMissingException {


	   }

	*/
	/**
	 * Connects to JDBC and creates the basic table structure.
	 *
	 * @exception ServiceConnectionFailedException Connection to the
	 * database failed
	 */
	public synchronized void connect() throws ServiceConnectionFailedException
	{
		if (Log.getLogger().isDebugEnabled())
		{
			Log.debug("TurbineDescriptorStore - connect");
		}
	}

	/**
	 * Disconnects from data source.
	 *
	 * @exception ServiceDisconnectionFailedException Disconnection
	 * from database failed
	 */
	public void disconnect() throws ServiceDisconnectionFailedException
	{
		if (Log.getLogger().isDebugEnabled())
		{
			Log.debug("TurbineDescriptorStore - disconnect");
		}
	}

	/**
	 * Initializes data source.
	 * <p/>
	 * Occurs in four steps :
	 * <li>Driver class is loaded</li>
	 * <li>Driver is intantiated</li>
	 * <li>Driver registration in the driver manager</li>
	 * <li>Creation of the basic tables, if they didn't exist before</li>
	 *
	 * @exception ServiceInitializationFailedException Throws an exception
	 * if the data source has already been initialized before
	 */
	public synchronized void initialize(NamespaceAccessToken token)
		throws ServiceInitializationFailedException
	{
		if (Log.getLogger().isDebugEnabled())
		{
			Log.debug("TurbineDescriptorStore - initialize");
		}
	}

	/**
	 * Deletes data source. Should remove stored data if possible.
	 *
	 * @exception ServiceResetFailedException Reset failed
	 */
	public synchronized void reset() throws ServiceResetFailedException
	{
		if (Log.getLogger().isDebugEnabled())
		{
			Log.debug("TurbineDescriptorStore - reset");
		}
	}

	/**
	 * This function tells whether or not the data source is connected.
	 *
	 * @return boolean true if we are connected
	 * @exception ServiceAccessException Error accessing DataSource
	 */
	public boolean isConnected() throws ServiceAccessException