summaryrefslogtreecommitdiffstats
path: root/saltstack-adapter/saltstack-adapter-provider/src/main/java/org/onap/ccsdk/sli/adaptors/saltstack/SaltstackAdapter.java
blob: 346910a39f328b99362ef6ea330969359f502423 (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
/*-
 * ============LICENSE_START=======================================================
 * ONAP : CCSDK
 * ================================================================================
 * Copyright (C) 2018 Samsung Electronics. 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.
 *
 *
 * ============LICENSE_END=========================================================
 */

package org.onap.ccsdk.sli.adaptors.saltstack;

import org.onap.ccsdk.sli.core.sli.SvcLogicContext;
import org.onap.ccsdk.sli.core.sli.SvcLogicException;
import org.onap.ccsdk.sli.core.sli.SvcLogicJavaPlugin;

import java.util.Map;

/**
 * This interface defines the operations that the Saltstack adapter exposes.
 */
public interface SaltstackAdapter extends SvcLogicJavaPlugin {
    /**
     * Returns the symbolic name of the adapter
     *
     * @return The adapter name
     */
    String getAdapterName();

    /* Method to post a single command request for execution on SaltState server
     *  The response from Saltstack comes in json format and it is automatically put
     *  to context for DGs access, with a certain prefix*/
    void reqExecCommand(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException;

    /* Method for execution of saltstack SLS command on SaltState server
     *  The response from Saltstack comes in json format and it is automatically put
     *  to context for DGs access, with a certain prefix*/
    void reqExecSLS(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException;

    /* When SLS file is created/available then this Method can be used to post
     *  the file to saltstack server and execute the SLS file on SaltState server
     *  The response from Saltstack comes in json format and it is automatically put
     *  to context for DGs access, with a certain prefix*/
    void reqExecSLSFile(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException;
}