com.clearlydecoded.messenger.MessageProcessorRegistry 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.util.List;

/**
 * {@link MessageProcessorRegistry} interface defines methods for adding, removing, and retrieving
 * {@link MessageProcessor}s based on the type of the {@link Message}.
 *
 * @author Yaakov Chaikin ([email protected])
 */
public interface MessageProcessorRegistry {

  /**
   * Adds processor to the message processor registry.
   *
   * @param processor Message processor to add to the message processor registry.
   */
  void addProcessor(MessageProcessor,
      ? extends MessageResponse> processor);

  /**
   * Adds processors to the message processor registry.
   *
   * @param processors List of message processors to add to the message processor registry.
   */
  void addProcessors(List,
      ? extends MessageResponse>> processors);

  /**
   * Retrieves a concrete {@link MessageProcessor} for the type of the message. If not found,
   * returns null.
   *
   * @param messageType Message type identifier that is unique system-wide.
   * @return An instance of a concrete implementation of {@link MessageProcessor} based on the
   * messageType. If no processor is found for the message type, returns
   * null.
   */
  MessageProcessor,
      ? extends MessageResponse> getProcessorFor(String messageType);

  /**
   * Removes message processor which is identified by the messageType from the message
   * processor registry.
   *
   * @param messageType Message type identifier that is unique system-wide.
   */
  void removeProcessor(String messageType);

  /**
   * Retrieve all message processors successfully registered in the message processor registry.
   *
   * @return List of successfully discovered and registered message processors. If none are
   * registered, returns an empty list.
   */
  List,
      ? extends MessageResponse>> getProcessors();
}