/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2018 Ericsson. All rights reserved.
 * ================================================================================
 * 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.
 * 
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.distribution.forwarding;

import java.util.Collection;
import org.onap.sdc.api.notification.IArtifactInfo;
import org.onap.policy.distribution.model.PolicyInput;

/**
 * Forwards polices.
 * 
 * <p>To create a Artifact forwarder a class implementing this interface must be created, along with a
 * concrete sub class of ArtifactForwarderConfigurationParameterGroup to handle configuration
 * parameters for the Artifact forwarder.
 */
public interface ArtifactForwarder {

    /**
     * Configure the Artifact forwarder.
     * 
     * <p>This method will be invoked immediately after instantiation in order for the Artifact forwarder
     * to configure itself.
     * 
     * @param parameterGroupName the name of the parameter group which contains the configuration
     *        for the Artifact forwarder
     */
    void configure(String parameterGroupName);

    /**
     * Forward the given policies.
     * 
     * @param policies the policies to forward
     * @throws ArtifactForwardingException if an error occurs when forwarding the given Artifact
     */
    void forward(PolicyInput policyInput) throws ArtifactForwardingException;

}