org.apache.aries.jmx.codec.GroupData Maven / Gradle / Ivy

/**
 *  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.aries.jmx.codec;

import java.util.ArrayList;
import java.util.Dictionary;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.management.openmbean.CompositeData;
import javax.management.openmbean.CompositeDataSupport;
import javax.management.openmbean.OpenDataException;

import org.osgi.jmx.service.useradmin.UserAdminMBean;
import org.osgi.service.useradmin.Group;
import org.osgi.service.useradmin.Role;

/**
 * 
 * GroupData represents Group Type @see {@link UserAdminMBean#GROUP_TYPE}.It is a codec
 * for the CompositeData representing a Group.
 * 
 * 
 *
 * @version $Rev: 1597603 $ $Date: 2014-05-26 16:17:52 +0100 (Mon, 26 May 2014) $
 */
public class GroupData extends UserData {

    /**
     * @see UserAdminMBean#MEMBERS_ITEM
     * @see UserAdminMBean#MEMBERS
     */
    private String[] members;
    /**
     * @see UserAdminMBean#REQUIRED_MEMBERS
     * @see UserAdminMBean#REQUIRED_MEMBERS_ITEM
     */
    private String[] requiredMembers;

    /**
     * Constructs new GroupData from Group object.
     * @param group {@link Group} instance.
     */
    public GroupData(Group group) {
        super(group.getName(), Role.GROUP, group.getProperties(), group.getCredentials());
        this.members = toArray(group.getMembers());
        this.requiredMembers = toArray(group.getRequiredMembers());
    }

    /**
     * Constructs new GroupData.
     *
     * @param name group name.
     * @param members basic members.
     * @param requiredMembers required members.
     */
    public GroupData(String name, String[] members, String[] requiredMembers) {
        this(name, null, null, members, requiredMembers);
    }
    
    /**
     * Constructs new GroupData.
     *
     * @param name group name.
     * @param properties group properties.
     * @param credentials group credentials.
     * @param members basic members.
     * @param requiredMembers required members.
     */
    @SuppressWarnings("rawtypes")
	public GroupData(String name, Dictionary properties, Dictionary credentials, String[] members, String[] requiredMembers) {
        super(name, Role.GROUP, properties, credentials);
        this.members = (members == null) ? new String[0] : members;
        this.requiredMembers = (requiredMembers == null) ? new String[0] : requiredMembers;
    }

    /**
     * Translates GroupData to CompositeData represented by compositeType {@link UserAdminMBean#GROUP_TYPE}.
     *
     * @return translated GroupData to compositeData.
     */
    public CompositeData toCompositeData() {
        try {
            Map items = new HashMap();
            items.put(UserAdminMBean.NAME, name);
            items.put(UserAdminMBean.TYPE, type);
            // items.put(UserAdminMBean.PROPERTIES, getPropertiesTable());
            // items.put(UserAdminMBean.CREDENTIALS, getCredentialsTable());
            items.put(UserAdminMBean.MEMBERS, members);
            items.put(UserAdminMBean.REQUIRED_MEMBERS, requiredMembers);
            return new CompositeDataSupport(UserAdminMBean.GROUP_TYPE, items);
        } catch (OpenDataException e) {
            throw new IllegalStateException("Can't create CompositeData" + e);
        }
    }

    /**
     * Static factory method to create GroupData from CompositeData object.
     *
     * @param data
     *            {@link CompositeData} instance.
     * @return GroupData instance.
     */
    public static GroupData from(CompositeData data) {
        if (data == null) {
            return null;
        }
        String name = (String) data.get(UserAdminMBean.NAME);
        // Dictionary props = propertiesFrom((TabularData) data.get(UserAdminMBean.PROPERTIES));
        // Dictionary credentials = propertiesFrom((TabularData) data.get(UserAdminMBean.CREDENTIALS));

        String[] members = (String[]) data.get(UserAdminMBean.MEMBERS);
        String[] requiredMembers = (String[]) data.get(UserAdminMBean.REQUIRED_MEMBERS);
        return new GroupData(name, null, null,/* props, credentials, */ members, requiredMembers);
    }

    /**
     * @return the members
     */
    public String[] getMembers() {
        return members;
    }

    /**
     * @return the requiredMembers
     */
    public String[] getRequiredMembers() {
        return requiredMembers;
    }

    private static String[] toArray(Role[] roles) {
        List members = new ArrayList();
        if (roles != null) {
            for (Role role : roles) {
                members.add(role.getName());
            }
        }
        return members.toArray(new String[members.size()]);
    }
}