Story 1840. Added support for all commands. Refactored code to promote code... (3daa1cbe) · Commits · OATS-CADC / ac

projects/cadcAccessControl-Admin/build.xml

+4 −9

Original line number	Diff line number	Diff line
		@@ -88,13 +88,10 @@
		<property name="cadcAccessControl-Server" value="${lib}/cadcAccessControl-Server.jar" />
		<property name="cadcUtil" value="${lib}/cadcUtil.jar" />
		<property name="log4j" value="${ext.lib}/log4j.jar" />
		<property name="commons-logging" value="${ext.lib}/commons-logging.jar" />
		<property name="jconn3" value="${ext.lib}/jconn3.jar" />
		<property name="spring" value="${ext.lib}/spring.jar" />
		<property name="unboundid" value="${ext.lib}/unboundid-ldapsdk-se.jar" />

		<property name="cadc" value="${cadcAccessControl}:${cadcAccessControl-Server}:${cadcUtil}:${javaUtil}" />
		<property name="external" value="${unboundid}:${spring}:${commons-logging}:${jconn3}:${log4j}" />
		<property name="cadc" value="${cadcAccessControl}:${cadcAccessControl-Server}:${cadcUtil}" />
		<property name="external" value="${unboundid}:${log4j}" />

		<property name="jars" value="${cadc}:${external}" />

		@@ -102,10 +99,8 @@

		<!-- JAR files needed to run the test suite -->
		<property name="junit" value="${ext.dev}/junit.jar" />
		<property name="easymock" value="${ext.dev}/easymock.jar" />
		<property name="em_extras" value="${ext.dev}/objenesis.jar:${ext.dev}/cglib.jar:${ext.dev}/asm.jar" />

		<property name="testingJars" value="${junit}:${easymock}:${em_extras}" />
		<property name="testingJars" value="${junit}" />


		</project>

projects/cadcAccessControl-Admin/src/ca/nrc/cadc/ac/admin/AbstractCommand.java

+96 −2

