All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.camel.component.box.api.BoxGroupsManager Maven / Gradle / Ivy

There is a newer version: 4.8.1
Show newest version
/*
 * 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.camel.component.box.api;

import java.util.ArrayList;
import java.util.Collection;

import com.box.sdk.BoxAPIConnection;
import com.box.sdk.BoxAPIException;
import com.box.sdk.BoxGroup;
import com.box.sdk.BoxGroupMembership;
import com.box.sdk.BoxUser;
import org.apache.camel.RuntimeCamelException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Provides operations to manage Box groups.
 */
public class BoxGroupsManager {

    private static final Logger LOG = LoggerFactory.getLogger(BoxGroupsManager.class);

    /**
     * Box connection to authenticated user account.
     */
    private BoxAPIConnection boxConnection;

    /**
     * Create groups manager to manage the users of Box connection's authenticated user.
     *
     * @param boxConnection - Box connection to authenticated user account.
     */
    public BoxGroupsManager(BoxAPIConnection boxConnection) {
        this.boxConnection = boxConnection;
    }

    /**
     * Get all the groups in the enterprise.
     *
     * @return Collection containing all the enterprise's groups.
     */
    public Collection getAllGroups() {
        try {
            LOG.debug("Getting all groups");

            Collection groups = new ArrayList<>();
            for (BoxGroup.Info groupInfo : BoxGroup.getAllGroups(boxConnection)) {
                groups.add(groupInfo.getResource());
            }
            return groups;
        } catch (BoxAPIException e) {
            throw new RuntimeCamelException(
                    buildBoxApiErrorMessage(e), e);
        }
    }

    private static String buildBoxApiErrorMessage(BoxAPIException e) {
        return String.format("Box API returned the error code %d%n%n%s", e.getResponseCode(), e.getResponse());
    }

    /**
     * Create a new group with a specified name and optional additional parameters. Optional parameters may be null.
     *
     * @param  name                   - the name of the new group.
     * @param  provenance             - the provenance of the new group.
     * @param  externalSyncIdentifier - the external_sync_identifier of the new group.
     * @param  description            - the description of the new group.
     * @param  invitabilityLevel      - the invitibility_level of the new group.
     * @param  memberViewabilityLevel - the member_viewability_level of the new group.
     * @return                        The newly created group.
     */
    public BoxGroup createGroup(
            String name, String provenance,
            String externalSyncIdentifier, String description,
            String invitabilityLevel, String memberViewabilityLevel) {

        try {
            LOG.debug("Creating group name={}", name);
            if (name == null) {
                throw new IllegalArgumentException("Parameter 'name' can not be null");
            }

            return BoxGroup.createGroup(boxConnection, name, provenance, externalSyncIdentifier, description,
                    invitabilityLevel, memberViewabilityLevel).getResource();
        } catch (BoxAPIException e) {
            throw new RuntimeCamelException(
                    buildBoxApiErrorMessage(e), e);
        }
    }

    /**
     * Delete group.
     *
     * @param groupId - the id of group to delete.
     */
    public void deleteGroup(String groupId) {
        try {
            LOG.debug("Deleting group({})", groupId);
            BoxHelper.notNull(groupId, BoxHelper.GROUP_ID);

            BoxGroup group = new BoxGroup(boxConnection, groupId);
            group.delete();
        } catch (BoxAPIException e) {
            throw new RuntimeCamelException(
                    buildBoxApiErrorMessage(e), e);
        }
    }

    /**
     * Get group information.
     *
     * @param  groupId - the id of group.
     * @return         The group information.
     */
    public BoxGroup.Info getGroupInfo(String groupId) {
        try {
            LOG.debug("Getting info for group(id={})", groupId);
            BoxHelper.notNull(groupId, BoxHelper.GROUP_ID);

            BoxGroup group = new BoxGroup(boxConnection, groupId);

            return group.getInfo();
        } catch (BoxAPIException e) {
            throw new RuntimeCamelException(
                    buildBoxApiErrorMessage(e), e);
        }
    }

