ratis-client/src/main/java/org/apache/ratis/client/ClientFactory.java

/**
 * 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.ratis.client;

import org.apache.ratis.conf.RaftProperties;
import org.apache.ratis.protocol.ClientId;
import org.apache.ratis.rpc.RpcFactory;

/** A factory interface for creating client components. */
public interface ClientFactory extends RpcFactory {
  static ClientFactory cast(RpcFactory rpcFactory) {
    if (rpcFactory instanceof ClientFactory) {
      return (ClientFactory)rpcFactory;
    }
    throw new ClassCastException("Cannot cast " + rpcFactory.getClass()
        + " to " + ClientFactory.class
        + "; rpc type is " + rpcFactory.getRpcType());
  }

  /** Create a {@link RaftClientRpc}. */
  RaftClientRpc newRaftClientRpc(ClientId clientId, RaftProperties properties);
}