net.kuujo.copycat.protocol.Protocol Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of copycat-core Show documentation

The newest version!

/*
 * Copyright 2014 the original author or authors.
 *
 * 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 net.kuujo.copycat.protocol;

import net.kuujo.copycat.util.Configurable;

import java.net.URI;

/**
 * Communication protocol.
 *
 * @author Jordan Halterman
 */
public interface Protocol extends Configurable {

  /**
   * Returns a boolean indicating whether the given URI is valid.
   *
   * @param uri The member URI to validate.
   * @return Indicates whether the given URI is valid.
   */
  default boolean isValidUri(URI uri) {
    return true;
  }

  /**
   * Creates a new protocol client.
   *
   * @param uri The member URI.
   * @return The protocol client.
   */
  ProtocolClient createClient(URI uri);

  /**
   * Creates a new protocol server.
   *
   * @param uri The member URI.
   * @return The protocol server.
   */
  ProtocolServer createServer(URI uri);

}