    /**
     * Update group information.
     *
     * @param  groupId   - the id of group to update.
     * @param  groupInfo - the updated information
     * @return           The updated group.
     */
    public BoxGroup updateGroupInfo(String groupId, BoxGroup.Info groupInfo) {
        try {
            LOG.debug("Updating info for group(id={})", groupId);
            BoxHelper.notNull(groupId, BoxHelper.GROUP_ID);
            BoxHelper.notNull(groupInfo, BoxHelper.GROUP_INFO);

            BoxGroup group = new BoxGroup(boxConnection, groupId);
            group.updateInfo(groupInfo);
            return group;
        } catch (BoxAPIException e) {
            throw new RuntimeCamelException(
                    buildBoxApiErrorMessage(e), e);
        }
    }

    /**
     * Get information about all of the group memberships for this group.
     *
     * @param  groupId - the id of group.
     * @return         The group information.
     */
    public Collection getGroupMemberships(String groupId) {
        try {
            LOG.debug("Getting information about all memberships for group(id={})", groupId);
            BoxHelper.notNull(groupId, BoxHelper.GROUP_ID);

            BoxGroup group = new BoxGroup(boxConnection, groupId);

            return group.getMemberships();
        } catch (BoxAPIException e) {
            throw new RuntimeCamelException(
                    buildBoxApiErrorMessage(e), e);
        }
    }

    /**
     * Add a member to group with the specified role.
     *
     * @param  groupId - the id of group.
     * @param  userId  - the id of user to be added to group.
     * @param  role    - the role of the user in this group. Can be null to assign the default role.
     * @return         The group information.
     */
    public BoxGroupMembership addGroupMembership(String groupId, String userId, BoxGroupMembership.GroupRole role) {
        try {
            LOG.debug("Adding user(id={}) as member to group(id={} {})",
                    userId, groupId, role == null ? "" : "with role=" + role.name());
            BoxHelper.notNull(groupId, BoxHelper.GROUP_ID);
            BoxHelper.notNull(userId, BoxHelper.USER_ID);

            BoxGroup group = new BoxGroup(boxConnection, groupId);
            BoxUser user = new BoxUser(boxConnection, userId);

            return group.addMembership(user, role).getResource();
        } catch (BoxAPIException e) {
            throw new RuntimeCamelException(
                    buildBoxApiErrorMessage(e), e);
        }
    }

    /**
     * Delete group membership.
     *
     * @param groupMembershipId - the id of group membership to delete.
     */
    public void deleteGroupMembership(String groupMembershipId) {
        try {
            LOG.debug("Deleting groupMembership(id={})", groupMembershipId);
            BoxHelper.notNull(groupMembershipId, BoxHelper.GROUP_MEMBERSHIP_ID);

            BoxGroupMembership groupMembership = new BoxGroupMembership(boxConnection, groupMembershipId);

            groupMembership.delete();
        } catch (BoxAPIException e) {
            throw new RuntimeCamelException(
                    buildBoxApiErrorMessage(e), e);
        }
    }

    /**
     * Get group membership information.
     *
     * @param  groupMembershipId - the id of group membership.
     * @return                   The group information.
     */
    public BoxGroupMembership.Info getGroupMembershipInfo(String groupMembershipId) {
        try {
            LOG.debug("Getting info for groupMemebership(id={})", groupMembershipId);
            BoxHelper.notNull(groupMembershipId, BoxHelper.GROUP_MEMBERSHIP_ID);

            BoxGroupMembership group = new BoxGroupMembership(boxConnection, groupMembershipId);

            return group.getInfo();
        } catch (BoxAPIException e) {
            throw new RuntimeCamelException(
                    buildBoxApiErrorMessage(e), e);
        }
    }

    /**
     * Update group membership information.
     *
     * @param  groupMembershipId - the id of group membership to update.
     * @param  info              - the updated information.
     * @return                   The group information.
     */
    public BoxGroupMembership updateGroupMembershipInfo(String groupMembershipId, BoxGroupMembership.Info info) {
        try {
            LOG.debug("Updating info for groupMembership(id={})", groupMembershipId);
            BoxHelper.notNull(groupMembershipId, BoxHelper.GROUP_MEMBERSHIP_ID);
            BoxHelper.notNull(info, BoxHelper.INFO);

            BoxGroupMembership groupMembership = new BoxGroupMembership(boxConnection, groupMembershipId);

            groupMembership.updateInfo(info);
            return groupMembership;
        } catch (BoxAPIException e) {
            throw new RuntimeCamelException(
                    buildBoxApiErrorMessage(e), e);
        }
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy