core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/StopEngine.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.apex.core.protocols.engdep.messages;
  22
  23 import org.onap.policy.apex.core.protocols.Message;
  24 import org.onap.policy.apex.core.protocols.engdep.EngDepAction;
  25 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
  26
  27 /**
  28  * The Class StopEngine is a message that requests that an Apex engine in an engine service be stopped.
  29  *
  30  * @author Liam Fallon (liam.fallon@ericsson.com)
  31  */
  32 public class StopEngine extends Message {
  33     private static final long serialVersionUID = 5885214410842753037L;
  34
  35     /**
  36      * Instantiates a new StopEngine message.
  37      *
  38      * @param engineKey the key of the engine to stop
  39      */
  40     public StopEngine(final AxArtifactKey engineKey) {
  41         this(engineKey, null);
  42     }
  43
  44     /**
  45      * Instantiates a new StopEngine message.
  46      *
  47      * @param engineKey the key of the engine to stop
  48      * @param messageData the message data that may give specifics on what way to stop
  49      */
  50     public StopEngine(final AxArtifactKey engineKey, final String messageData) {
  51         super(EngDepAction.STOP_ENGINE, engineKey, messageData);
  52     }
  53
  54     /**
  55      * {@inheritDoc}.
  56      */
  57     @Override
  58     public String toString() {
  59         return "StopEngine {" + super.toString() + "}[]";
  60     }
  61 }