org.opendaylight.jsonrpc.impl.RemoteShardAware Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jsonrpc-provider-common Show documentation
The newest version!
/*
 * Copyright (c) 2018 Lumina Networks, Inc. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.jsonrpc.impl;

import com.google.gson.JsonElement;
import java.net.URISyntaxException;
import java.util.function.Supplier;
import org.opendaylight.jsonrpc.bus.messagelib.TransportFactory;
import org.opendaylight.jsonrpc.dom.codec.JsonRpcCodecFactory;
import org.opendaylight.jsonrpc.hmap.DataType;
import org.opendaylight.jsonrpc.hmap.HierarchicalEnumMap;
import org.opendaylight.jsonrpc.model.RemoteOmShard;
import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
import org.opendaylight.yang.gen.v1.urn.opendaylight.jsonrpc.rev161201.Peer;
import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;

/**
 * This class holds common code for getting {@link RemoteOmShard} instances used
 * in {@link JsonRPCTx} and {@link JsonRPCDataBroker}.
 *
 * @author Richard Kosegi
 * @since May 6, 2018
 */
abstract class RemoteShardAware extends AbstractJsonRPCComponent implements AutoCloseable {
    private static final String SHARD_NOT_AVAILABLE = "[%s] : Datastore mapping does not exists "
            + "for store '%s'at path '%s'.Make sure that requested path is within configured data endpoints "
            + "or governance is aware of such path.";

    RemoteShardAware(EffectiveModelContext schemaContext, TransportFactory transportFactory,
            HierarchicalEnumMap pathMap, JsonRpcCodecFactory codecFactory, Peer peer) {
        super(schemaContext, transportFactory, pathMap, codecFactory, peer);
    }

    protected RemoteOmShard getShard(String endpoint) {
        try {
            return transportFactory.endpointBuilder().requester().createProxy(RemoteOmShard.class, endpoint);
        } catch (URISyntaxException e) {
            throw new IllegalStateException(e);
        }
    }

    protected RemoteOmShard getShard(final LogicalDatastoreType store, final JsonElement path) {
        return getShard(lookupEndPoint(store, path));
    }

    protected String lookupEndPoint(final LogicalDatastoreType store, final JsonElement path) {
        return pathMap.lookup(path, DataType.forDatastore(store)).orElseThrow(shardNotAvailable(store, path));
    }

    /**
     * Provide human readable error when mapping for requested datastore/path does not exists.
     *
     * @param store datastore that is subject to current data operation
     * @param path that is subject to current data operation
     * @return {@link Supplier} that provides {@link IllegalArgumentException}
     */
    private Supplier shardNotAvailable(final LogicalDatastoreType store,
            final JsonElement path) {
        return () -> new IllegalArgumentException(String.format(SHARD_NOT_AVAILABLE, peer.getName(), store, path));
    }

    @Override
    public void close() {
        // NOOP
    }
}