Original line number	Diff line number	Diff line
		/*
		************************************************************************
		***************** CANADIAN ASTRONOMY DATA CENTRE *****************
		************ CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES ************
		*
		* (c) 2014. (c) 2014.
		* Government of Canada Gouvernement du Canada
		* National Research Council Conseil national de recherches
		* Ottawa, Canada, K1A 0R6 Ottawa, Canada, K1A 0R6
		* All rights reserved Tous droits réservés
		*
		* NRC disclaims any warranties, Le CNRC dénie toute garantie
		* expressed, implied, or énoncée, implicite ou légale,
		* statutory, of any kind with de quelque nature que ce
		* respect to the software, soit, concernant le logiciel,
		* including without limitation y compris sans restriction
		* any warranty of merchantability toute garantie de valeur
		* or fitness for a particular marchande ou de pertinence
		* purpose. NRC shall not be pour un usage particulier.
		* liable in any event for any Le CNRC ne pourra en aucun cas
		* damages, whether direct or être tenu responsable de tout
		* indirect, special or general, dommage, direct ou indirect,
		* consequential or incidental, particulier ou général,
		* arising from the use of the accessoire ou fortuit, résultant
		* software. Neither the name de l'utilisation du logiciel. Ni
		* of the National Research le nom du Conseil National de
		* Council of Canada nor the Recherches du Canada ni les noms
		* names of its contributors may de ses participants ne peuvent
		* be used to endorse or promote être utilisés pour approuver ou
		* products derived from this promouvoir les produits dérivés
		* software without specific prior de ce logiciel sans autorisation
		* written permission. préalable et particulière
		* par écrit.
		*
		* This file is part of the Ce fichier fait partie du projet
		* OpenCADC project. OpenCADC.
		*
		* OpenCADC is free software: OpenCADC est un logiciel libre ;
		* you can redistribute it and/or vous pouvez le redistribuer ou le
		* modify it under the terms of modifier suivant les termes de
		* the GNU Affero General Public la “GNU Affero General Public
		* License as published by the License” telle que publiée
		* Free Software Foundation, par la Free Software Foundation
		* either version 3 of the : soit la version 3 de cette
		* License, or (at your option) licence, soit (à votre gré)
		* any later version. toute version ultérieure.
		*
		* OpenCADC is distributed in the OpenCADC est distribué
		* hope that it will be useful, dans l’espoir qu’il vous
		* but WITHOUT ANY WARRANTY; sera utile, mais SANS AUCUNE
		* without even the implied GARANTIE : sans même la garantie
		* warranty of MERCHANTABILITY implicite de COMMERCIALISABILITÉ
		* or FITNESS FOR A PARTICULAR ni d’ADÉQUATION À UN OBJECTIF
		* PURPOSE. See the GNU Affero PARTICULIER. Consultez la Licence
		* General Public License for Générale Publique GNU Affero
		* more details. pour plus de détails.
		*
		* You should have received Vous devriez avoir reçu une
		* a copy of the GNU Affero copie de la Licence Générale
		* General Public License along Publique GNU Affero avec
		* with OpenCADC. If not, see OpenCADC ; si ce n’est
		* <http://www.gnu.org/licenses/>. pas le cas, consultez :
		* <http://www.gnu.org/licenses/>.
		*
		* $Revision: 4 $
		*
		************************************************************************
		*/

		package ca.nrc.cadc.ac.admin;

		import java.io.PrintStream;
		import java.security.AccessControlException;
		import java.security.Principal;
		import java.security.PrivilegedAction;

		@@ -8,9 +78,10 @@ import org.apache.log4j.Logger;

		import ca.nrc.cadc.ac.server.PluginFactory;
		import ca.nrc.cadc.ac.server.UserPersistence;
		import ca.nrc.cadc.net.TransientException;

		/**
		* Govern the methods that each access control admin command has to support.
		* Provide attributes and methods that apply to all commands.
		* @author yeunga
		*
		*/
		@@ -21,6 +92,8 @@ public abstract class AbstractCommand implements PrivilegedAction<Object>
		protected PrintStream systemOut = System.out;
		protected PrintStream systemErr = System.err;

		protected abstract void doRun() throws AccessControlException, TransientException;

		/**
		* Set the system out.
		* @param printStream
		@@ -39,7 +112,28 @@ public abstract class AbstractCommand implements PrivilegedAction<Object>
		this.systemErr = printStream;
		}

		@SuppressWarnings("unchecked")
		@Override
		public Object run()
		{
		try
		{
		this.doRun();
		}
		catch (AccessControlException e)
		{
		this.systemErr.println("ERROR: " + e.getMessage());
		e.printStackTrace(systemErr);
		}
		catch (TransientException e)
		{
		String message = "Internal Transient Error: " + e.getMessage();
		this.systemErr.println("ERROR: " + message);
		e.printStackTrace(systemErr);
		}

		return null;
		}

		protected <T extends Principal> UserPersistence<T> getUserPersistence()
		{
		PluginFactory pluginFactory = new PluginFactory();

projects/cadcAccessControl-Admin/src/ca/nrc/cadc/ac/admin/AbstractListUsers.java

+81 −25

Original line number	Diff line number	Diff line
		/*
		************************************************************************
		***************** CANADIAN ASTRONOMY DATA CENTRE *****************
		************ CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES ************
		*
		* (c) 2014. (c) 2014.
		* Government of Canada Gouvernement du Canada
		* National Research Council Conseil national de recherches
		* Ottawa, Canada, K1A 0R6 Ottawa, Canada, K1A 0R6
		* All rights reserved Tous droits réservés
		*
		* NRC disclaims any warranties, Le CNRC dénie toute garantie
		* expressed, implied, or énoncée, implicite ou légale,
		* statutory, of any kind with de quelque nature que ce
		* respect to the software, soit, concernant le logiciel,
		* including without limitation y compris sans restriction
		* any warranty of merchantability toute garantie de valeur
		* or fitness for a particular marchande ou de pertinence
		* purpose. NRC shall not be pour un usage particulier.
		* liable in any event for any Le CNRC ne pourra en aucun cas
		* damages, whether direct or être tenu responsable de tout
		* indirect, special or general, dommage, direct ou indirect,
		* consequential or incidental, particulier ou général,
		* arising from the use of the accessoire ou fortuit, résultant
		* software. Neither the name de l'utilisation du logiciel. Ni
		* of the National Research le nom du Conseil National de
		* Council of Canada nor the Recherches du Canada ni les noms
		* names of its contributors may de ses participants ne peuvent
		* be used to endorse or promote être utilisés pour approuver ou
		* products derived from this promouvoir les produits dérivés
		* software without specific prior de ce logiciel sans autorisation
		* written permission. préalable et particulière
		* par écrit.
		*
		* This file is part of the Ce fichier fait partie du projet
		* OpenCADC project. OpenCADC.
		*
		* OpenCADC is free software: OpenCADC est un logiciel libre ;
		* you can redistribute it and/or vous pouvez le redistribuer ou le
		* modify it under the terms of modifier suivant les termes de
		* the GNU Affero General Public la “GNU Affero General Public
		* License as published by the License” telle que publiée
		* Free Software Foundation, par la Free Software Foundation
		* either version 3 of the : soit la version 3 de cette
		* License, or (at your option) licence, soit (à votre gré)
		* any later version. toute version ultérieure.
		*
		* OpenCADC is distributed in the OpenCADC est distribué
		* hope that it will be useful, dans l’espoir qu’il vous
		* but WITHOUT ANY WARRANTY; sera utile, mais SANS AUCUNE
		* without even the implied GARANTIE : sans même la garantie
		* warranty of MERCHANTABILITY implicite de COMMERCIALISABILITÉ
		* or FITNESS FOR A PARTICULAR ni d’ADÉQUATION À UN OBJECTIF
		* PURPOSE. See the GNU Affero PARTICULIER. Consultez la Licence
		* General Public License for Générale Publique GNU Affero
		* more details. pour plus de détails.
		*
		* You should have received Vous devriez avoir reçu une
		* a copy of the GNU Affero copie de la Licence Générale
		* General Public License along Publique GNU Affero avec
		* with OpenCADC. If not, see OpenCADC ; si ce n’est
		* <http://www.gnu.org/licenses/>. pas le cas, consultez :
		* <http://www.gnu.org/licenses/>.
		*
		* $Revision: 4 $
		*
		************************************************************************
		*/

		package ca.nrc.cadc.ac.admin;

		import java.security.AccessControlException;
		@@ -11,7 +80,6 @@ import ca.nrc.cadc.net.TransientException;

		/**
		* This class provides a list of all active or pending users in the LDAP server.
		* The users' nsaccountlocked attribute is not set.
		* @author yeunga
		*
		*/
		@@ -19,12 +87,10 @@ public abstract class AbstractListUsers extends AbstractCommand
		{
		private static final Logger log = Logger.getLogger(AbstractListUsers.class);

		protected abstract Collection<User<Principal>> getUsers() throws AccessControlException, TransientException;
		protected abstract Collection<User<Principal>> getUsers()
		throws AccessControlException, TransientException;

		@Override
		public Object run()
		{
		try
		protected void doRun() throws AccessControlException, TransientException
		{
		Collection<User<Principal>> users = this.getUsers();

		@@ -32,17 +98,7 @@ public abstract class AbstractListUsers extends AbstractCommand
		{
		this.systemOut.println(user.getUserID().getName());
		}
		}
		catch (AccessControlException e)
		{
		log.error(e.getMessage(), e);
		}
		catch (TransientException e)
		{
		String message = "Internal Transient Error: " + e.getMessage();
		log.error(message, e);
		}

		return null;
		this.systemOut.println("Number of users = " + users.size());
		}
		}

