blob: 0d2927ec3c0f9a0caa710d721bb26dee7776f9b4 (
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
/*-
* ============LICENSE_START=======================================================
* openECOMP : APP-C
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. 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.openecomp.appc.dg.ssh;
import java.util.Map;
import org.openecomp.appc.exceptions.APPCException;
import org.openecomp.sdnc.sli.SvcLogicContext;
import org.openecomp.sdnc.sli.SvcLogicJavaPlugin;
/**
* Set of common methods that can be called from DG.
*/
public interface SshService extends SvcLogicJavaPlugin {
/**
* Input parameter for SHH connection details
*/
String PARAM_IN_connection_details = "connection_details";
/**
* Input parameter for SSH command to be executed.
*/
String PARAM_IN_command = "command";
/*
String PARAM_IN_host = "host";
String PARAM_IN_port = "port";
String PARAM_IN_username = "username";
String PARAM_IN_password = "password";
*/
/**
* Input parameter for SSH command timeout
*/
String PARAM_IN_timeout = "timeout";
/**
* Output parameter - SSH command execution status.
*/
String PARAM_OUT_status = "status";
/**
* Output parameter - content of SSH command stdout.
*/
String PARAM_OUT_stdout = "stdout";
/**
* Output parameter - content of SSH command stderr.
*/
String PARAM_OUT_stderr = "stderr";
/**
* Default SSH connection port.
*/
int DEF_port = 22;
/**
* Default SSH command timeout
*/
long DEF_timeout = 120000;
/**
* Default success status.
*/
int DEF_SUCCESS_STATUS = 0;
/**
* Execute remote command over SSH.
*
* @param params contains list of input parameters required for the implementation
* @param ctx SLI service logic context
* @throws APPCException
*/
void exec(Map<String, String> params, SvcLogicContext ctx) throws APPCException;
/**
* Execute remote command over SSH and check return status assuming that success status is 0.
* If non-zero status is returned - fail the execution by throwing exception with content written
* by command to stderr.
*
* @param params contains list of input parameters required for the implementation
* @param ctx SLI service logic context
* @throws APPCException
*/
void execWithStatusCheck(Map<String, String> params, SvcLogicContext ctx) throws APPCException;
}
|
