QPID-446 Initial MBean framework.

git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/branches/M2@527182 13f79535-47bb-0310-9956-ffa450edef68

2 files changed, 171 insertions, 0 deletions

diff --git a/java/broker/src/main/java/org/apache/qpid/server/security/access/AMQUserManagementMBean.java b/java/broker/src/main/java/org/apache/qpid/server/security/access/AMQUserManagementMBean.java
new file mode 100644
index 0000000000..452479a3ba
--- /dev/null
+++ b/java/broker/src/main/java/org/apache/qpid/server/security/access/AMQUserManagementMBean.java
@@ -0,0 +1,71 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache 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.apache.org/licenses/LICENSE-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.apache.qpid.server.security.access;
+
+import org.apache.qpid.server.management.MBeanDescription;
+import org.apache.qpid.server.management.AMQManagedObject;
+import org.apache.qpid.server.management.MBeanOperationParameter;
+import org.apache.qpid.server.management.MBeanOperation;
+
+import javax.management.JMException;
+import javax.management.openmbean.TabularData;
+
+/** MBean class for AMQUserManagementMBean. It implements all the management features exposed for managing users. */
+@MBeanDescription("User Management Interface")
+public class AMQUserManagementMBean extends AMQManagedObject implements UserManagement
+{
+
+    public AMQUserManagementMBean() throws JMException
+    {
+        super(UserManagement.class, UserManagement.TYPE);
+    }
+
+    public String getObjectInstanceName()
+    {
+        return UserManagement.TYPE;
+    }
+
+    public boolean setPassword(@MBeanOperationParameter(name = "username", description = "Username")String username, @MBeanOperationParameter(name = "password", description = "Password")String password)
+    {
+        return true;
+    }
+
+    public boolean setRights(@MBeanOperationParameter(name = "username", description = "Username")String username, @MBeanOperationParameter(name = "read", description = "Administration read")boolean read, @MBeanOperationParameter(name = "write", description = "Administration write")boolean write, @MBeanOperationParameter(name = "admin", description = "Administration rights")boolean admin)
+    {
+        return true;
+    }
+
+    public boolean createUser(@MBeanOperationParameter(name = "username", description = "Username")String username, @MBeanOperationParameter(name = "password", description = "Password")String password, @MBeanOperationParameter(name = "read", description = "Administration read")boolean read, @MBeanOperationParameter(name = "write", description = "Administration write")boolean write, @MBeanOperationParameter(name = "admin", description = "Administration rights")boolean admin)
+    {
+        return true;
+    }
+
+    public boolean deleteUser(@MBeanOperationParameter(name = "username", description = "Username")String username)
+    {
+        return true;
+    }
+
+    @MBeanOperation(name = "viewUsers", description = "All users with access rights to the system.")
+    public TabularData viewUsers()
+    {
+        return null;
+    }
+}
diff --git a/java/broker/src/main/java/org/apache/qpid/server/security/access/UserManagement.java b/java/broker/src/main/java/org/apache/qpid/server/security/access/UserManagement.java
new file mode 100644
index 0000000000..e18d49a6d7
--- /dev/null
+++ b/java/broker/src/main/java/org/apache/qpid/server/security/access/UserManagement.java
@@ -0,0 +1,100 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache 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.apache.org/licenses/LICENSE-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.apache.qpid.server.security.access;
+
+import org.apache.qpid.server.management.MBeanOperation;
+import org.apache.qpid.server.management.MBeanOperationParameter;
+import org.apache.qpid.server.management.MBeanAttribute;
+import org.apache.qpid.AMQException;
+
+import javax.management.openmbean.TabularData;
+import javax.management.openmbean.CompositeData;
+import javax.management.JMException;
+import java.io.IOException;
+
+public interface UserManagement
+{
+    String TYPE = "UserManagement";
+
+    //********** Operations *****************//
+
+
+    /**
+     * set password for user
+     *
+     * @param username The username to create
+     * @param password The password for the user
+     *
+     * @return The result of the operation
+     */
+    boolean setPassword(@MBeanOperationParameter(name = "username", description = "Username")String username,
+                        @MBeanOperationParameter(name = "password", description = "Password")String password);
+
+    /**
+     * set rights for users with given details
+     *
+     * @param username The username to create
+     * @param read     The set of permission to give the new user
+     * @param write    The set of permission to give the new user
+     * @param admin    The set of permission to give the new user
+     *
+     * @return The result of the operation
+     */
+    boolean setRights(@MBeanOperationParameter(name = "username", description = "Username")String username,
+                      @MBeanOperationParameter(name = "read", description = "Administration read")boolean read,
+                      @MBeanOperationParameter(name = "write", description = "Administration write")boolean write,
+                      @MBeanOperationParameter(name = "admin", description = "Administration rights")boolean admin);
+
+    /**
+     * Create users with given details
+     *
+     * @param username The username to create
+     * @param password The password for the user
+     * @param read     The set of permission to give the new user
+     * @param write    The set of permission to give the new user
+     * @param admin    The set of permission to give the new user
+     *
+     * @return The result of the operation
+     */
+    boolean createUser(@MBeanOperationParameter(name = "username", description = "Username")String username,
+                       @MBeanOperationParameter(name = "password", description = "Password")String password,
+                       @MBeanOperationParameter(name = "read", description = "Administration read")boolean read,
+                       @MBeanOperationParameter(name = "write", description = "Administration write")boolean write,
+                       @MBeanOperationParameter(name = "admin", description = "Administration rights")boolean admin);
+
+    /**
+     * View users returns all the users that are currently available to the system.
+     *
+     * @param username The user to delete
+     *
+     * @return The result of the operation
+     */
+    boolean deleteUser(@MBeanOperationParameter(name = "username", description = "Username")String username);
+
+    /**
+     * View users returns all the users that are currently available to the system.
+     *
+     * @return a table of users data (Username, read, write, admin)
+     */
+    @MBeanOperation(name = "viewUsers", description = "All users with access rights to the system.")
+    TabularData viewUsers();
+
+}