io.gravitee.cockpit.api.command.CommandHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gravitee-cockpit-api Show documentation

There is a newer version: 3.6.3

/**
 * Copyright (C) 2015 The Gravitee team (http://gravitee.io)
 *
 * 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 io.gravitee.cockpit.api.command;

import io.reactivex.rxjava3.core.Single;

/**
 * @author Jeoffrey HAEYAERT (jeoffrey.haeyaert at graviteesource.com)
 * @author GraviteeSource Team
 */
public interface CommandHandler, R extends Reply> {
  /**
   * Returns the type of command handled by this command handler.
   * The type is used to determine the right handler to use when a command need to be handled.
   * @return the type of command handled.
   */
  Command.Type handleType();

  /**
   * Method invoked when a command of the expected {@link Command.Type} is received.
   *
   * @param command the command to handle.
   * @return the reply with a status indicating if the command has been successfully handled or not.
   */
  default Single handle(C command) {
    return Single.error(
      new RuntimeException(
        "Handle command of type " + handleType() + " is not implemented"
      )
    );
  }
}