OwnerFactory.java

/* ===============================================================================
 *
 * Part of the InfoGlue Content Management Platform (www.infoglue.org)
 *
 * ===============================================================================
 *
 *  Copyright (C)
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License version 2, as published by the
 * Free Software Foundation. See the file LICENSE.html for more information.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY, including the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc. / 59 Temple
 * Place, Suite 330 / Boston, MA 02111-1307 / USA.
 *
 * ===============================================================================
 */
package org.infoglue.cms.util.workflow;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;

import org.infoglue.cms.security.InfoGlueGroup;
import org.infoglue.cms.security.InfoGluePrincipal;
import org.infoglue.cms.security.InfoGlueRole;

/**
 * A principal owner indicates that only the associated principal has access to the workflow.
 */
class PrincipalOwner implements Owner
{
	/**
	 * The principal.
	 */
	private final InfoGluePrincipal principal;

	/**
	 * Constructs an owner object for the specified principal.
	 * 
	 * @param principal the principal.
	 */
	PrincipalOwner(final InfoGluePrincipal principal)
	{
		this.principal = principal;
	}
	
	/**
	 * Returns the identifier of the owner.
	 * 
	 * @return the identifier of the owner.
	 */
	public String getIdentifier() 
	{
		return principal.getName();
	}
}

/**
 * A role owner indicates that all principals that are members of the role has access to the workflow. 
 * If a group is specified, then only principals that are members of both the role and the group has access to the workflow.
 * 
 * TODO NOTE NOTE NOTE! Will not work very well if any user/role/group contains '\' characters
 */
class RoleOwner implements Owner
{
	/**
	 * 
	 */
	private static final String PREFIX = "\\";
	
	/**
	 * The role. 
	 */
	private final InfoGlueRole role;
	
	/**
	 * The group; null indicates all groups.
	 */
	private final InfoGlueGroup group;
	
	/**
	 * Constructs a role owner for the specified role.
	 * 
	 * @param role the role.
	 */
	RoleOwner(final InfoGlueRole role)
	{
		this(role, null);
	}
	
	/**
	 * Constructs a role owner for the specified role and group.
	 * 
	 * @param role the role.
	 * @param group the group.
	 */
	RoleOwner(final InfoGlueRole role, final InfoGlueGroup group)
	{
		this.role  = role;
		this.group = group;
	}
	
	/**
	 * Returns the identifier of the owner.
	 * 
	 * @return the identifier of the owner.
	 */
	public String getIdentifier() 
	{
		if(group == null)
		{
			return PREFIX + role.getName();
		}
		else 
		{
			return PREFIX + role.getName() + PREFIX + group.getName();
		}
	}
}

/**
 * Factory for creating workflow owners.
 */
public class OwnerFactory 
{
	/**
	 * Static class; don't allow instantiation.
	 */
	private OwnerFactory()
	{
	}

	/**
	 * Creates a principal owner.
	 * 
	 * @param principal the principal.
	 * @return the owner.
	 */
	public static final Owner create(final InfoGluePrincipal principal)
	{
		return new PrincipalOwner(principal);
	}

	/**
	 * Creates a role owner for all groups.
	 * 
	 * @param role the role.
	 * @return the owner.
	 */
	public static final Owner create(final InfoGlueRole role)
	{
		return new RoleOwner(role);
	}

	/**
	 * Creates a role owner for the specified group.
	 * 
	 * @param role the role.
	 * @param group the group.
	 * @return the owner.
	 */
	public static final Owner create(final InfoGlueRole role, final InfoGlueGroup group)
	{
		return new RoleOwner(role, group);
	}

	/**
	 * Creates all possible owner objects for the specified principal.
	 * 
	 * @param principal the principal.
	 * @return all owners.
	 */
	public static final Collection createAll(final InfoGluePrincipal principal)
	{
		final List owners = new ArrayList();
		owners.add(OwnerFactory.create(principal));
		//We disable this feature... was not a good way to work in OS_WORKFLOW.
		/*
		for(final Iterator roleIterator = principal.getRoles().iterator(); roleIterator.hasNext(); )
		{
			final InfoGlueRole role = (InfoGlueRole) roleIterator.next();
			owners.add(create(role));
			for(final Iterator groupIterator = principal.getGroups().iterator(); groupIterator.hasNext(); )
			{
				final InfoGlueGroup group = (InfoGlueGroup) groupIterator.next();
				owners.add(create(role, group));
			}
		}
		*/
		return owners;
	}
	
}