blob: 0415020529c4ee65d56d0fa1a6109e0d7500191c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
/*-
* ============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.reception.decoding;
import java.util.Collection;
import org.onap.policy.distribution.model.PolicyInput;
import org.onap.policy.models.tosca.authorative.concepts.ToscaEntity;
/**
* Decodes polices from a given input.
*
* @param <T> the type of policy that will be created
* @param <S> the type of input to be decoded
*/
public interface PolicyDecoder<S extends PolicyInput, T extends ToscaEntity> {
/**
* Configure the policy decoder. This method will be invoked immediately after instantiation in order for the policy
* decoder to configure itself.
*
* @param parameterGroupName the name of the parameter group which contains the configuration for the policy decoder
*/
void configure(String parameterGroupName);
/**
* Can the decoder handle input of the specified type.
*
* @param policyInput the type
* @return <code>true</code> if the decoder can handle the specified type
*/
boolean canHandle(PolicyInput policyInput);
/**
* Decode policies from the given input.
*
* @param input the input
* @return the generated policies
* @throws PolicyDecodingException if an error occurs during decoding
*/
Collection<T> decode(S input) throws PolicyDecodingException;
}
|
