FunctionManagerComponent.java

/**********************************************************************************
 * $URL: https://source.sakaiproject.org/svn/kernel/trunk/kernel-impl/src/main/java/org/sakaiproject/authz/impl/FunctionManagerComponent.java $
 * $Id: FunctionManagerComponent.java 105077 2012-02-24 22:54:29Z ottenhoff@longsight.com $
 ***********************************************************************************
 *
 * Copyright (c) 2005, 2006, 2008 Sakai Foundation
 *
 * Licensed under the Educational Community License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.opensource.org/licenses/ECL-2.0
 *
 * 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.sakaiproject.authz.impl;

import java.util.List;
import java.util.Vector;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.sakaiproject.authz.api.FunctionManager;

/**
 * <p>
 * FunctionManagerComponent implements the FunctionMananger API.
 * </p>
 * 
 * @author Sakai Software Development Team
 */
public class FunctionManagerComponent implements FunctionManager
{
	/** Our log (commons). */
	private static Log M_log = LogFactory.getLog(FunctionManagerComponent.class);

	/** List of security functions. */
	protected List<String> m_registeredFunctions = new Vector<String>();

	/** List of user-mutable security functions. */
	protected List<String> m_registeredUserMutableFunctions = new Vector<String>();


	/**********************************************************************************************************************************************************************************************************************************************************
	 * Dependencies and their setter methods
	 *********************************************************************************************************************************************************************************************************************************************************/

	/**********************************************************************************************************************************************************************************************************************************************************
	 * Init and Destroy
	 *********************************************************************************************************************************************************************************************************************************************************/

	/**
	 * Final initialization, once all dependencies are set.
	 */
	public void init()
	{
		M_log.info("init()");
	}

	/**
	 * Final cleanup.
	 */
	public void destroy()
	{
		M_log.info("destroy()");
	}

	/**********************************************************************************************************************************************************************************************************************************************************
	 * Work interface methods: FunctionMananger
	 *********************************************************************************************************************************************************************************************************************************************************/

	/**
	 * {@inheritDoc}
	 */
	public void registerFunction(String function)
	{
		registerFunction(function, false);
	}

	/**
	 * {@inheritDoc}
	 */
	public void registerFunction(String function, boolean userMutable) {
		if (function == null) return;

		m_registeredFunctions.add(function);
		
		if (userMutable) {
			m_registeredUserMutableFunctions.add(function);
		}
	}

	/**
	 * {@inheritDoc}
	 */
	public List<String> getRegisteredFunctions()
	{
		return new Vector<String>(m_registeredFunctions);
	}

	/**
	 * {@inheritDoc}
	 */
	public List<String> getRegisteredFunctions(String prefix)
	{
		List<String> rv = new Vector<String>();

		for (String function : m_registeredFunctions)
		{
			if (function.startsWith(prefix))
			{
				rv.add(function);
			}
		}

		return rv;
	}

	/**
	 * {@inheritDoc}
	 */
	public List<String> getRegisteredUserMutableFunctions() {
		return new Vector<String>(m_registeredUserMutableFunctions);
	}

	/**
	 * {@inheritDoc}
	 */
	public List<String> getRegisteredUserMutableFunctions(String prefix) {
		
		List<String> rv = new Vector<String>();

		for (String function : m_registeredUserMutableFunctions)
		{
			if (function.startsWith(prefix))
			{
				rv.add(function);
			}
		}

		return rv;
	}
}