com.clearlydecoded.messenger.Message Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-messenger Show documentation

Easily create and expose a Spring REST-based API implementation, without losing strong Java message typing, improving simplicity and robustness of your implementations. It's so easy to use, you can start implementing your production APIs in under 5 minutes.

There is a newer version: 2.2.2

Show newest version

/*
 * Copyright 2018 Yaakov Chaikin ([email protected]). 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 com.clearlydecoded.messenger;

import java.io.Serializable;

/**
 * {@link Message} interface represents a message the system can process. It should contain the
 * necessary data for the message processor to process this message. The only required property for
 * any message is type.
 *
 * @author Yaakov Chaikin ([email protected])
 */
public interface Message extends Serializable {

  /**
   * Getter for string-based message type identifier.
   * 
   * Warning! Message type identifier should not be settable outside of this class. It should
   * be read-only, i.e., immutable. It's recommended that its internal declaration be marked
   * final.
   * 
   *
   * @return Message type identifier that is unique system-wide.
   */
  String getType();
}