artifactbroker/forwarding/src/main/java/org/onap/policy/distribution/forwarding/ArtifactForwarder.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.forwarding;
  22
  23 import java.util.Collection;
  24 import org.onap.sdc.api.notification.IArtifactInfo;
  25
  26 /**
  27  * Forwards polices.
  28  *
  29  * <p>To create a Artifact forwarder a class implementing this interface must be created, along with a
  30  * concrete sub class of ArtifactForwarderConfigurationParameterGroup to handle configuration
  31  * parameters for the Artifact forwarder.
  32  */
  33 public interface ArtifactForwarder {
  34
  35     /**
  36      * Configure the Artifact forwarder.
  37      *
  38      * <p>This method will be invoked immediately after instantiation in order for the Artifact forwarder
  39      * to configure itself.
  40      *
  41      * @param parameterGroupName the name of the parameter group which contains the configuration
  42      *        for the Artifact forwarder
  43      */
  44     void configure(String parameterGroupName);
  45
  46     /**
  47      * Forward the given policies.
  48      *
  49      * @param policies the policies to forward
  50      * @throws ArtifactForwardingException if an error occurs when forwarding the given Artifact
  51      */
  52     void forward(Collection<IArtifactInfo> artifacts) throws ArtifactForwardingException;
  53
  54 }