io.vlingo.cluster.model.message.OperationalMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vlingo-cluster Show documentation
Cluster management for reactive, scalable resiliency of JVM tools and applications running on VLINGO XOOM Actors.
There is a newer version: 1.7.5
// Copyright © 2012-2020 VLINGO LABS. All rights reserved.
//
// This Source Code Form is subject to the terms of the
// Mozilla Public License, v. 2.0. If a copy of the MPL
// was not distributed with this file, You can obtain
// one at https://mozilla.org/MPL/2.0/.

package io.vlingo.cluster.model.message;

import io.vlingo.wire.message.Message;
import io.vlingo.wire.node.Id;

public abstract class OperationalMessage implements Message {

  /**
   * APP<lf>id=x nm=name si=y<lf>...
   */
  public static final String APP = "APP";

  /**
   * CHECKHEALTH<lf>id=x ***internal only*** to check health
   */
  public static final String CHECKHEALTH = "CHECKHEALTH";

  /**
   * DIR<lf>id=x nm=name<lf>addr=...<lf>...
   */
  public static final String DIR = "DIR";

  /**
   * ELECT<lf>id=x an election is required
   */
  public static final String ELECT = "ELECT";

  /**
   * JOIN<lf>addr=... node joining cluster
   */
  public static final String JOIN = "JOIN";

  /**
   * LEADER<lf>id=x declare self as leader (highest existing node)
   */
  public static final String LEADER = "LEADER";

  /**
   * LEAVE<lf>id=x announce that node is leaving the cluster
   */
  public static final String LEAVE = "LEAVE";

  /**
   * PING<lf>id=x leader sends ping to follower to determine if it is alive
   */
  public static final String PING = "PING";

  /**
   * PULSE<lf>id=x follower sends pulse to leader
   */
  public static final String PULSE = "PULSE";

  /**
   * SPLIT<lf>id=x inform receiving node that it is split from known leader
   */
  public static final String SPLIT = "SPLIT";

  /**
   * VOTE<lf>id=x a vote is made by all higher nodes
   */
  public static final String VOTE = "VOTE";

  /**
   * Answer a new concrete OperationalMessage from the content.
   * @param content the String containing the message text
   * @return OperationalMessage
   */
  public static OperationalMessage messageFrom(final String content) {
    if (content.startsWith(APP)) {
      return ApplicationSays.from(content);
    } else if (content.startsWith(DIR)) {
      return Directory.from(content);
    } else if (content.startsWith(ELECT)) {
      return Elect.from(content);
    } else if (content.startsWith(JOIN)) {
      return Join.from(content);
    } else if (content.startsWith(LEADER)) {
      return Leader.from(content);
    } else if (content.startsWith(LEAVE)) {
      return Leave.from(content);
    } else if (content.startsWith(PING)) {
      return Ping.from(content);
    } else if (content.startsWith(PULSE)) {
      return Pulse.from(content);
    } else if (content.startsWith(SPLIT)) {
      return Split.from(content);
    } else if (content.startsWith(VOTE)) {
      return Vote.from(content);
    }
    return null;
  }

  protected final Id id;

  public boolean isApp() {
    return false;
  }

  public boolean isDirectory() {
    return false;
  }

  public boolean isElect() {
    return false;
  }

  public boolean isCheckHealth() {
    return false;
  }

  public boolean isJoin() {
    return false;
  }

  public boolean isLeader() {
    return false;
  }

  public boolean isLeave() {
    return false;
  }

  public boolean isPing() {
    return false;
  }

  public boolean isPulse() {
    return false;
  }

  public boolean isSplit() {
    return false;
  }

  public boolean isVote() {
    return false;
  }

  public final Id id() {
    return id;
  }

  protected OperationalMessage(final Id id) {
    this.id = id;
  }
}