[jboss-cvs] JBossAS SVN: r62733 - in projects/security/security-spi/trunk/src/main/org/jboss/security: client and 1 other directory.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Wed May 2 10:48:09 EDT 2007
Author: anil.saldhana at jboss.com
Date: 2007-05-02 10:48:09 -0400 (Wed, 02 May 2007)
New Revision: 62733
Added:
projects/security/security-spi/trunk/src/main/org/jboss/security/client/
projects/security/security-spi/trunk/src/main/org/jboss/security/client/SecurityClient.java
projects/security/security-spi/trunk/src/main/org/jboss/security/client/SecurityClientFactory.java
Log:
SECURITY-44: client spi
Added: projects/security/security-spi/trunk/src/main/org/jboss/security/client/SecurityClient.java
===================================================================
--- projects/security/security-spi/trunk/src/main/org/jboss/security/client/SecurityClient.java (rev 0)
+++ projects/security/security-spi/trunk/src/main/org/jboss/security/client/SecurityClient.java 2007-05-02 14:48:09 UTC (rev 62733)
@@ -0,0 +1,130 @@
+/*
+ * JBoss, Home of Professional Open Source
+ * Copyright 2007, JBoss Inc., and individual contributors as indicated
+ * by the @authors tag. See the copyright.txt 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.client;
+
+import javax.security.auth.callback.CallbackHandler;
+import javax.security.auth.login.LoginException;
+
+//$Id$
+
+/**
+ * Generic Security Client class <br/>
+ * <b>Basic Users:</b><br/>
+ * <p>Basic users will just use the methods that set the username and credential
+ * @see {@link #setUserName(String)} and @see {@link #setCredential(Object)} </p>
+ * <b>Intermediate Users:</b></br/>
+ * <p>You can specify usage of JAAS as the framework in the client implementation.
+ * In this case, you will @see {@link #setLoginConfigName(String)} and
+ * @see #setCallbackHandler(CallbackHandler)</p>
+ * <b>Advanced Users:</b>
+ * <p>You will use the @see {@link #setSASLMechanism(String)} method</p>
+ *
+ * @author Anil.Saldhana at redhat.com
+ * @since May 1, 2007
+ * @version $Revision$
+ */
+public abstract class SecurityClient
+{
+ protected Object userPrincipal = null;
+ protected Object credential = null;
+ protected CallbackHandler callbackHandler = null;
+ protected String loginConfigName = null;
+ protected String saslMechanism = null;
+ protected String saslAuthorizationId = null;
+
+ protected boolean jaasDesired = false;
+ protected boolean saslDesired = false;
+
+ /**
+ * Login with the desired method
+ * @throws LoginException
+ */
+ public void login() throws LoginException
+ {
+ if(jaasDesired)
+ performJAASLogin();
+ else
+ if(saslDesired)
+ peformSASLLogin();
+ else
+ performSimpleLogin();
+ }
+
+ /**
+ * Log Out
+ */
+ public void logout()
+ {
+ setSimple(null,null);
+ setJAAS(null,null);
+ setSASL(null,null,null);
+ cleanUp();
+ }
+
+ /**
+ * Set the user name and credential for simple login (non-jaas, non-sasl)
+ * @param username (Can be null)
+ * @param credential (Can be null)
+ */
+ public void setSimple(Object username, Object credential)
+ {
+ this.userPrincipal = username;
+ this.credential = credential;
+ }
+
+ /**
+ * Set the JAAS Login Configuration Name and Call back handler
+ * @param configName can be null
+ * @param cbh can be null
+ */
+ public void setJAAS(String configName, CallbackHandler cbh)
+ {
+ this.loginConfigName = configName;
+ this.callbackHandler = cbh;
+ this.jaasDesired = true;
+ }
+
+ /**
+ * Set the mechanism and other parameters for SASL Client
+ * @param mechanism
+ * @param authorizationId
+ * @param cbh
+ */
+ public void setSASL(String mechanism, String authorizationId,
+ CallbackHandler cbh)
+ {
+ this.saslMechanism = mechanism;
+ this.saslAuthorizationId = authorizationId;
+ this.callbackHandler = cbh;
+ this.saslDesired = true;
+ }
+
+ protected abstract void performJAASLogin() throws LoginException;
+ protected abstract void peformSASLLogin();
+ protected abstract void performSimpleLogin();
+
+ /**
+ * Provide an opportunity for client implementations to clean up
+ */
+ protected abstract void cleanUp();
+
+}
Added: projects/security/security-spi/trunk/src/main/org/jboss/security/client/SecurityClientFactory.java
===================================================================
--- projects/security/security-spi/trunk/src/main/org/jboss/security/client/SecurityClientFactory.java (rev 0)
+++ projects/security/security-spi/trunk/src/main/org/jboss/security/client/SecurityClientFactory.java 2007-05-02 14:48:09 UTC (rev 62733)
@@ -0,0 +1,91 @@
+/*
+ * JBoss, Home of Professional Open Source
+ * Copyright 2007, JBoss Inc., and individual contributors as indicated
+ * by the @authors tag. See the copyright.txt 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.client;
+
+import java.lang.reflect.Constructor;
+import java.security.AccessController;
+import java.security.PrivilegedActionException;
+import java.security.PrivilegedExceptionAction;
+
+//$Id$
+
+/**
+ * Factory to return SecurityClient instances
+ * @author Anil.Saldhana at redhat.com
+ * @since May 1, 2007
+ * @version $Revision$
+ */
+public class SecurityClientFactory
+{
+ private static String defaultClient = "org.jboss.security.client.JBossSecurityClient";
+
+ /**
+ * Return the default Security Client
+ * The default Security Client is of type
+ * "org.jboss.security.client.JBossSecurityClient"
+ * @return
+ * @throws Exception
+ */
+ public static SecurityClient getSecurityClient() throws Exception
+ {
+ return getSC(defaultClient);
+ }
+
+ /**
+ * Return a security client of type
+ * @param client FQN of the security client implementation
+ * @return
+ * @throws Exception
+ */
+ public static SecurityClient getSecurityClient(String client) throws Exception
+ {
+ return getSC(client);
+ }
+
+ /**
+ * Obtain a Security Client
+ * @param clazz Class object that is of SecurityClient Type
+ * @return
+ * @throws Exception
+ */
+ public static SecurityClient getSecurityClient(Class<?> clazz)
+ throws Exception
+ {
+ if(SecurityClient.class.isAssignableFrom(clazz) == false)
+ throw new IllegalArgumentException("clazz is not of SecurityClient type");
+ //Use reflection to invoke the constructors
+ Constructor<?> ctr = clazz.getConstructor(new Class[]{});
+ return (SecurityClient) ctr.newInstance(new Object[]{});
+ }
+
+ private static SecurityClient getSC(final String client) throws PrivilegedActionException
+ {
+ return (SecurityClient)AccessController.doPrivileged(new PrivilegedExceptionAction()
+ {
+ public Object run() throws ClassNotFoundException, InstantiationException, IllegalAccessException
+ {
+ Class<?> clazz = Thread.currentThread().getContextClassLoader().loadClass(client);
+ return clazz.newInstance();
+ }
+ });
+ }
+}
More information about the jboss-cvs-commits
mailing list