jp.openstandia.connector.atlassian.AtlassianGuardGroupHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of connector-atlassian-guard Show documentation
Atlassian Guard Connector.
The newest version!
/*
 *  Copyright Nomura Research Institute, Ltd.
 *
 *  Licensed 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 jp.openstandia.connector.atlassian;

import jp.openstandia.connector.util.ObjectHandler;
import jp.openstandia.connector.util.SchemaDefinition;
import org.identityconnectors.common.StringUtil;
import org.identityconnectors.common.logging.Log;
import org.identityconnectors.framework.common.exceptions.AlreadyExistsException;
import org.identityconnectors.framework.common.objects.*;

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import static jp.openstandia.connector.util.Utils.toZoneDateTimeForISO8601OffsetDateTime;
import static org.identityconnectors.framework.common.objects.AttributeInfo.Flags.*;

public class AtlassianGuardGroupHandler implements ObjectHandler {

    public static final ObjectClass GROUP_OBJECT_CLASS = new ObjectClass("Group");

    private static final Log LOGGER = Log.getLog(AtlassianGuardGroupHandler.class);

    private final AtlassianGuardConfiguration configuration;
    private final AtlassianGuardRESTClient client;
    private final SchemaDefinition schema;

    public AtlassianGuardGroupHandler(AtlassianGuardConfiguration configuration, AtlassianGuardRESTClient client,
                                      SchemaDefinition schema) {
        this.configuration = configuration;
        this.client = client;
        this.schema = schema;
    }

    public static SchemaDefinition.Builder createSchema(AtlassianGuardConfiguration configuration, AtlassianGuardRESTClient client) {
        SchemaDefinition.Builder sb
                = SchemaDefinition.newBuilder(GROUP_OBJECT_CLASS, AtlassianGuardGroupModel.class, PatchOperationsModel.class, AtlassianGuardGroupModel.class);

        // __UID__
        // The id for the group. Must be unique and unchangeable.
        sb.addUid("groupId",
                SchemaDefinition.Types.STRING_CASE_IGNORE,
                null,
                (source) -> source.id,
                "id",
                NOT_CREATABLE, NOT_UPDATEABLE
        );

        // displayName (__NAME__)
        // The name for the group. Must be unique for ConnId Name attribute though it's not required and unique in Atlassian Guard.
        // Also, it's case-insensitive.
        sb.addName("displayName",
                SchemaDefinition.Types.STRING_CASE_IGNORE,
                (source, dest) -> dest.displayName = source,
                (source, dest) -> dest.replace("displayName", source),
                (source) -> StringUtil.isEmpty(source.displayName) ? source.id : source.displayName,
                null,
                REQUIRED
        );

        // Attributes
        // Nothing

        // Association
        sb.addAsMultiple("members.User.value",
                SchemaDefinition.Types.UUID,
                (source, dest) -> {
                    dest.members = source != null ? source.stream().map(x -> {
                        AtlassianGuardGroupModel.Member member = new AtlassianGuardGroupModel.Member();
                        member.value = x;
                        return member;
                    }).collect(Collectors.toList()) : null;
                },
                (add, dest) -> dest.addMembers(add),
                (remove, dest) -> dest.removeMembers(remove),
                (source) -> source.members != null ? source.members.stream().filter(x -> x.type != null && x.type.equals("User")).map(x -> x.value) : null,
                null
        );

        // Metadata (readonly)
        sb.add("meta.created",
                SchemaDefinition.Types.DATETIME,
                null,
                (source) -> source.meta == null || source.meta.created == null ? null : toZoneDateTimeForISO8601OffsetDateTime(source.meta.created),
                null,
                NOT_CREATABLE, NOT_UPDATEABLE
        );
        sb.add("meta.lastModified",
                SchemaDefinition.Types.DATETIME,
                null,
                (source) -> source.meta == null || source.meta.lastModified == null ? null : toZoneDateTimeForISO8601OffsetDateTime(source.meta.lastModified),
                null,
                NOT_CREATABLE, NOT_UPDATEABLE
        );
        LOGGER.ok("The constructed group schema");

        return sb;
    }

    private static Stream filterGroups(AtlassianGuardConfiguration configuration, Stream groups) {
        Set ignoreGroup = configuration.getIgnoreGroupSet();
        return groups.filter(g -> !ignoreGroup.contains(g));
    }

    @Override
    public SchemaDefinition getSchema() {
        return schema;
    }

    @Override
    public Uid create(Set attributes) {
        AtlassianGuardGroupModel group = new AtlassianGuardGroupModel();
        AtlassianGuardGroupModel mapped = schema.apply(attributes, group);

        if (configuration.isUniqueCheckGroupDisplayNameEnabled()) {
            OperationOptions options = new OperationOptionsBuilder().setPageSize(1).setPagedResultsOffset(1).build();
            AtlassianGuardGroupModel found = client.getGroup(new Name(group.displayName), options, Collections.emptySet());
            if (found != null && found.displayName.equalsIgnoreCase(group.displayName)) {
                throw new AlreadyExistsException(String.format("Group \"%s\" already exists", group.displayName));
            }
        }

        Uid newUid = client.createGroup(mapped);

        return newUid;
    }

    @Override
    public Set updateDelta(Uid uid, Set modifications, OperationOptions options) {
        PatchOperationsModel dest = new PatchOperationsModel();

        schema.applyDelta(modifications, dest);

        if (dest.hasAttributesChange()) {
            client.patchGroup(uid, dest);
        }

        return null;
    }

    @Override
    public void delete(Uid uid, OperationOptions options) {
        client.deleteGroup(uid);
    }

    @Override
    public int getByUid(Uid uid, ResultsHandler resultsHandler, OperationOptions options,
                        Set returnAttributesSet, Set fetchFieldsSet,
                        boolean allowPartialAttributeValues, int pageSize, int pageOffset) {
        AtlassianGuardGroupModel group = client.getGroup(uid, options, fetchFieldsSet);

        if (group != null) {
            resultsHandler.handle(toConnectorObject(schema, group, returnAttributesSet, allowPartialAttributeValues));
            return 1;
        }
        return 0;
    }

    @Override
    public int getByName(Name name, ResultsHandler resultsHandler, OperationOptions options,
                         Set returnAttributesSet, Set fetchFieldsSet,
                         boolean allowPartialAttributeValues, int pageSize, int pageOffset) {
        AtlassianGuardGroupModel group = client.getGroup(name, options, fetchFieldsSet);

        if (group != null) {
            resultsHandler.handle(toConnectorObject(schema, group, returnAttributesSet, allowPartialAttributeValues));
            return 1;
        }
        return 0;
    }

    @Override
    public int getByMembers(Attribute attribute, ResultsHandler resultsHandler, OperationOptions options,
                            Set returnAttributesSet, Set fetchFieldSet, boolean allowPartialAttributeValues, int pageSize, int pageOffset) {
        // Unfortunately, Atlassian Guard doesn't support filter by member (It supports displayName filter only).
        // So, we need to fetch all groups.
        Set