package org.onap.sdnc.northbound;
+import com.google.common.base.Optional;
+import com.google.common.util.concurrent.CheckedFuture;
+import com.google.common.util.concurrent.Futures;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
-
import org.opendaylight.controller.md.sal.binding.api.DataBroker;
import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import com.google.common.base.Optional;
-import com.google.common.util.concurrent.CheckedFuture;
-import com.google.common.util.concurrent.Futures;
-
/**
* Defines a base implementation for your provider. This class extends from a helper class which provides storage for
* the most commonly used components of the MD-SAL. Additionally the base class provides some basic logging and
public class GenericResourceApiProvider implements AutoCloseable, GENERICRESOURCEAPIService {
- private static final String APP_NAME = "generic-resource-api";
+ protected static final String APP_NAME = "generic-resource-api";
private static final String CALLED_STR = "{} called.";
private static final String NULL_OR_EMPTY_ERROR_MESSAGE = "exiting {} because of null or empty service-instance-id";
- private static final String NULL_OR_EMPTY_ERROR_PARAM = "invalid input, null or empty service-instance-id";
+ protected static final String NULL_OR_EMPTY_ERROR_PARAM = "invalid input, null or empty service-instance-id";
private static final String ADDING_INPUT_DATA_LOG = "Adding INPUT data for {} [{}] input: {}";
private static final String ADDING_OPERATIONAL_DATA_LOG = "Adding OPERATIONAL data for {} [{}] operational-data: {}";
private static final String OPERATIONAL_DATA_PARAM = "operational-data";
- private static final String NO_SERVICE_LOGIC_ACTIVE = "No service logic active for ";
+ protected static final String NO_SERVICE_LOGIC_ACTIVE = "No service logic active for ";
private static final String SERVICE_LOGIC_SEARCH_ERROR_MESSAGE = "Caught exception looking for service logic";
private static final String ERROR_CODE_PARAM = "error-code";
private static final String ERROR_MESSAGE_PARAM = "error-message";
// create a new response object
ServiceTopologyOperationOutputBuilder responseBuilder = new ServiceTopologyOperationOutputBuilder();
- if (hasValidService(input)) {
+ if (hasInvalidService(input)) {
log.debug(NULL_OR_EMPTY_ERROR_MESSAGE, svcOperation);
responseBuilder.setResponseCode("404");
responseBuilder.setResponseMessage(NULL_OR_EMPTY_ERROR_PARAM);
// Call SLI sync method
// Get SvcLogicService reference
- ErrorObject error = new ErrorObject("200", "");
+ ResponseObject responseObject = new ResponseObject("200", "");
String ackFinal = "Y";
String serviceObjectPath = null;
- Properties respProps = tryGetProperties(svcOperation, parms, serviceDataBuilder, error);
+ Properties respProps = tryGetProperties(svcOperation, parms, serviceDataBuilder, responseObject);
if (respProps != null) {
- error.setStatusCode(respProps.getProperty(ERROR_CODE_PARAM));
- error.setMessage(respProps.getProperty(ERROR_MESSAGE_PARAM));
+ responseObject.setStatusCode(respProps.getProperty(ERROR_CODE_PARAM));
+ responseObject.setMessage(respProps.getProperty(ERROR_MESSAGE_PARAM));
ackFinal = respProps.getProperty(ACK_FINAL_PARAM, "Y");
serviceObjectPath = respProps.getProperty(SERVICE_OBJECT_PATH_PARAM);
}
- setServiceStatus(serviceStatusBuilder, error.getStatusCode(), error.getMessage(), ackFinal);
+ setServiceStatus(serviceStatusBuilder, responseObject.getStatusCode(), responseObject.getMessage(), ackFinal);
serviceStatusBuilder.setRequestStatus(RequestStatus.Synccomplete);
serviceStatusBuilder.setRpcName(svcOperation);
- if (isValidErrorObject(error)) {
- responseBuilder.setResponseCode(error.getStatusCode());
- responseBuilder.setResponseMessage(error.getMessage());
+ if (failed(responseObject)) {
+ responseBuilder.setResponseCode(responseObject.getStatusCode());
+ responseBuilder.setResponseMessage(responseObject.getMessage());
responseBuilder.setAckFinalIndicator(ackFinal);
ServiceBuilder serviceBuilder = new ServiceBuilder();
} catch (Exception e) {
log.error(UPDATING_MDSAL_ERROR_MESSAGE, svcOperation, siid, e);
responseBuilder.setResponseCode("500");
- responseBuilder.setResponseMessage(e.toString());
+ responseBuilder.setResponseMessage(e.getMessage());
responseBuilder.setAckFinalIndicator("Y");
log.error(RETURNED_FAILED_MESSAGE, svcOperation, siid, responseBuilder.build());
}
// Update succeeded
- responseBuilder.setResponseCode(error.getStatusCode());
+ responseBuilder.setResponseCode(responseObject.getStatusCode());
responseBuilder.setAckFinalIndicator(ackFinal);
- trySetResponseMessage(responseBuilder, error);
+ trySetResponseMessage(responseBuilder, responseObject);
log.info(UPDATED_MDSAL_INFO_MESSAGE, svcOperation, siid);
log.info(RETURNED_SUCCESS_MESSAGE, svcOperation, siid, responseBuilder.build());
return Futures.immediateFuture(rpcResult);
}
- private void trySetResponseMessage(ServiceTopologyOperationOutputBuilder responseBuilder, ErrorObject error) {
+ private void trySetResponseMessage(ServiceTopologyOperationOutputBuilder responseBuilder, ResponseObject error) {
if (!error.getMessage().isEmpty()) {
responseBuilder.setResponseMessage(error.getMessage());
}
}
- private boolean hasValidService(ServiceTopologyOperationInput input) {
+ private boolean hasInvalidService(ServiceTopologyOperationInput input) {
return input == null || input.getServiceInformation() == null
|| input.getServiceInformation().getServiceInstanceId() == null
|| input.getServiceInformation().getServiceInstanceId().length() == 0;
}
private Properties tryGetProperties(String svcOperation, Properties parms, ServiceDataBuilder serviceDataBuilder,
- ErrorObject error) {
+ ResponseObject responseObject) {
try {
if (svcLogicClient.hasGraph(APP_NAME, svcOperation, null, "sync")) {
try {
return svcLogicClient.execute(APP_NAME, svcOperation, null, "sync", serviceDataBuilder, parms);
} catch (Exception e) {
log.error(SERVICE_LOGIC_EXECUTION_ERROR_MESSAGE, svcOperation, e);
- error.setMessage(e.getMessage());
- error.setStatusCode("500");
+ responseObject.setMessage(e.getMessage());
+ responseObject.setStatusCode("500");
}
} else {
- error.setMessage(NO_SERVICE_LOGIC_ACTIVE + APP_NAME + ": '" + svcOperation + "'");
- error.setStatusCode("503");
+ responseObject.setMessage(NO_SERVICE_LOGIC_ACTIVE + APP_NAME + ": '" + svcOperation + "'");
+ responseObject.setStatusCode("503");
}
} catch (Exception e) {
- error.setMessage(e.getMessage());
- error.setStatusCode("500");
+ responseObject.setMessage(e.getMessage());
+ responseObject.setStatusCode("500");
log.error(SERVICE_LOGIC_SEARCH_ERROR_MESSAGE, e);
}
return null;
}
- private boolean isValidErrorObject(ErrorObject error) {
+ private boolean failed(ResponseObject error) {
return
!error.getStatusCode().isEmpty() && !("0".equals(error.getStatusCode()) || "200"
.equals(error.getStatusCode()));
final String svcOperation = "vnf-topology-operation";
ServiceData serviceData;
ServiceStatusBuilder serviceStatusBuilder = new ServiceStatusBuilder();
- Properties parms = new Properties();
+ Properties properties = new Properties();
log.info(CALLED_STR, svcOperation);
// create a new response object
trySetSvcRequestId(input, responseBuilder);
- if (hasInvalidVnf(input)) {
+ if (hasInvalidVnfId(input)) {
log.debug("exiting {} because of null or empty vnf-id", svcOperation);
responseBuilder.setResponseCode("404");
responseBuilder.setResponseMessage("invalid input, null or empty vnf-id");
log.info(ADDING_INPUT_DATA_LOG, svcOperation, siid, input);
VnfTopologyOperationInputBuilder inputBuilder = new VnfTopologyOperationInputBuilder(input);
- GenericResourceApiUtil.toProperties(parms, inputBuilder.build());
+ GenericResourceApiUtil.toProperties(properties, inputBuilder.build());
log.info(ADDING_OPERATIONAL_DATA_LOG, svcOperation, siid,
operDataBuilder.build());
- GenericResourceApiUtil.toProperties(parms, OPERATIONAL_DATA_PARAM, operDataBuilder);
+ GenericResourceApiUtil.toProperties(properties, OPERATIONAL_DATA_PARAM, operDataBuilder);
// Call SLI sync method
// Get SvcLogicService reference
- ErrorObject error = new ErrorObject("200", "");
+ ResponseObject responseObject = new ResponseObject("200", "");
String ackFinal = "Y";
String serviceObjectPath = null;
- Properties respProps = tryGetProperties(svcOperation, parms, serviceDataBuilder, error);
+ Properties respProps = tryGetProperties(svcOperation, properties, serviceDataBuilder, responseObject);
if (respProps != null) {
- error.setMessage(respProps.getProperty(ERROR_MESSAGE_PARAM));
- error.setStatusCode(respProps.getProperty(ERROR_CODE_PARAM));
+ responseObject.setMessage(respProps.getProperty(ERROR_MESSAGE_PARAM));
+ responseObject.setStatusCode(respProps.getProperty(ERROR_CODE_PARAM));
ackFinal = respProps.getProperty(ACK_FINAL_PARAM, "Y");
serviceObjectPath = respProps.getProperty("vnf-object-path");
}
- setServiceStatus(serviceStatusBuilder, error.getStatusCode(), error.getMessage(), ackFinal);
+ setServiceStatus(serviceStatusBuilder, responseObject.getStatusCode(), responseObject.getMessage(), ackFinal);
serviceStatusBuilder.setRequestStatus(RequestStatus.Synccomplete);
serviceStatusBuilder.setRpcName(svcOperation);
- if (isValidErrorObject(error)) {
- responseBuilder.setResponseCode(error.getStatusCode());
- responseBuilder.setResponseMessage(error.getMessage());
+ if (failed(responseObject)) {
+ responseBuilder.setResponseCode(responseObject.getStatusCode());
+ responseBuilder.setResponseMessage(responseObject.getMessage());
responseBuilder.setAckFinalIndicator(ackFinal);
ServiceBuilder serviceBuilder = new ServiceBuilder();
} catch (Exception e) {
log.error(UPDATING_MDSAL_ERROR_MESSAGE, svcOperation, siid, e);
responseBuilder.setResponseCode("500");
- responseBuilder.setResponseMessage(e.toString());
+ responseBuilder.setResponseMessage(e.getMessage());
responseBuilder.setAckFinalIndicator("Y");
log.error(RETURNED_FAILED_MESSAGE, svcOperation, siid, responseBuilder.build());
}
// Update succeeded
- responseBuilder.setResponseCode(error.getStatusCode());
+ responseBuilder.setResponseCode(responseObject.getStatusCode());
responseBuilder.setAckFinalIndicator(ackFinal);
- trySetResponseMessage(responseBuilder, error);
+ trySetResponseMessage(responseBuilder, responseObject);
log.info(UPDATED_MDSAL_INFO_MESSAGE, svcOperation, siid);
log.info(RETURNED_SUCCESS_MESSAGE, svcOperation, siid, responseBuilder.build());
return Futures.immediateFuture(rpcResult);
}
- private void trySetResponseMessage(VnfTopologyOperationOutputBuilder responseBuilder, ErrorObject error) {
+ private void trySetResponseMessage(VnfTopologyOperationOutputBuilder responseBuilder, ResponseObject error) {
if (!error.getMessage().isEmpty()) {
responseBuilder.setResponseMessage(error.getMessage());
}
}
}
- private boolean hasInvalidVnf(VnfTopologyOperationInput input) {
+ private boolean hasInvalidVnfId(VnfTopologyOperationInput input) {
return input.getVnfInformation() == null || input.getVnfInformation().getVnfId() == null
|| input.getVnfInformation().getVnfId().length() == 0;
}
return Futures.immediateFuture(rpcResult);
}
- if (hasInvalidVnf(input)) {
+ if (hasInvalidVnfId(input)) {
log.debug("exiting {} because of null or empty vnf-id", svcOperation);
responseBuilder.setResponseCode("403");
responseBuilder.setResponseMessage("invalid input, null or empty vnf-id");
// Call SLI sync method
// Get SvcLogicService reference
- ErrorObject error = new ErrorObject("200", "");
+ ResponseObject error = new ResponseObject("200", "");
String ackFinal = "Y";
String serviceObjectPath = null;
Properties respProps = tryGetProperties(svcOperation, parms, serviceDataBuilder, error);
serviceStatusBuilder.setRequestStatus(RequestStatus.Synccomplete);
serviceStatusBuilder.setRpcName(svcOperation);
- if (isValidErrorObject(error)) {
+ if (failed(error)) {
responseBuilder.setResponseCode(error.getStatusCode());
responseBuilder.setResponseMessage(error.getStatusCode());
responseBuilder.setAckFinalIndicator(ackFinal);
return Futures.immediateFuture(rpcResult);
}
- private void trySetResponseMessage(VfModuleTopologyOperationOutputBuilder responseBuilder, ErrorObject error) {
+ private void trySetResponseMessage(VfModuleTopologyOperationOutputBuilder responseBuilder, ResponseObject error) {
if (!error.getMessage().isEmpty()) {
responseBuilder.setResponseMessage(error.getMessage());
}
|| input.getVfModuleInformation().getVfModuleId().length() == 0;
}
- private boolean hasInvalidVnf(VfModuleTopologyOperationInput input) {
+ private boolean hasInvalidVnfId(VfModuleTopologyOperationInput input) {
return input.getVnfInformation() == null || input.getVnfInformation().getVnfId() == null
|| input.getVnfInformation().getVnfId().length() == 0;
}
// Call SLI sync method
// Get SvcLogicService reference
- ErrorObject error = new ErrorObject("200", "");
+ ResponseObject error = new ResponseObject("200", "");
String ackFinal = "Y";
String networkId = ERROR_NETWORK_ID;
String serviceObjectPath = null;
networkObjectPath = respProps.getProperty("network-object-path");
}
- if (isValidErrorObject(error)) {
+ if (failed(error)) {
responseBuilder.setResponseCode(error.getStatusCode());
responseBuilder.setResponseMessage(error.getMessage());
responseBuilder.setAckFinalIndicator(ackFinal);
return Futures.immediateFuture(rpcResult);
}
- private void trySetResponseMessage(NetworkTopologyOperationOutputBuilder responseBuilder, ErrorObject error) {
+ private void trySetResponseMessage(NetworkTopologyOperationOutputBuilder responseBuilder, ResponseObject error) {
if (!error.getMessage().isEmpty()) {
responseBuilder.setResponseMessage(error.getMessage());
}
// Call SLI sync method
// Get SvcLogicService reference
- ErrorObject error = new ErrorObject("200", "");
+ ResponseObject error = new ResponseObject("200", "");
String ackFinal = "Y";
String allottedResourceId = ERROR_NETWORK_ID;
String serviceObjectPath = null;
contrailRouteObjectPath = respProps.getProperty("contrail-route-object-path");
}
- if (isValidErrorObject(error)) {
+ if (failed(error)) {
responseBuilder.setResponseCode(error.getStatusCode());
responseBuilder.setResponseMessage(error.getMessage());
responseBuilder.setAckFinalIndicator(ackFinal);
return Futures.immediateFuture(rpcResult);
}
- private void trySetResponseMessage(ContrailRouteTopologyOperationOutputBuilder responseBuilder, ErrorObject error) {
+ private void trySetResponseMessage(ContrailRouteTopologyOperationOutputBuilder responseBuilder,
+ ResponseObject error) {
if (!error.getMessage().isEmpty()) {
responseBuilder.setResponseMessage(error.getMessage());
}
}
private Future<RpcResult<ContrailRouteTopologyOperationOutput>>
- buildRpcResultFuture(ContrailRouteTopologyOperationOutputBuilder responseBuilder, String responseMessage) {
+ buildRpcResultFuture(ContrailRouteTopologyOperationOutputBuilder responseBuilder, String responseMessage) {
responseBuilder.setResponseCode("404");
responseBuilder.setResponseMessage(responseMessage);
Properties respProps = null;
- ErrorObject error = new ErrorObject("200", "");
+ ResponseObject error = new ResponseObject("200", "");
String ackFinal = "Y";
String allottedResourceId = ERROR_NETWORK_ID;
String serviceObjectPath = null;
securityZoneObjectPath = respProps.getProperty("security-zone-object-path");
}
- if (isValidErrorObject(error)) {
+ if (failed(error)) {
responseBuilder.setResponseCode(error.getStatusCode());
responseBuilder.setResponseMessage(error.getMessage());
responseBuilder.setAckFinalIndicator(ackFinal);
return Futures.immediateFuture(rpcResult);
}
- private void trySetResponseMessage(SecurityZoneTopologyOperationOutputBuilder responseBuilder, ErrorObject error) {
+ private void trySetResponseMessage(SecurityZoneTopologyOperationOutputBuilder responseBuilder,
+ ResponseObject error) {
if (!error.getMessage().isEmpty()) {
responseBuilder.setResponseMessage(error.getMessage());
}
}
private Future<RpcResult<SecurityZoneTopologyOperationOutput>>
- buildRpcResultFuture(SecurityZoneTopologyOperationOutputBuilder responseBuilder, String responseMessage) {
+ buildRpcResultFuture(SecurityZoneTopologyOperationOutputBuilder responseBuilder, String responseMessage) {
responseBuilder.setResponseCode("404");
responseBuilder.setResponseMessage(responseMessage);
// Call SLI sync method
// Get SvcLogicService reference
- ErrorObject error = new ErrorObject("200", "");
+ ResponseObject error = new ResponseObject("200", "");
String ackFinal = "Y";
String allottedResourceId = ERROR_NETWORK_ID;
String serviceObjectPath = null;
tunnelxconnObjectPath = respProps.getProperty("tunnelxconn-object-path");
}
- if (isValidErrorObject(error)) {
+ if (failed(error)) {
responseBuilder.setResponseCode(error.getStatusCode());
responseBuilder.setResponseMessage(error.getMessage());
responseBuilder.setAckFinalIndicator(ackFinal);
return Futures.immediateFuture(rpcResult);
}
- private void trySetResponseMessage(TunnelxconnTopologyOperationOutputBuilder responseBuilder, ErrorObject error) {
+ private void trySetResponseMessage(TunnelxconnTopologyOperationOutputBuilder responseBuilder,
+ ResponseObject error) {
if (!error.getMessage().isEmpty()) {
responseBuilder.setResponseMessage(error.getMessage());
}
|| input.getServiceInformation().getServiceInstanceId().length() == 0;
}
- private Properties tryGetProperties(String svcOperation, Properties parms, ErrorObject error) {
+ private Properties tryGetProperties(String svcOperation, Properties parms, ResponseObject error) {
try {
if (svcLogicClient.hasGraph(APP_NAME, svcOperation, null, "sync")) {
// Call SLI sync method
// Get SvcLogicService reference
- ErrorObject error = new ErrorObject("200", "");
+ ResponseObject error = new ResponseObject("200", "");
String ackFinal = "Y";
String allottedResourceId = ERROR_NETWORK_ID;
String serviceObjectPath = null;
brgObjectPath = respProps.getProperty("brg-object-path");
}
- if (isValidErrorObject(error)) {
+ if (failed(error)) {
responseBuilder.setResponseCode(error.getStatusCode());
responseBuilder.setResponseMessage(error.getMessage());
responseBuilder.setAckFinalIndicator(ackFinal);
return Futures.immediateFuture(rpcResult);
}
- private void trySetResponseMessage(BrgTopologyOperationOutputBuilder responseBuilder, ErrorObject error) {
+ private void trySetResponseMessage(BrgTopologyOperationOutputBuilder responseBuilder, ResponseObject error) {
if (!error.getMessage().isEmpty()) {
responseBuilder.setResponseMessage(error.getMessage());
}
// Call SLI sync method
// Get SvcLogicService reference
- ErrorObject error = new ErrorObject("200", "");
+ ResponseObject error = new ResponseObject("200", "");
Properties respProps = tryGetProperties(svcOperation, parms, error);
String ackFinal = resolveAckFinal(error, respProps);
- if (isValidErrorObject(error)) {
+ if (failed(error)) {
responseBuilder.setResponseCode(error.getStatusCode());
responseBuilder.setResponseMessage(error.getMessage());
return Futures.immediateFuture(rpcResult);
}
- private String resolveAckFinal(ErrorObject error, Properties respProps) {
+ private String resolveAckFinal(ResponseObject error, Properties respProps) {
if (respProps != null) {
error.setStatusCode(respProps.getProperty(ERROR_CODE_PARAM));
error.setMessage(respProps.getProperty(ERROR_MESSAGE_PARAM));
- return respProps.getProperty(ACK_FINAL_PARAM, "Y");
+ return respProps.getProperty(ACK_FINAL_PARAM, "Y");
}
return "Y";
}
- private void trySetResponseMessage(PreloadVnfTopologyOperationOutputBuilder responseBuilder, ErrorObject error) {
+ private void trySetResponseMessage(PreloadVnfTopologyOperationOutputBuilder responseBuilder, ResponseObject error) {
if (!error.getMessage().isEmpty()) {
responseBuilder.setResponseMessage(error.getMessage());
}
// Call SLI sync method
// Get SvcLogicService reference
- ErrorObject error = new ErrorObject("200", "");
+ ResponseObject error = new ResponseObject("200", "");
Properties respProps = tryGetProperties(svcOperation, parms, error);
String ackFinal = resolveAckFinal(error, respProps);
- if (isValidErrorObject(error)) {
+ if (failed(error)) {
responseBuilder.setResponseCode(error.getStatusCode());
responseBuilder.setResponseMessage(error.getMessage());
}
private void trySetResponseMessage(PreloadNetworkTopologyOperationOutputBuilder responseBuilder,
- ErrorObject error) {
+ ResponseObject error) {
if (!error.getMessage().isEmpty()) {
responseBuilder.setResponseMessage(error.getMessage());
}