projects/cadcAccessControl-Admin/src/ca/nrc/cadc/ac/admin/AbstractUserCommand.java

0 → 100644

+120 −0

Original line number	Diff line number	Diff line
		/*
		************************************************************************
		***************** CANADIAN ASTRONOMY DATA CENTRE *****************
		************ CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES ************
		*
		* (c) 2014. (c) 2014.
		* Government of Canada Gouvernement du Canada
		* National Research Council Conseil national de recherches
		* Ottawa, Canada, K1A 0R6 Ottawa, Canada, K1A 0R6
		* All rights reserved Tous droits réservés
		*
		* NRC disclaims any warranties, Le CNRC dénie toute garantie
		* expressed, implied, or énoncée, implicite ou légale,
		* statutory, of any kind with de quelque nature que ce
		* respect to the software, soit, concernant le logiciel,
		* including without limitation y compris sans restriction
		* any warranty of merchantability toute garantie de valeur
		* or fitness for a particular marchande ou de pertinence
		* purpose. NRC shall not be pour un usage particulier.
		* liable in any event for any Le CNRC ne pourra en aucun cas
		* damages, whether direct or être tenu responsable de tout
		* indirect, special or general, dommage, direct ou indirect,
		* consequential or incidental, particulier ou général,
		* arising from the use of the accessoire ou fortuit, résultant
		* software. Neither the name de l'utilisation du logiciel. Ni
		* of the National Research le nom du Conseil National de
		* Council of Canada nor the Recherches du Canada ni les noms
		* names of its contributors may de ses participants ne peuvent
		* be used to endorse or promote être utilisés pour approuver ou
		* products derived from this promouvoir les produits dérivés
		* software without specific prior de ce logiciel sans autorisation
		* written permission. préalable et particulière
		* par écrit.
		*
		* This file is part of the Ce fichier fait partie du projet
		* OpenCADC project. OpenCADC.
		*
		* OpenCADC is free software: OpenCADC est un logiciel libre ;
		* you can redistribute it and/or vous pouvez le redistribuer ou le
		* modify it under the terms of modifier suivant les termes de
		* the GNU Affero General Public la “GNU Affero General Public
		* License as published by the License” telle que publiée
		* Free Software Foundation, par la Free Software Foundation
		* either version 3 of the : soit la version 3 de cette
		* License, or (at your option) licence, soit (à votre gré)
		* any later version. toute version ultérieure.
		*
		* OpenCADC is distributed in the OpenCADC est distribué
		* hope that it will be useful, dans l’espoir qu’il vous
		* but WITHOUT ANY WARRANTY; sera utile, mais SANS AUCUNE
		* without even the implied GARANTIE : sans même la garantie
		* warranty of MERCHANTABILITY implicite de COMMERCIALISABILITÉ
		* or FITNESS FOR A PARTICULAR ni d’ADÉQUATION À UN OBJECTIF
		* PURPOSE. See the GNU Affero PARTICULIER. Consultez la Licence
		* General Public License for Générale Publique GNU Affero
		* more details. pour plus de détails.
		*
		* You should have received Vous devriez avoir reçu une
		* a copy of the GNU Affero copie de la Licence Générale
		* General Public License along Publique GNU Affero avec
		* with OpenCADC. If not, see OpenCADC ; si ce n’est
		* <http://www.gnu.org/licenses/>. pas le cas, consultez :
		* <http://www.gnu.org/licenses/>.
		*
		* $Revision: 4 $
		*
		************************************************************************
		*/

		package ca.nrc.cadc.ac.admin;

		import java.security.AccessControlException;
		import java.security.Principal;

		import org.apache.log4j.Logger;

		import ca.nrc.cadc.ac.UserNotFoundException;
		import ca.nrc.cadc.auth.HttpPrincipal;
		import ca.nrc.cadc.net.TransientException;

		/**
		* Base class for commands that require the user ID to be provided.
		* @author yeunga
		*
		*/
		public abstract class AbstractUserCommand extends AbstractCommand
		{
		private static final Logger log = Logger.getLogger(AbstractUserCommand.class);

		private HttpPrincipal principal;
		protected abstract void execute()
		throws UserNotFoundException, AccessControlException, TransientException;

		/**
		* Constructor
		* @param userID Id of the user to associated with the command
		*/
		public AbstractUserCommand(final String userID)
		{
		this.principal = new HttpPrincipal(userID);
		}

		protected Principal getPrincipal()
		{
		return this.principal;
		}

		protected void doRun() throws AccessControlException, TransientException
		{
		try
		{
		this.execute();
		}
		catch (UserNotFoundException e1)
		{
		String msg = "User " + this.getPrincipal().getName() + " was not found.";
		this.systemOut.println(msg);
		}
		}
		}

