[jboss-cvs] JBossAS SVN: r57575 - projects/security/trunk/src/main/org/jboss/security/mapping/providers

[jboss-cvs-commits at lists.jboss.org]

Author: anil.saldhana at jboss.com
Date: 2006-10-11 16:03:25 -0400 (Wed, 11 Oct 2006)
New Revision: 57575

Added:
   projects/security/trunk/src/main/org/jboss/security/mapping/providers/MappingProviderUtil.java
Log:
Mapping Provider util class

Added: projects/security/trunk/src/main/org/jboss/security/mapping/providers/MappingProviderUtil.java
===================================================================
--- projects/security/trunk/src/main/org/jboss/security/mapping/providers/MappingProviderUtil.java	2006-10-11 20:02:59 UTC (rev 57574)
+++ projects/security/trunk/src/main/org/jboss/security/mapping/providers/MappingProviderUtil.java	2006-10-11 20:03:25 UTC (rev 57575)
@@ -0,0 +1,130 @@
+/*
+  * JBoss, Home of Professional Open Source.
+  * Copyright 2006, Red Hat Middleware LLC, and individual contributors
+  * as indicated by the @author tags. See the copyright.txt file in the
+  * distribution for a full listing of individual contributors. 
+  *
+  * 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.jboss.security.mapping.providers;
+
+import java.lang.reflect.Constructor;
+import java.security.Principal;
+import java.security.acl.Group; 
+import java.util.Enumeration;
+import java.util.StringTokenizer;
+
+import org.jboss.logging.Logger;
+import org.jboss.security.SimplePrincipal;
+
+//$Id$
+
+/**
+ *  Utility class for Mapping Providers
+ *  @author <a href="mailto:Anil.Saldhana at jboss.org">Anil Saldhana</a>
+ *  @since  Oct 10, 2006 
+ *  @version $Revision$
+ */
+public class MappingProviderUtil
+{
+   public static Logger log = Logger.getLogger(MappingProviderUtil.class);
+   
+   /**
+    * Add the roles into the Group
+    * @param roles Group of roles
+    * @param addRoles
+    * @return Group with the added roles
+    */
+   public static Group addRoles(Group roles, String[] addRoles)
+   {  
+      Class pClass = getPrincipalClass(roles); 
+      for(String str:addRoles)
+      { 
+         roles.addMember(instantiatePrincipal(pClass,str));
+      }
+      return roles;
+   }
+   
+   /**
+    * Given a comma-separated list of roles, return a string array
+    * @param str
+    * @return
+    */
+   public static String[] getRolesFromCommaSeparatedString(String str)
+   {
+      if(str == null)
+         throw new IllegalArgumentException("str is null");
+      StringTokenizer st = new StringTokenizer(str,",");
+      int numTokens = st != null ? st.countTokens() : 0;
+      String[] tokens = new String[numTokens];
+      for(int i = 0; i < numTokens; i++)
+      {
+         tokens[i] = st.nextToken();
+      }
+      return tokens;
+   }
+
+   /**
+    * Instantiate a Principal representing a principal
+    * @param cls principal class
+    * @param role Name of the role
+    * @return
+    */
+   public static Principal instantiatePrincipal(Class cls, String role)
+   {
+      Principal p = null;
+      try
+      {
+         Constructor ctr = cls.getConstructor(new Class[] {String.class});
+         p = (Principal)ctr.newInstance(new Object[]{role});
+      }
+      catch (Exception e)
+      {
+         if(log.isTraceEnabled())
+            log.trace("Encountered exception in mapping provider:instantiatePrincipal:",e);
+      } 
+      return p;
+   }
+   
+   /**
+    * Remove the roles from the Group
+    * @param roles Group of roles
+    * @param removeRoles
+    * @return Group with roles removed
+    */
+   public static Group removeRoles(Group roles, String[] removeRoles)
+   {  
+      //Assume that the roles all belong to the same principal class
+      Class pClass = getPrincipalClass(roles); 
+      for(String str:removeRoles)
+      { 
+         roles.removeMember(instantiatePrincipal(pClass,str));
+      }
+      return roles;
+   }
+   
+   private static Class getPrincipalClass(Group roles)
+   {
+      //Assume that the roles all belong to the same principal class 
+      Class principalClass = SimplePrincipal.class;
+      Enumeration<? extends Principal> en = roles.members();
+      if(en.hasMoreElements())
+      {
+         principalClass = roles.members().nextElement().getClass(); 
+      }
+      return principalClass;
+   }
+}