summaryrefslogtreecommitdiffstats
path: root/sms-client/src/java/main/SmsInterface.java
blob: 31875d7212eeef52e406a77315f0218dcbc7d7ef (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
/*
 * Copyright 2018 Intel Corporation, Inc
 *
 * 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.
 */

package org.onap.aaf.sms;

import org.onap.aaf.sms.SmsResponse;
import java.util.Map;

public interface SmsInterface {
    /*
        Inputs dname - domain name
        Output - name and uuid
        Return SmsResponse object
            success or failure
            response code if connection succeeded, otherwise -1
            response string if expected.
    */
    public SmsResponse createDomain(String dname);

    /*
        Inputs dname - domain name
        Output - none
        Return SmsResponse object
            success or failure
            response code if connection succeeded, otherwise -1
            response string if expected.

    */
    public SmsResponse deleteDomain(String dname);

    /*
        Inputs dname - domain name
        Output - list of secret names
        Return SmsResponse object
            success or failure
            response code if connection succeeded, otherwise -1
            response string if expected.

    */
    public SmsResponse getSecretNames(String dname);

    /*
        Inputs dname - domain name
               sname - secret name
               values - list of key value pairs
        Output - none
        Return SmsResponse object
            success or failure
            response code if connection succeeded, otherwise -1
            response string if expected.

    */
    public SmsResponse storeSecret(String dname, String sname, Map<String, Object> values);

    /*
        Inputs dname - domain name
               sname - secret name
        Output values - list of value pairs
        Return SmsResponse object
            success or failure
            response code if connection succeeded, otherwise -1
            response string if expected.

    */
    public SmsResponse getSecret(String dname, String sname);

    /*
        Inputs dname - domain name
               sname - secret name
        Output - none
        Return SmsResponse object
            success or failure
            response code if connection succeeded, otherwise -1
            response string if expected.
    */
    public SmsResponse deleteSecret(String dname, String sname);
}