projects/cadcAccessControl-Admin/src/ca/nrc/cadc/ac/admin/ApproveUser.java

+88 −15

Original line number	Diff line number	Diff line
		/*
		************************************************************************
		***************** CANADIAN ASTRONOMY DATA CENTRE *****************
		************ CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES ************
		*
		* (c) 2014. (c) 2014.
		* Government of Canada Gouvernement du Canada
		* National Research Council Conseil national de recherches
		* Ottawa, Canada, K1A 0R6 Ottawa, Canada, K1A 0R6
		* All rights reserved Tous droits réservés
		*
		* NRC disclaims any warranties, Le CNRC dénie toute garantie
		* expressed, implied, or énoncée, implicite ou légale,
		* statutory, of any kind with de quelque nature que ce
		* respect to the software, soit, concernant le logiciel,
		* including without limitation y compris sans restriction
		* any warranty of merchantability toute garantie de valeur
		* or fitness for a particular marchande ou de pertinence
		* purpose. NRC shall not be pour un usage particulier.
		* liable in any event for any Le CNRC ne pourra en aucun cas
		* damages, whether direct or être tenu responsable de tout
		* indirect, special or general, dommage, direct ou indirect,
		* consequential or incidental, particulier ou général,
		* arising from the use of the accessoire ou fortuit, résultant
		* software. Neither the name de l'utilisation du logiciel. Ni
		* of the National Research le nom du Conseil National de
		* Council of Canada nor the Recherches du Canada ni les noms
		* names of its contributors may de ses participants ne peuvent
		* be used to endorse or promote être utilisés pour approuver ou
		* products derived from this promouvoir les produits dérivés
		* software without specific prior de ce logiciel sans autorisation
		* written permission. préalable et particulière
		* par écrit.
		*
		* This file is part of the Ce fichier fait partie du projet
		* OpenCADC project. OpenCADC.
		*
		* OpenCADC is free software: OpenCADC est un logiciel libre ;
		* you can redistribute it and/or vous pouvez le redistribuer ou le
		* modify it under the terms of modifier suivant les termes de
		* the GNU Affero General Public la “GNU Affero General Public
		* License as published by the License” telle que publiée
		* Free Software Foundation, par la Free Software Foundation
		* either version 3 of the : soit la version 3 de cette
		* License, or (at your option) licence, soit (à votre gré)
		* any later version. toute version ultérieure.
		*
		* OpenCADC is distributed in the OpenCADC est distribué
		* hope that it will be useful, dans l’espoir qu’il vous
		* but WITHOUT ANY WARRANTY; sera utile, mais SANS AUCUNE
		* without even the implied GARANTIE : sans même la garantie
		* warranty of MERCHANTABILITY implicite de COMMERCIALISABILITÉ
		* or FITNESS FOR A PARTICULAR ni d’ADÉQUATION À UN OBJECTIF
		* PURPOSE. See the GNU Affero PARTICULIER. Consultez la Licence
		* General Public License for Générale Publique GNU Affero
		* more details. pour plus de détails.
		*
		* You should have received Vous devriez avoir reçu une
		* a copy of the GNU Affero copie de la Licence Générale
		* General Public License along Publique GNU Affero avec
		* with OpenCADC. If not, see OpenCADC ; si ce n’est
		* <http://www.gnu.org/licenses/>. pas le cas, consultez :
		* <http://www.gnu.org/licenses/>.
		*
		* $Revision: 4 $
		*
		************************************************************************
		*/

		package ca.nrc.cadc.ac.admin;

		import java.security.AccessControlException;

		import org.apache.log4j.Logger;

		import ca.nrc.cadc.ac.UserNotFoundException;
		import ca.nrc.cadc.net.TransientException;

		/**
		* This class approves the specified pending user by changing the user
		* This class approves the specified pending user by moving the user
		* from a pending user to an active user in the LDAP server.
		* @author yeunga
		*
		*/
		public class ApproveUser extends AbstractCommand
		public class ApproveUser extends AbstractUserCommand
		{
		private static final Logger log = Logger.getLogger(ApproveUser.class);

		private String userID;

		/**
		* Constructor
		* @param userID Id of the pending user to be approved
		*/
		public ApproveUser(final String userID)
		{
		this.userID = userID;
		super(userID);
		}

		@Override
		public Object run()
		protected void execute()
		throws AccessControlException, UserNotFoundException, TransientException
		{
		// TODO Auto-generated method stub
		return new Object();
		this.getUserPersistence().approvePendingUser(this.getPrincipal());
		String msg = "User " + this.getPrincipal().getName() + " was approved successfully.";
		this.systemOut.println(msg);
		}
		}