net.kuujo.vertigo.network.EndpointConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vertigo Show documentation

There is a newer version: 1.0.2

/*
 * 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.vertigo.network;

import io.vertx.codegen.annotations.Fluent;

/**
 * Connection endpoint.
 *
 * @author Jordan Halterman
 */
public interface EndpointConfig> extends TypeConfig {

  /**
   * component indicates the endpoint component name.
   */
  public static final String ENDPOINT_COMPONENT = "component";

  /**
   * port indicates the endpoint port.
   */
  public static final String ENDPOINT_PORT = "port";

  /**
   * port indicates the endpoint port.
   */
  public static final String ENDPOINT_IS_NETWORK = "network";

  /**
   * Returns the endpoint component.
   *
   * @return The component name.
   */
  String getComponent();

  /**
   * Sets the endpoint component.
   *
   * @param component The endpoint component.
   * @return The endpoint partition.
   */
  @Fluent
  @SuppressWarnings("unchecked")
  T setComponent(String component);

  /**
   * Returns the endpoint port.
   *
   * @return The endpoint port.
   */
  String getPort();

  /**
   * Sets the endpoint port.
   *
   * @param port The endpoint port.
   * @return The endpoint partition.
   */
  @Fluent
  @SuppressWarnings("unchecked")
  T setPort(String port);

  /**
   * Sets the endpoint to the network rather than a component
   */
  T setIsNetwork(boolean isNetwork);

  /**
   * Returns whether the endpoint is the network itself
   * @return whether the endpoint is the network itself
   */
  Boolean getIsNetwork();

}