* 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.
import com.sun.jersey.api.client.config.ClientConfig;
import com.sun.jersey.api.client.config.DefaultClientConfig;
import com.sun.jersey.api.client.filter.HTTPBasicAuthFilter;
+import com.sun.jersey.api.client.filter.HTTPDigestAuthFilter;
+import com.sun.jersey.oauth.client.OAuthClientFilter;
+import com.sun.jersey.oauth.signature.OAuthParameters;
+import com.sun.jersey.oauth.signature.OAuthSecrets;
import com.sun.jersey.client.urlconnection.HTTPSProperties;
public class RestapiCallNode implements SvcLogicJavaPlugin {
/**
* Allows Directed Graphs the ability to interact with REST APIs.
- * @param parameters HashMap<String,String> of parameters passed by the DG to this function
+ * @param paramMap HashMap<String,String> of parameters passed by the DG to this function
* <table border="1">
* <thead><th>parameter</th><th>Mandatory/Optional</th><th>description</th><th>example values</th></thead>
* <tbody>
* <tr><td>restapiUrl</td><td>Mandatory</td><td>url to send the request to</td><td>https://sdncodl:8543/restconf/operations/L3VNF-API:create-update-vnf-request</td></tr>
* <tr><td>restapiUser</td><td>Optional</td><td>user name to use for http basic authentication</td><td>sdnc_ws</td></tr>
* <tr><td>restapiPassword</td><td>Optional</td><td>unencrypted password to use for http basic authentication</td><td>plain_password</td></tr>
+ * <tr><td>oAuthConsumerKey</td><td>Optional</td><td>Consumer key to use for http oAuth authentication</td><td>plain_key</td></tr>
+ * <tr><td>oAuthConsumerSecret</td><td>Optional</td><td>Consumer secret to use for http oAuth authentication</td><td>plain_secret</td></tr>
+ * <tr><td>oAuthSignatureMethod</td><td>Optional</td><td>Consumer method to use for http oAuth authentication</td><td>method</td></tr>
+ * <tr><td>oAuthVersion</td><td>Optional</td><td>Version http oAuth authentication</td><td>version</td></tr>
* <tr><td>contentType</td><td>Optional</td><td>http content type to set in the http header</td><td>usually application/json or application/xml</td></tr>
* <tr><td>format</td><td>Optional</td><td>should match request body format</td><td>json or xml</td></tr>
* <tr><td>httpMethod</td><td>Optional</td><td>http method to use when sending the request</td><td>get post put delete patch</td></tr>
* <tr><td>customHttpHeaders</td><td>Optional</td><td>a list additional http headers to be passed in, follow the format in the example</td><td>X-CSI-MessageId=messageId,headerFieldName=headerFieldValue</td></tr>
* <tr><td>dumpHeaders</td><td>Optional</td><td>when true writes http header content to context memory</td><td>true or false</td></tr>
* <tr><td>partner</td><td>Optional</td><td>needed for DME2 calls</td><td>dme2proxy</td></tr>
+ * <tr><td>returnRequestPayload</td><td>Optional</td><td>used to return payload built in the request</td><td>true or false</td></tr>
* </tbody>
* </table>
* @param ctx Reference to context memory
if (p.templateFileName != null) {
String reqTemplate = readFile(p.templateFileName);
req = buildXmlJsonRequest(ctx, reqTemplate, p.format);
+ } else if (p.requestBody != null) {
+ req = p.requestBody;
}
r = sendHttpRequest(req, p);
setResponseStatus(ctx, p.responsePrefix, r);
ctx.setAttribute(pp + "header." + a.getKey(), StringUtils.join(a.getValue(), ","));
}
}
+
+ if (p.returnRequestPayload && req != null) {
+ ctx.setAttribute(pp + "httpRequest", req);
+ }
if (r.body != null && r.body.trim().length() > 0) {
ctx.setAttribute(pp + "httpResponse", r.body);
ctx.setAttribute(pp + entry.getKey(), entry.getValue());
}
}
- } catch (SvcLogicException | JSONException e) {
+ } catch (SvcLogicException e) {
boolean shouldRetry = false;
if (e.getCause().getCause() instanceof SocketException) {
shouldRetry = true;
URI retryUri = UriBuilder.fromUri(uri).host(uriTwo.getHost()).port(uriTwo.getPort()).scheme(
uriTwo.getScheme()).build();
paramMap.put("restapiUrl", retryUri.toString());
- log.debug("URL was set to " + retryUri.toString());
- log.debug("Failed to communicate with host " + hostname +
- ". Request will be re-attempted using the host " + retryString + ".");
- log.debug("This is retry attempt " + retryCount + " out of " + retryPolicy.getMaximumRetries());
+ log.debug("URL was set to {}", retryUri.toString());
+ log.debug("Failed to communicate with host {}. Request will be re-attempted using the host {}.",
+ hostname, retryString);
+ log.debug("This is retry attempt {} out of {}", retryCount, retryPolicy.getMaximumRetries());
sendRequest(paramMap, ctx, retryCount);
} else {
log.debug("Maximum retries reached, calling setFailureResponseStatus.");
protected Parameters getParameters(Map<String, String> paramMap) throws SvcLogicException {
Parameters p = new Parameters();
p.templateFileName = parseParam(paramMap, "templateFileName", false, null);
+ p.requestBody = parseParam(paramMap, "requestBody", false, null);
p.restapiUrl = parseParam(paramMap, "restapiUrl", true, null);
+ validateUrl(p.restapiUrl);
p.restapiUser = parseParam(paramMap, "restapiUser", false, null);
p.restapiPassword = parseParam(paramMap, "restapiPassword", false, null);
+ p.oAuthConsumerKey = parseParam(paramMap, "oAuthConsumerKey", false, null);
+ p.oAuthConsumerSecret = parseParam(paramMap, "oAuthConsumerSecret", false, null);
+ p.oAuthSignatureMethod = parseParam(paramMap, "oAuthSignatureMethod", false, null);
+ p.oAuthVersion = parseParam(paramMap, "oAuthVersion", false, null);
p.contentType = parseParam(paramMap, "contentType", false, null);
p.format = Format.fromString(parseParam(paramMap, "format", false, "json"));
+ p.authtype = AuthType.fromString(parseParam(paramMap, "authType", false, "unspecified"));
p.httpMethod = HttpMethod.fromString(parseParam(paramMap, "httpMethod", false, "post"));
p.responsePrefix = parseParam(paramMap, "responsePrefix", false, null);
p.listNameList = getListNameList(paramMap);
p.customHttpHeaders = parseParam(paramMap, "customHttpHeaders", false, null);
p.partner = parseParam(paramMap, "partner", false, null);
p.dumpHeaders = Boolean.valueOf(parseParam(paramMap, "dumpHeaders", false, null));
+ p.returnRequestPayload = Boolean.valueOf(parseParam(paramMap, "returnRequestPayload", false, null));
return p;
}
+ private void validateUrl(String restapiUrl) throws SvcLogicException {
+ try {
+ URI.create(restapiUrl);
+ } catch (IllegalArgumentException e) {
+ throw new SvcLogicException("Invalid input of url " + e.getLocalizedMessage(), e);
+ }
+ }
+
protected Set<String> getListNameList(Map<String, String> paramMap) {
Set<String> ll = new HashSet<>();
for (Map.Entry<String,String> entry : paramMap.entrySet())
}
s = s.trim();
- String value = "";
+ StringBuilder value = new StringBuilder();
int i = 0;
int i1 = s.indexOf('%');
while (i1 >= 0) {
if (varValue == null)
varValue = "%" + varName + "%";
- value += s.substring(i, i1);
- value += varValue;
+ value.append(s.substring(i, i1));
+ value.append(varValue);
i = i2 + 1;
i1 = s.indexOf('%', i);
}
- value += s.substring(i);
+ value.append(s.substring(i));
- log.info("Parameter " + name + ": [" + value + "]");
- return value;
+ log.info("Parameter {}: [{}]", name, value);
+ return value.toString();
}
protected String buildXmlJsonRequest(SvcLogicContext ctx, String template, Format format)
throws SvcLogicException {
- log.info("Building " + format + " started");
+ log.info("Building {} started", format);
long t1 = System.currentTimeMillis();
template = expandRepeats(ctx, template, 1);
req = XmlJsonUtil.removeLastCommaJson(req);
long t2 = System.currentTimeMillis();
- log.info("Building " + format + " completed. Time: " + (t2 - t1));
+ log.info("Building {} completed. Time: {}", format, (t2 - t1));
return req;
}
String var1 = template.substring(i1 + 9, i2);
String value1 = ctx.getAttribute(var1);
- log.info(" " + var1 + ": " + value1);
+ log.info(" {}:{}", var1, value1);
int n = 0;
try {
n = Integer.parseInt(value1);
} catch (NumberFormatException e) {
- throw new SvcLogicException("Invalid input of repeat interval, should be an integer value " +
- e.getLocalizedMessage(), e);
+ log.info("value1 not set or not a number, n will remain set at zero");
}
newTemplate.append(template.substring(k, i1));
}
}
+ protected Client addAuthType(Client c, FileParam fp) throws SvcLogicException {
+ Parameters p = new Parameters();
+ p.restapiUser = fp.user;
+ p.restapiPassword = fp.password;
+ p.oAuthConsumerKey = fp.oAuthConsumerKey;
+ p.oAuthVersion = fp.oAuthVersion;
+ p.oAuthConsumerSecret = fp.oAuthConsumerSecret;
+ p.oAuthSignatureMethod = fp.oAuthSignatureMethod;
+ p.authtype = fp.authtype;
+ return addAuthType(c,p);
+ }
+
+ protected Client addAuthType(Client client, Parameters p) throws SvcLogicException {
+ if (p.authtype == AuthType.Unspecified){
+ if (p.restapiUser != null && p.restapiPassword != null)
+ client.addFilter(new HTTPBasicAuthFilter(p.restapiUser, p.restapiPassword));
+ else if(p.oAuthConsumerKey != null && p.oAuthConsumerSecret != null
+ && p.oAuthSignatureMethod != null) {
+ OAuthParameters params = new OAuthParameters()
+ .signatureMethod(p.oAuthSignatureMethod)
+ .consumerKey(p.oAuthConsumerKey)
+ .version(p.oAuthVersion);
+
+ OAuthSecrets secrets = new OAuthSecrets()
+ .consumerSecret(p.oAuthConsumerSecret);
+ client.addFilter(new OAuthClientFilter(client.getProviders(), params, secrets));
+ }
+ } else {
+ if (p.authtype == AuthType.DIGEST) {
+ if (p.restapiUser != null && p.restapiPassword != null) {
+ client.addFilter(new HTTPDigestAuthFilter(p.restapiUser, p.restapiPassword));
+ } else {
+ throw new SvcLogicException("oAUTH authentication type selected but all restapiUser and restapiPassword " +
+ "parameters doesn't exist", new Throwable());
+ }
+ } else if (p.authtype == AuthType.BASIC){
+ if (p.restapiUser != null && p.restapiPassword != null) {
+ client.addFilter(new HTTPBasicAuthFilter(p.restapiUser, p.restapiPassword));
+ } else {
+ throw new SvcLogicException("oAUTH authentication type selected but all restapiUser and restapiPassword " +
+ "parameters doesn't exist", new Throwable());
+ }
+ } else if(p.authtype == AuthType.OAUTH ) {
+ if(p.oAuthConsumerKey != null && p.oAuthConsumerSecret != null && p.oAuthSignatureMethod != null) {
+ OAuthParameters params = new OAuthParameters()
+ .signatureMethod(p.oAuthSignatureMethod)
+ .consumerKey(p.oAuthConsumerKey)
+ .version(p.oAuthVersion);
+
+ OAuthSecrets secrets = new OAuthSecrets()
+ .consumerSecret(p.oAuthConsumerSecret);
+ client.addFilter(new OAuthClientFilter(client.getProviders(), params, secrets));
+ } else {
+ throw new SvcLogicException("oAUTH authentication type selected but all oAuthConsumerKey, oAuthConsumerSecret " +
+ "and oAuthSignatureMethod parameters doesn't exist", new Throwable());
+ }
+ }
+ }
+ return client;
+ }
+
protected HttpResponse sendHttpRequest(String request, Parameters p) throws SvcLogicException {
ClientConfig config = new DefaultClientConfig();
Client client = Client.create(config);
client.setConnectTimeout(5000);
- if (p.restapiUser != null)
- client.addFilter(new HTTPBasicAuthFilter(p.restapiUser, p.restapiPassword));
- WebResource webResource = client.resource(p.restapiUrl);
+ WebResource webResource = addAuthType(client,p).resource(p.restapiUrl);
log.info("Sending request:");
log.info(request);
}
WebResource.Builder webResourceBuilder = webResource.accept(tt).type(tt1);
+ if(p.format == Format.NONE){
+ webResourceBuilder = webResource.header("","");
+ }
if (p.customHttpHeaders != null && p.customHttpHeaders.length() > 0) {
String[] keyValuePairs = p.customHttpHeaders.split(",");
}
long t2 = System.currentTimeMillis();
- log.info("Response received. Time: " + (t2 - t1));
- log.info("HTTP response code: " + r.code);
- log.info("HTTP response message: " + r.message);
+ log.info("Response received. Time: {}", (t2 - t1));
+ log.info("HTTP response code: {}", r.code);
+ log.info("HTTP response message: {}", r.message);
logHeaders(r.headers);
- log.info("HTTP response: " + r.body);
+ log.info("HTTP response: {}", r.body);
return r;
}
ctx.init(kmf.getKeyManagers(), null, null);
return ctx;
} catch (Exception e) {
- log.error("Error creating SSLContext: " + e.getMessage(), e);
+ log.error("Error creating SSLContext: {}", e.getMessage(), e);
}
return null;
}
setResponseStatus(ctx, p.responsePrefix, r);
} catch (SvcLogicException | IOException e) {
- log.error("Error sending the request: " + e.getMessage(), e);
+ log.error("Error sending the request: {}", e.getMessage(), e);
r = new HttpResponse();
r.code = 500;
public HttpMethod httpMethod;
public String responsePrefix;
public boolean skipSending;
+ public String oAuthConsumerKey;
+ public String oAuthConsumerSecret;
+ public String oAuthSignatureMethod;
+ public String oAuthVersion;
+ public AuthType authtype;
}
private FileParam getFileParameters(Map<String, String> paramMap) throws SvcLogicException {
p.responsePrefix = parseParam(paramMap, "responsePrefix", false, null);
String skipSendingStr = paramMap.get("skipSending");
p.skipSending = "true".equalsIgnoreCase(skipSendingStr);
+ p.oAuthConsumerKey = parseParam(paramMap, "oAuthConsumerKey", false, null);
+ p.oAuthVersion = parseParam(paramMap, "oAuthVersion", false, null);
+ p.oAuthConsumerSecret = parseParam(paramMap, "oAuthConsumerSecret", false, null);
+ p.oAuthSignatureMethod = parseParam(paramMap, "oAuthSignatureMethod", false, null);
+ p.authtype = AuthType.fromString(parseParam(paramMap, "authType", false, "unspecified"));
return p;
}
Client client = Client.create();
client.setConnectTimeout(5000);
client.setFollowRedirects(true);
- if (p.user != null)
- client.addFilter(new HTTPBasicAuthFilter(p.user, p.password));
- WebResource webResource = client.resource(p.url);
+ WebResource webResource = addAuthType(client,p).resource(p.url);
log.info("Sending file");
long t1 = System.currentTimeMillis();
if (r.code == 301) {
String newUrl = response.getHeaders().getFirst("Location");
- log.info("Got response code 301. Sending same request to URL: " + newUrl);
+ log.info("Got response code 301. Sending same request to URL: {}", newUrl);
webResource = client.resource(newUrl);
}
long t2 = System.currentTimeMillis();
- log.info("Response received. Time: " + (t2 - t1));
- log.info("HTTP response code: " + r.code);
- log.info("HTTP response message: " + r.message);
+ log.info("Response received. Time: {}", (t2 - t1));
+ log.info("HTTP response code: {}", r.code);
+ log.info("HTTP response message: {}", r.message);
logHeaders(r.headers);
- log.info("HTTP response: " + r.body);
+ log.info("HTTP response: {}", r.body);
return r;
}
String req;
if (p.templateFileName == null) {
- log.info("No template file name specified. Using default UEB template: " + defaultUebTemplateFileName);
+ log.info("No template file name specified. Using default UEB template: {}", defaultUebTemplateFileName);
p.templateFileName = defaultUebTemplateFileName;
}
ctx.setAttribute(pp + "httpResponse", r.body);
} catch (SvcLogicException e) {
- log.error("Error sending the request: " + e.getMessage(), e);
+ log.error("Error sending the request: {}", e.getMessage(), e);
r = new HttpResponse();
r.code = 500;
client.setConnectTimeout(5000);
WebResource webResource = client.resource(urls[0]);
- log.info("UEB URL: " + urls[0]);
+ log.info("UEB URL: {}", urls[0]);
log.info("Sending request:");
log.info(request);
long t1 = System.currentTimeMillis();
}
long t2 = System.currentTimeMillis();
- log.info("Response received. Time: " + (t2 - t1));
- log.info("HTTP response code: " + r.code);
+ log.info("Response received. Time: {}", (t2 - t1));
+ log.info("HTTP response code: {}", r.code);
logHeaders(r.headers);
- log.info("HTTP response:\n" + r.body);
+ log.info("HTTP response:\n {}", r.body);
return r;
}
log.info("Properties:");
for (String name : ll)
- log.info("--- " + name + ": " + String.valueOf(mm.get(name)));
+ log.info("--- {}:{}", name, String.valueOf(mm.get(name)));
}
protected void logHeaders(MultivaluedMap<String, String> mm) {
Collections.sort(ll);
for (String name : ll)
- log.info("--- " + name + ": " + String.valueOf(mm.get(name)));
+ log.info("--- {}:{}", name, String.valueOf(mm.get(name)));
}
public void setUebServers(String uebServers) {