artifactbroker/reception/src/main/java/org/onap/policy/distribution/reception/handling/ReceptionHandler.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 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.distribution.reception.handling;
  22
  23 import org.onap.policy.distribution.reception.decoding.PluginInitializationException;
  24 import org.onap.policy.distribution.reception.decoding.PluginTerminationException;
  25
  26 /**
  27  * Handles input into Policy Distribution which may be decoded into a Policy.
  28  */
  29 public interface ReceptionHandler {
  30
  31     /**
  32      * Initialize the reception handler with the given parameters.
  33      *
  34      * @param parameterGroupName the name of the parameter group containing the configuration for the reception handler
  35      * @throws PluginInitializationException exception if it occurs
  36      */
  37     void initialize(String parameterGroupName) throws PluginInitializationException;
  38
  39     /**
  40      * Destroy the reception handler, removing any subscriptions and releasing all resources.
  41      *
  42      * @throws PluginTerminationException if it occurs
  43      */
  44     void destroy() throws PluginTerminationException;
  45
  46 }