jp.openstandia.connector.util.ObjectHandler Maven / Gradle / Ivy

Go to download
/*
 *  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.util;

import jp.openstandia.connector.github.GitHubFilter;
import org.identityconnectors.framework.common.objects.*;

import java.util.Set;

/**
 * Define handler methods for connector operations.
 *
 * @author Hiroyuki Wada
 */
public interface ObjectHandler {

    ObjectHandler setInstanceName(String instanceName);

    Uid create(Set attributes);

    Set updateDelta(Uid uid, Set modifications, OperationOptions options);

    void delete(Uid uid, OperationOptions options);

    default int getByUid(Uid uid, ResultsHandler resultsHandler, OperationOptions options,
                         Set returnAttributesSet, Set fetchFieldsSet,
                         boolean allowPartialAttributeValues, int pageSize, int pageOffset) {
        throw new UnsupportedOperationException();
    }

    default int getByName(Name name, ResultsHandler resultsHandler, OperationOptions options,
                          Set returnAttributesSet, Set fetchFieldsSet,
                          boolean allowPartialAttributeValues, int pageSize, int pageOffset) {
        throw new UnsupportedOperationException();
    }

    default int getByMembers(Attribute attribute, ResultsHandler resultsHandler, OperationOptions options,
                             Set returnAttributesSet, Set fetchFieldSet, boolean allowPartialAttributeValues, int pageSize, int pageOffset) {
        return 0;
    }

    default int getAll(ResultsHandler resultsHandler, OperationOptions options,
                       Set returnAttributesSet, Set fetchFieldsSet,
                       boolean allowPartialAttributeValues, int pageSize, int pageOffset) {
        throw new UnsupportedOperationException();
    }

    default void query(GitHubFilter filter, ResultsHandler resultsHandler, OperationOptions options) {
        throw new UnsupportedOperationException();
    }

    default  ConnectorObject toConnectorObject(SchemaDefinition schema, T user,
                                                  Set returnAttributesSet, boolean allowPartialAttributeValues) {
        ConnectorObjectBuilder builder = schema.toConnectorObjectBuilder(user, returnAttributesSet, allowPartialAttributeValues);
        return builder.build();
    }

    SchemaDefinition getSchemaDefinition();

}