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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
/*-
* ============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.adapter.rest;
import java.util.Map;
import org.openecomp.appc.exceptions.APPCException;
import com.att.cdp.zones.model.Server;
import org.openecomp.sdnc.sli.SvcLogicContext;
import org.openecomp.sdnc.sli.SvcLogicJavaPlugin;
/**
* This interface defines the operations that the provider adapter exposes.
* <p>
* This interface defines static constant property values that can be used to configure the adapter. These constants are
* prefixed with the name PROPERTY_ to indicate that they are configuration properties. These properties are read from
* the configuration file for the adapter and are used to define the providers, identity service URLs, and other
* information needed by the adapter to interface with an IaaS provider.
* </p>
*/
public interface RestAdapter extends SvcLogicJavaPlugin {
/**
* The type of provider to be accessed to locate and operate on a virtual machine instance. This is used to load the
* correct provider support through the CDP IaaS abstraction layer and can be OpenStackProvider, BareMetalProvider,
* or any other supported provider type.
*/
static final String PROPERTY_PROVIDER_TYPE = "org.openecomp.appc.provider.type";
/**
* The adapter maintains a cache of providers organized by the name of the provider, not its type. This is
* equivalent to the system or installation name. All regions within the same installation are assumed to be the
* same type.
*/
static final String PROPERTY_PROVIDER_NAME = "org.openecomp.appc.provider.name";
/**
* The fully-qualified URL of the instance to be manipulated as it is known to the provider.
*/
static final String PROPERTY_INSTANCE_URL = "org.openecomp.appc.instance.url";
/**
* The fully-qualified URL of the instance to be manipulated as it is known to the provider.
*/
static final String PROPERTY_IDENTITY_URL = "org.openecomp.appc.identity.url";
/**
* This method is used to restart an existing virtual machine given the fully qualified URL of the machine.
* <p>
* This method is invoked from a directed graph as an <code>Executor</code> node. This means that the parameters
* passed to the method are passed as properties in a map. This method expects the following properties to be
* defined:
* <dl>
* <dt>org.openecomp.appc.provider.type</dt>
* <dd>The appropriate provider type, such as <code>OpenStackProvider</code>. This is used by the CDP IaaS
* abstraction layer to dynamically load and open a connection to the appropriate provider type. All CDP supported
* provider types are legal.</dd>
* <dt>org.openecomp.appc.instance.url</dt>
* <dd>The fully qualified URL of the instance to be restarted, as it is known to the provider (i.e., the self-link
* URL of the server)</dd>
* </dl>
* </p>
*
* @param properties
* A map of name-value pairs that supply the parameters needed by this method. The properties needed are
* defined above.
* @param context
* The service logic context of the graph being executed.
* @return The <code>Server</code> object that represents the VM being restarted. The returned server object can be
* inspected for the final state of the server once the restart has been completed. The method does not
* return until the restart has either completed or has failed.
* @throws APPCException
* If the server cannot be restarted for some reason
*/
// Server restartServer(Map<String, String> properties, SvcLogicContext context) throws APPCException;
/**
* This method is used to stop the indicated server
* <p>
* This method is invoked from a directed graph as an <code>Executor</code> node. This means that the parameters
* passed to the method are passed as properties in a map. This method expects the following properties to be
* defined:
* <dl>
* <dt>org.openecomp.appc.provider.type</dt>
* <dd>The appropriate provider type, such as <code>OpenStackProvider</code>. This is used by the CDP IaaS
* abstraction layer to dynamically load and open a connection to the appropriate provider type. All CDP supported
* provider types are legal.</dd>
* <dt>org.openecomp.appc.instance.url</dt>
* <dd>The fully qualified URL of the instance to be stopped, as it is known to the provider (i.e., the self-link
* URL of the server)</dd>
* </dl>
* </p>
*
* @param properties
* A map of name-value pairs that supply the parameters needed by this method. The properties needed are
* defined above.
* @param context
* The service logic context of the graph being executed.
* @return The <code>Server</code> object that represents the VM being stopped. The returned server object can be
* inspected for the final state of the server once the stop has been completed. The method does not return
* until the stop has either completed or has failed.
* @throws APPCException
* If the server cannot be stopped for some reason
*/
//Server stopServer(Map<String, String> properties, SvcLogicContext context) throws APPCException;
/**
* This method is used to start the indicated server
* <p>
* This method is invoked from a directed graph as an <code>Executor</code> node. This means that the parameters
* passed to the method are passed as properties in a map. This method expects the following properties to be
* defined:
* <dl>
* <dt>org.openecomp.appc.provider.type</dt>
* <dd>The appropriate provider type, such as <code>OpenStackProvider</code>. This is used by the CDP IaaS
* abstraction layer to dynamically load and open a connection to the appropriate provider type. All CDP supported
* provider types are legal.</dd>
* <dt>org.openecomp.appc.instance.url</dt>
* <dd>The fully qualified URL of the instance to be started, as it is known to the provider (i.e., the self-link
* URL of the server)</dd>
* </dl>
* </p>
*
* @param properties
* A map of name-value pairs that supply the parameters needed by this method. The properties needed are
* defined above.
* @param context
* The service logic context of the graph being executed.
* @return The <code>Server</code> object that represents the VM being started. The returned server object can be
* inspected for the final state of the server once the start has been completed. The method does not return
* until the start has either completed or has failed.
* @throws APPCException
* If the server cannot be started for some reason
*/
// Server startServer(Map<String, String> properties, SvcLogicContext context) throws APPCException;
/**
* This method is used to rebuild the indicated server
* <p>
* This method is invoked from a directed graph as an <code>Executor</code> node. This means that the parameters
* passed to the method are passed as properties in a map. This method expects the following properties to be
* defined:
* <dl>
* <dt>org.openecomp.appc.provider.type</dt>
* <dd>The appropriate provider type, such as <code>OpenStackProvider</code>. This is used by the CDP IaaS
* abstraction layer to dynamically load and open a connection to the appropriate provider type. All CDP supported
* provider types are legal.</dd>
* <dt>org.openecomp.appc.instance.url</dt>
* <dd>The fully qualified URL of the instance to be rebuilt, as it is known to the provider (i.e., the self-link
* URL of the server)</dd>
* </dl>
* </p>
*
* @param properties
* A map of name-value pairs that supply the parameters needed by this method. The properties needed are
* defined above.
* @param context
* The service logic context of the graph being executed.
* @return The <code>Server</code> object that represents the VM being rebuilt. The returned server object can be
* inspected for the final state of the server once the rebuild has been completed. The method does not
* return until the rebuild has either completed or has failed.
* @throws APPCException
* If the server cannot be rebuilt for some reason
*/
// Server rebuildServer(Map<String, String> properties, SvcLogicContext context) throws APPCException;
/**
* Returns the symbolic name of the adapter
*
* @return The adapter name
*/
String getAdapterName();
// Server evacuateServer(Map<String, String> params, SvcLogicContext ctx) throws APPCException;
//Server migrateServer(Map<String, String> params, SvcLogicContext ctx) throws APPCException;
void commonGet(Map<String, String> params, SvcLogicContext ctx) ;
void commonPost(Map<String, String> params, SvcLogicContext ctx) ;
void commonPut(Map<String, String> params, SvcLogicContext ctx) ;
void commonDelete(Map<String, String> params, SvcLogicContext ctx) ;
}
|
