package org.onap.dmaap.dbcapi.model;
import javax.xml.bind.annotation.XmlRootElement;
+import java.io.Serializable;
import java.util.Objects;
@XmlRootElement
-public class ApiError {
+public class ApiError implements Serializable {
private int code;
private String message;
private String fields;
private DR_NodeService dr_nodeService = new DR_NodeService();
private ResponseBuilder responseBuilder = new ResponseBuilder();
+ private RequiredChecker checker = new RequiredChecker();
@GET
@ApiOperation( value = "return DR_Node details",
ApiService resp = new ApiService();
try {
- resp.required( "dcaeLocation", node.getDcaeLocationName(), "");
- resp.required( "fqdn", node.getFqdn(), "");
+ checker.required( "dcaeLocation", node.getDcaeLocationName());
+ checker.required( "fqdn", node.getFqdn());
} catch ( RequiredFieldException rfe ) {
return responseBuilder.error(new ApiError(BAD_REQUEST.getStatusCode(),
"missing required field", "dcaeLocation, fqdn"));
ApiService resp = new ApiService();
try {
- resp.required( "dcaeLocation", name, "");
- resp.required( "fqdn", node.getFqdn(), "");
+ checker.required( "dcaeLocation", name);
+ checker.required( "fqdn", node.getFqdn());
} catch ( RequiredFieldException rfe ) {
- return responseBuilder.error(resp.getErr());
+ return responseBuilder.error(rfe.getApiError());
}
node.setFqdn(name);
DR_Node nNode = dr_nodeService.updateDr_Node(node, resp.getErr());
ApiService resp = new ApiService();
try {
- resp.required( "fqdn", name, "");
+ checker.required( "fqdn", name);
} catch ( RequiredFieldException rfe ) {
- logger.debug( resp.toString() );
- return responseBuilder.error(resp.getErr());
+ logger.debug( rfe.getApiError().toString() );
+ return responseBuilder.error(rfe.getApiError());
}
dr_nodeService.removeDr_Node(name, resp.getErr());
if ( resp.getErr().is2xx() ) {
private DR_PubService dr_pubService = new DR_PubService();
private ResponseBuilder responseBuilder = new ResponseBuilder();
+ private RequiredChecker checker = new RequiredChecker();
@GET
@ApiOperation( value = "return DR_Pub details",
logger.info( "Entry: POST /dr_pubs");
try {
- resp.required( "feedId", pub.getFeedId(), "");
+ checker.required( "feedId", pub.getFeedId());
} catch ( RequiredFieldException rfe ) {
try {
- resp.required( "feedName", pub.getFeedName(), "");
+ checker.required( "feedName", pub.getFeedName());
}catch ( RequiredFieldException rfe2 ) {
- logger.debug( resp.toString() );
- return responseBuilder.error(resp.getErr());
+ logger.debug( rfe2.getApiError().toString() );
+ return responseBuilder.error(rfe2.getApiError());
}
// if we found a FeedName instead of a FeedId then try to look it up.
List<Feed> nfeeds = feeds.getAllFeeds( pub.getFeedName(), pub.getFeedVersion(), "equals");
fnew = nfeeds.get(0);
}
try {
- resp.required( "dcaeLocationName", pub.getDcaeLocationName(), "");
+ checker.required( "dcaeLocationName", pub.getDcaeLocationName());
} catch ( RequiredFieldException rfe ) {
- logger.debug( resp.getErr().toString() );
- return responseBuilder.error(resp.getErr());
+ logger.debug( rfe.getApiError().toString() );
+ return responseBuilder.error(rfe.getApiError());
}
ApiService resp = new ApiService();
try {
- resp.required( "pubId", id, "");
+ checker.required( "pubId", id);
} catch ( RequiredFieldException rfe ) {
- return responseBuilder.error(resp.getErr());
+ return responseBuilder.error(rfe.getApiError());
}
DR_Pub pub = dr_pubService.getDr_Pub( id, resp.getErr() );
ApiService resp = new ApiService();
try {
- resp.required( "feedId", id, "");
+ checker.required( "feedId", id);
} catch ( RequiredFieldException rfe ) {
- return responseBuilder.error(resp.getErr());
+ return responseBuilder.error(rfe.getApiError());
}
DR_Pub pub = dr_pubService.getDr_Pub( id, resp.getErr() );
public class DR_SubResource extends BaseLoggingClass {
private ResponseBuilder responseBuilder = new ResponseBuilder();
+ private RequiredChecker checker = new RequiredChecker();
@GET
@ApiOperation( value = "return DR_Sub details",
FeedService feeds = new FeedService();
Feed fnew = null;
try {
- resp.required( "feedId", sub.getFeedId(), "");
+ checker.required( "feedId", sub.getFeedId());
} catch ( RequiredFieldException rfe ) {
try {
- resp.required( "feedName", sub.getFeedName(), "");
+ checker.required( "feedName", sub.getFeedName());
}catch ( RequiredFieldException rfe2 ) {
- logger.debug( resp.toString() );
- return responseBuilder.error(resp.getErr());
+ logger.debug( rfe2.getApiError().toString() );
+ return responseBuilder.error(rfe2.getApiError());
}
// if we found a FeedName instead of a FeedId then try to look it up.
List<Feed> nfeeds = feeds.getAllFeeds( sub.getFeedName(), sub.getFeedVersion(), "equals");
}
try {
- resp.required( "dcaeLocationName", sub.getDcaeLocationName(), "");
+ checker.required( "dcaeLocationName", sub.getDcaeLocationName());
} catch ( RequiredFieldException rfe ) {
- logger.debug( resp.toString() );
- return responseBuilder.error(resp.getErr());
+ logger.debug( rfe.getApiError().toString() );
+ return responseBuilder.error(rfe.getApiError());
}
// we may have fnew already if located by FeedName
if ( fnew == null ) {
ApiService resp = new ApiService();
try {
- resp.required( "subId", name, "");
- resp.required( "feedId", sub.getFeedId(), "");
- resp.required( "dcaeLocationName", sub.getDcaeLocationName(), "");
+ checker.required( "subId", name);
+ checker.required( "feedId", sub.getFeedId());
+ checker.required( "dcaeLocationName", sub.getDcaeLocationName());
} catch ( RequiredFieldException rfe ) {
- logger.debug( resp.toString() );
- return responseBuilder.error(resp.getErr());
+ logger.debug( rfe.getApiError().toString() );
+ return responseBuilder.error(rfe.getApiError());
}
FeedService feeds = new FeedService();
Feed fnew = feeds.getFeed( sub.getFeedId(), resp.getErr() );
ApiService resp = new ApiService();
try {
- resp.required( "subId", id, "");
+ checker.required( "subId", id);
} catch ( RequiredFieldException rfe ) {
- logger.debug( resp.toString() );
- return responseBuilder.error(resp.getErr());
+ logger.debug( rfe.getApiError().toString() );
+ return responseBuilder.error(rfe.getApiError());
}
DR_SubService dr_subService = new DR_SubService();
dr_subService.removeDr_Sub(id, resp.getErr() );
ApiService resp = new ApiService();
try {
- resp.required( "subId", id, "");
+ checker.required( "subId", id);
} catch ( RequiredFieldException rfe ) {
- logger.debug( resp.toString() );
- return responseBuilder.error(resp.getErr());
+ logger.debug( rfe.getApiError().toString() );
+ return responseBuilder.error(rfe.getApiError());
}
DR_SubService dr_subService = new DR_SubService();
DR_Sub sub = dr_subService.getDr_Sub( id, resp.getErr() );
* 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.
package org.onap.dmaap.dbcapi.resources;
-
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
+import org.onap.dmaap.dbcapi.logging.BaseLoggingClass;
+import org.onap.dmaap.dbcapi.model.ApiError;
+import org.onap.dmaap.dbcapi.model.Dmaap;
+import org.onap.dmaap.dbcapi.service.DmaapService;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriInfo;
-import org.onap.dmaap.dbcapi.logging.BaseLoggingClass;
-import org.onap.dmaap.dbcapi.model.ApiError;
-import org.onap.dmaap.dbcapi.model.Dmaap;
-import org.onap.dmaap.dbcapi.service.ApiService;
-import org.onap.dmaap.dbcapi.service.DmaapService;
-
-
@Path("/dmaap")
@Api( value= "dmaap", description = "Endpoint for this instance of DMaaP object containing values for this OpenDCAE deployment" )
private DmaapService dmaapService = new DmaapService();
private ResponseBuilder responseBuilder = new ResponseBuilder();
-
+ private RequiredChecker checker = new RequiredChecker();
+
@GET
@ApiOperation( value = "return dmaap details", notes = "returns the `dmaap` object, which contains system wide configuration settings", response = Dmaap.class)
@ApiResponses( value = {
Dmaap d = dmaapService.getDmaap();
return responseBuilder.success(d);
}
-
+
@POST
@ApiOperation( value = "return dmaap details", notes = "Create a new DMaaP set system wide configuration settings for the *dcaeEnvironment*. Deprecated with introduction of persistence in 1610.", response = Dmaap.class)
@ApiResponses( value = {
@ApiResponse( code = 400, message = "Error", response = ApiError.class )
})
public Response addDmaap( Dmaap obj ) {
- ApiService check = new ApiService();
- try { //check for required fields
- check.required( "dmaapName", obj.getDmaapName(), "^\\S+$" ); //no white space allowed in dmaapName
- check.required( "dmaapProvUrl", obj.getDrProvUrl(), "" );
- check.required( "topicNsRoot", obj.getTopicNsRoot(), "" );
- check.required( "bridgeAdminTopic", obj.getBridgeAdminTopic(), "" );
+ try {
+ validateRequiredFields(obj);
} catch( RequiredFieldException rfe ) {
- return responseBuilder.error(check.getErr());
+ return responseBuilder.error(rfe.getApiError());
}
-
+
Dmaap d = dmaapService.addDmaap(obj);
if ( d == null ) {
return responseBuilder.notFound();
- }
+ }
return responseBuilder.success(d);
}
-
+
@PUT
@ApiOperation( value = "return dmaap details", notes = "Update system settings for *dcaeEnvironment*.", response = Dmaap.class)
@ApiResponses( value = {
@ApiResponse( code = 400, message = "Error", response = ApiError.class )
})
public Response updateDmaap( Dmaap obj ) {
- ApiService check = new ApiService();
- try { //check for required fields
- check.required( "dmaapName", obj.getDmaapName(), "^\\S+$" ); //no white space allowed in dmaapName
- check.required( "dmaapProvUrl", obj.getDrProvUrl(), "" );
- check.required( "topicNsRoot", obj.getTopicNsRoot(), "" );
- check.required( "bridgeAdminTopic", obj.getBridgeAdminTopic(), "" );
+ try {
+ validateRequiredFields(obj);
} catch( RequiredFieldException rfe ) {
- return responseBuilder.error(check.getErr());
+ return responseBuilder.error(rfe.getApiError());
}
+
Dmaap d = dmaapService.updateDmaap(obj);
if ( d != null ) {
return responseBuilder.success(d);
} else {
return responseBuilder.notFound();
- }
+ }
+ }
+
+ private void validateRequiredFields(Dmaap obj) throws RequiredFieldException {
+ checker.required( "dmaapName", obj.getDmaapName(), "^\\S+$" ); //no white space allowed in dmaapName
+ checker.required( "dmaapProvUrl", obj.getDrProvUrl());
+ checker.required( "topicNsRoot", obj.getTopicNsRoot());
+ checker.required( "bridgeAdminTopic", obj.getBridgeAdminTopic());
}
-
-
}
public class FeedResource extends BaseLoggingClass {
private ResponseBuilder responseBuilder = new ResponseBuilder();
+ private RequiredChecker checker = new RequiredChecker();
@GET
@ApiOperation( value = "return Feed details",
ApiService resp = new ApiService();
try {
- resp.required( "feedName", feed.getFeedName(), "");
- resp.required( "feedVersion", feed.getFeedVersion(), "");
- resp.required( "owner", feed.getOwner(), "" );
- resp.required( "asprClassification", feed.getAsprClassification(), "" );
+ checker.required( "feedName", feed.getFeedName());
+ checker.required( "feedVersion", feed.getFeedVersion());
+ checker.required( "owner", feed.getOwner());
+ checker.required( "asprClassification", feed.getAsprClassification());
} catch ( RequiredFieldException rfe ) {
- logger.debug( resp.toString() );
- return responseBuilder.error(resp.getErr());
+ logger.debug( rfe.getApiError().toString() );
+ return responseBuilder.error(rfe.getApiError());
}
ApiService resp = new ApiService();
try {
- resp.required( "feedId", id, "");
+ checker.required( "feedId", id);
} catch ( RequiredFieldException rfe ) {
- logger.debug( resp.toString() );
- return responseBuilder.error(resp.getErr());
+ logger.debug( rfe.getApiError().toString() );
+ return responseBuilder.error(rfe.getApiError());
}
Feed nfeed = feedService.getFeed( id, resp.getErr() );
private MR_ClientService mr_clientService = new MR_ClientService();
private ResponseBuilder responseBuilder = new ResponseBuilder();
+ private RequiredChecker checker = new RequiredChecker();
@GET
@ApiOperation( value = "return MR_Client details",
ApiService resp = new ApiService();
try {
- resp.required( "fqtn", client.getFqtn(), "");
- resp.required( "dcaeLocationName", client.getDcaeLocationName(), "");
+ checker.required( "fqtn", client.getFqtn());
+ checker.required( "dcaeLocationName", client.getDcaeLocationName());
String s = client.getClientRole();
if ( s == null ) {
s = client.getClientIdentity();
}
- resp.required( "clientRole or clientIdentity", s, "" );
- resp.required( "action", client.getAction(), "");
+ checker.required( "clientRole or clientIdentity", s);
+ checker.required( "action", client.getAction());
} catch ( RequiredFieldException rfe ) {
- logger.debug( resp.toString() );
- return responseBuilder.error(resp.getErr());
+ logger.debug( rfe.getApiError().toString() );
+ return responseBuilder.error(rfe.getApiError());
}
MR_ClusterService clusters = new MR_ClusterService();
ApiService resp = new ApiService();
try {
- resp.required( "fqtn", client.getFqtn(), "");
- resp.required( "dcaeLocationName", client.getDcaeLocationName(), "");
- resp.required( "clientRole", client.getClientRole(), "" );
- resp.required( "action", client.getAction(), "");
+ checker.required( "fqtn", client.getFqtn());
+ checker.required( "dcaeLocationName", client.getDcaeLocationName());
+ checker.required( "clientRole", client.getClientRole());
+ checker.required( "action", client.getAction());
} catch ( RequiredFieldException rfe ) {
- logger.debug( resp.toString() );
- return responseBuilder.error(resp.getErr());
+ logger.debug( rfe.getApiError().toString() );
+ return responseBuilder.error(rfe.getApiError());
}
client.setMrClientId(clientId);
MR_Client nClient = mr_clientService.updateMr_Client(client, resp.getErr() );
ApiService resp = new ApiService();
try {
- resp.required( "clientId", id, "");
+ checker.required( "clientId", id);
} catch ( RequiredFieldException rfe ) {
- logger.debug( resp.toString() );
- return responseBuilder.error(resp.getErr());
+ logger.debug( rfe.getApiError().toString() );
+ return responseBuilder.error(rfe.getApiError());
}
mr_clientService.removeMr_Client(id, true, resp.getErr() );
if ( resp.getErr().is2xx()) {
ApiService resp = new ApiService();
try {
- resp.required( "clientId", id, "");
+ checker.required( "clientId", id);
} catch ( RequiredFieldException rfe ) {
- logger.debug( resp.toString() );
- return responseBuilder.error(resp.getErr());
+ logger.debug( rfe.getApiError().toString() );
+ return responseBuilder.error(rfe.getApiError());
}
MR_Client nClient = mr_clientService.getMr_Client( id, resp.getErr() );
if ( resp.getErr().is2xx()) {
private MR_ClusterService mr_clusterService = new MR_ClusterService();
private ResponseBuilder responseBuilder = new ResponseBuilder();
+ private RequiredChecker checker = new RequiredChecker();
@GET
@ApiOperation( value = "return MR_Cluster details",
ApiService resp = new ApiService();
try {
- resp.required( "dcaeLocationName", cluster.getDcaeLocationName(), "" );
- resp.required( "fqdn", cluster.getFqdn(), "" );
+ checker.required( "dcaeLocationName", cluster.getDcaeLocationName());
+ checker.required( "fqdn", cluster.getFqdn());
} catch( RequiredFieldException rfe ) {
- return responseBuilder.error(resp.getErr());
+ return responseBuilder.error(rfe.getApiError());
}
MR_Cluster mrc = mr_clusterService.addMr_Cluster(cluster, resp.getErr() );
if ( mrc != null && mrc.isStatusValid() ) {
ApiService resp = new ApiService();
try {
- resp.required( "fqdn", clusterId, "" );
- resp.required( "dcaeLocationName", cluster.getDcaeLocationName(), "" );
+ checker.required( "fqdn", clusterId);
+ checker.required( "dcaeLocationName", cluster.getDcaeLocationName());
} catch( RequiredFieldException rfe ) {
- return responseBuilder.error(resp.getErr());
+ return responseBuilder.error(rfe.getApiError());
}
cluster.setDcaeLocationName(clusterId);
MR_Cluster mrc = mr_clusterService.updateMr_Cluster(cluster, resp.getErr() );
ApiService resp = new ApiService();
try {
- resp.required( "fqdn", id, "" );
+ checker.required( "fqdn", id);
} catch( RequiredFieldException rfe ) {
- return responseBuilder.error(resp.getErr());
+ return responseBuilder.error(rfe.getApiError());
}
mr_clusterService.removeMr_Cluster(id, resp.getErr() );
if ( resp.getErr().is2xx()) {
ApiService resp = new ApiService();
try {
- resp.required( "dcaeLocationName", id, "" );
+ checker.required( "dcaeLocationName", id);
} catch( RequiredFieldException rfe ) {
- return responseBuilder.error(resp.getErr());
+ return responseBuilder.error(rfe.getApiError());
}
MR_Cluster mrc = mr_clusterService.getMr_Cluster( id, resp.getErr() );
if ( mrc != null && mrc.isStatusValid() ) {
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * PNF-REGISTRATION-HANDLER
+ * ================================================================================
+ * Copyright (C) 2019 NOKIA 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.onap.dmaap.dbcapi.resources;
+
+import org.onap.dmaap.dbcapi.model.ApiError;
+
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import static javax.ws.rs.core.Response.Status.BAD_REQUEST;
+
+public class RequiredChecker {
+
+ public void required(String name, Object val) throws RequiredFieldException {
+ if (val == null) {
+ throw new RequiredFieldException(new ApiError(BAD_REQUEST.getStatusCode(),
+ "missing required field", name));
+ }
+ }
+
+ public void required(String name, String val, String expr) throws RequiredFieldException {
+
+ required(name, val);
+
+ if (expr != null && !expr.isEmpty()) {
+ Pattern pattern = Pattern.compile(expr);
+ Matcher matcher = pattern.matcher(val);
+ if (!matcher.find()) {
+ throw new RequiredFieldException(new ApiError(BAD_REQUEST.getStatusCode(),
+ "value '" + val + "' violates regexp check '" + expr + "'", name));
+ }
+ }
+ }
+
+}
* 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.
package org.onap.dmaap.dbcapi.resources;
+import org.onap.dmaap.dbcapi.model.ApiError;
+
public class RequiredFieldException extends Exception {
- /**
- *
- */
- private static final long serialVersionUID = 1L;
+ private static final long serialVersionUID = 2L;
+
+ private final ApiError apiError;
+
+ public RequiredFieldException(ApiError apiError) {
+ super();
+ this.apiError = apiError;
+ }
+
+ public ApiError getApiError() {
+ return apiError;
+ }
+ @Override
+ public String toString() {
+ return "RequiredFieldException{" +
+ "apiError=" + apiError +
+ '}';
+ }
}
private static String defaultReplicationCount;
private TopicService mr_topicService = new TopicService();
private ResponseBuilder responseBuilder = new ResponseBuilder();
+ private RequiredChecker checker = new RequiredChecker();
public TopicResource() {
DmaapConfig p = (DmaapConfig)DmaapConfig.getConfig();
ApiService check = new ApiService();
try {
- check.required( "topicName", topic.getTopicName(), "^\\S+$" ); //no white space allowed in topicName
- check.required( "topicDescription", topic.getTopicDescription(), "" );
- check.required( "owner", topic.getOwner(), "" );
+ checker.required( "topicName", topic.getTopicName(), "^\\S+$" ); //no white space allowed in topicName
+ checker.required( "topicDescription", topic.getTopicDescription());
+ checker.required( "owner", topic.getOwner());
} catch( RequiredFieldException rfe ) {
- logger.error("Error", rfe);
- return responseBuilder.error(check.getErr());
+ logger.error("Error", rfe.getApiError());
+ return responseBuilder.error(rfe.getApiError());
}
ReplicationType t = topic.getReplicationCase();
ApiService check = new ApiService();
try {
- check.required( "fqtn", id, "" );
+ checker.required( "fqtn", id);
} catch( RequiredFieldException rfe ) {
- logger.error("Error", rfe);
- return responseBuilder.error(check.getErr());
+ logger.error("Error", rfe.getApiError());
+ return responseBuilder.error(rfe.getApiError());
}
mr_topicService.removeTopic(id, check.getErr());
ApiService check = new ApiService();
try {
- check.required( "topicName", id, "^\\S+$" ); //no white space allowed in topicName
+ checker.required( "topicName", id, "^\\S+$" ); //no white space allowed in topicName
} catch( RequiredFieldException rfe ) {
- logger.error("Error", rfe);
- return responseBuilder.error(check.getErr());
+ logger.error("Error", rfe.getApiError());
+ return responseBuilder.error(rfe.getApiError());
}
Topic mrc = mr_topicService.getTopic( id, check.getErr() );
if ( mrc == null ) {
* 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.
package org.onap.dmaap.dbcapi.service;
-import static com.att.eelf.configuration.Configuration.MDC_BEGIN_TIMESTAMP;
-import static com.att.eelf.configuration.Configuration.MDC_ELAPSED_TIME;
-import static com.att.eelf.configuration.Configuration.MDC_END_TIMESTAMP;
import static com.att.eelf.configuration.Configuration.MDC_KEY_REQUEST_ID;
import static com.att.eelf.configuration.Configuration.MDC_PARTNER_NAME;
import static com.att.eelf.configuration.Configuration.MDC_SERVICE_NAME;
-import java.text.SimpleDateFormat;
-import java.util.Date;
-import java.util.TimeZone;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-
-import javax.ws.rs.core.Response.Status;
import javax.xml.bind.DatatypeConverter;
-
import org.onap.dmaap.dbcapi.aaf.DmaapPerm;
import org.onap.dmaap.dbcapi.authentication.ApiPolicy;
import org.onap.dmaap.dbcapi.authentication.AuthenticationErrorException;
import org.onap.dmaap.dbcapi.logging.BaseLoggingClass;
import org.onap.dmaap.dbcapi.model.ApiError;
import org.onap.dmaap.dbcapi.model.Dmaap;
-import org.onap.dmaap.dbcapi.resources.RequiredFieldException;
import org.onap.dmaap.dbcapi.util.DmaapConfig;
import org.onap.dmaap.dbcapi.util.RandomString;
import org.slf4j.MDC;
public class ApiService extends BaseLoggingClass {
- private class StopWatch {
- private long clock = 0;
- private long elapsed = 0;
-
-
-
- public StopWatch() {
- clock = 0;
- elapsed = 0;
- }
-
- public void reset() {
- clock = System.currentTimeMillis();
- elapsed = 0;
- }
- public void stop() {
- Long stopTime = System.currentTimeMillis();
- elapsed += stopTime - clock;
- clock = 0;
- MDC.put( MDC_END_TIMESTAMP, isoFormatter.format(new Date(stopTime)));
- MDC.put( MDC_ELAPSED_TIME, String.valueOf(elapsed));
- }
- public void start() {
- if ( clock != 0 ) {
- //not stopped
- return;
- }
- clock = System.currentTimeMillis();
- MDC.put( MDC_BEGIN_TIMESTAMP, isoFormatter.format(new Date(clock)));
- }
- private long getElapsed() {
- return elapsed;
- }
- }
-
- private String apiNamespace;
-
- private String uri;
- private String uriPath;
- private String method;
- private String authorization;
- private String requestId;
- private ApiError err;
- private StopWatch stopwatch;
- private ApiPolicy apiPolicy;
-
- public static final String ISO_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSZ";
- public final static TimeZone utc = TimeZone.getTimeZone("UTC");
- public final static SimpleDateFormat isoFormatter = new SimpleDateFormat(ISO_FORMAT);
-
- static {
- isoFormatter.setTimeZone(utc);
- }
- public ApiService() {
-
- stopwatch = new StopWatch();
- stopwatch.start();
- err = new ApiError();
- requestId = (new RandomString(10)).nextString();
-
- if (apiNamespace == null) {
- DmaapConfig p = (DmaapConfig)DmaapConfig.getConfig();
- apiNamespace = p.getProperty("ApiNamespace", "org.openecomp.dmaapBC.api");
- logger.info( "config param usePE has been deprecated. Use ApiPermission.Class property instead.");
- }
- apiPolicy = new ApiPolicy();
-
- logger.info( "apiNamespace=" + apiNamespace);
- }
-
- public ApiService setAuth( String auth ) {
- this.authorization = auth;
- logger.info( "setAuth: authorization={} ", authorization);
- return this;
- }
- private void setServiceName(){
- String svcRequest = new String( this.method + " " + this.uriPath );
- MDC.put(MDC_SERVICE_NAME, svcRequest );
- }
- public ApiService setHttpMethod( String httpMethod ) {
- this.method = httpMethod;
- logger.info( "setHttpMethod: method={} ", method);
- setServiceName();
- return this;
- }
- public ApiService setUriPath( String uriPath ) {
- this.uriPath = uriPath;
- this.uri = setUriFromPath( uriPath );
- logger.info( "setUriPath: uriPath={} uri={}", uriPath, uri);
- setServiceName();
- return this;
- }
- private String setUriFromPath( String uriPath ) {
- int ch = uriPath.indexOf("/");
- if ( ch > 0 ) {
- return( (String) uriPath.subSequence(0, ch ) );
- } else {
- return uriPath;
- }
- }
-
- public ApiError getErr() {
- return err;
- }
-
-
- public void setErr(ApiError err) {
- this.err = err;
- }
-
-
- // test for presence of a required field
- public void required( String name, Object val, String expr ) throws RequiredFieldException {
- err.setCode(0);
- if ( val == null ) {
- err.setCode(Status.BAD_REQUEST.getStatusCode());
- err.setMessage("missing required field");
- err.setFields( name );
- throw new RequiredFieldException();
- }
- if ( expr != null && ! expr.isEmpty() ) {
- Pattern pattern = Pattern.compile(expr);
- Matcher matcher = pattern.matcher((CharSequence) val);
- if ( ! matcher.find() ) {
- err.setCode(Status.BAD_REQUEST.getStatusCode());
- err.setMessage( "value '" + val + "' violates regexp check '" + expr + "'");
- err.setFields( name );
- throw new RequiredFieldException();
- }
- }
- }
-
- // utility to serialize ApiErr object
- public String toString() {
- return String.format( "code=%d msg=%s fields=%s", err.getCode(), err.getMessage(), err.getFields() );
- }
+ private String apiNamespace;
+ private String uri;
+ private String uriPath;
+ private String method;
+ private String authorization;
+ private String requestId;
+ private ApiError err;
+ private ApiPolicy apiPolicy;
+
+ public ApiService() {
+
+ err = new ApiError();
+ requestId = (new RandomString(10)).nextString();
+
+ if (apiNamespace == null) {
+ DmaapConfig p = (DmaapConfig) DmaapConfig.getConfig();
+ apiNamespace = p.getProperty("ApiNamespace", "org.openecomp.dmaapBC.api");
+ logger.info("config param usePE has been deprecated. Use ApiPermission.Class property instead.");
+ }
+ apiPolicy = new ApiPolicy();
+
+ logger.info("apiNamespace=" + apiNamespace);
+ }
+
+ public ApiService setAuth(String auth) {
+ this.authorization = auth;
+ logger.info("setAuth: authorization={} ", authorization);
+ return this;
+ }
+
+ private void setServiceName() {
+ String svcRequest = new String(this.method + " " + this.uriPath);
+ MDC.put(MDC_SERVICE_NAME, svcRequest);
+ }
+
+ public ApiService setHttpMethod(String httpMethod) {
+ this.method = httpMethod;
+ logger.info("setHttpMethod: method={} ", method);
+ setServiceName();
+ return this;
+ }
+
+ public ApiService setUriPath(String uriPath) {
+ this.uriPath = uriPath;
+ this.uri = setUriFromPath(uriPath);
+ logger.info("setUriPath: uriPath={} uri={}", uriPath, uri);
+ setServiceName();
+ return this;
+ }
+
+ private String setUriFromPath(String uriPath) {
+ int ch = uriPath.indexOf("/");
+ if (ch > 0) {
+ return ((String) uriPath.subSequence(0, ch));
+ } else {
+ return uriPath;
+ }
+ }
+
+ public ApiError getErr() {
+ return err;
+ }
+
+
+ public void setErr(ApiError err) {
+ this.err = err;
+ }
public void setCode(int statusCode) {
err.setCode(statusCode);
}
- public void setMessage(String string) {
- err.setMessage(string);
- }
+ public void setMessage(String string) {
+ err.setMessage(string);
+ }
public void setFields(String string) {
err.setFields(string);
}
-
- public void checkAuthorization( String auth, String uriPath, String httpMethod ) throws AuthenticationErrorException, Exception {
- authorization = auth;
- setUriFromPath( uriPath );
- method = httpMethod;
-
- checkAuthorization();
- }
-
- public void checkAuthorization() throws AuthenticationErrorException, Exception {
-
- MDC.put(MDC_KEY_REQUEST_ID, requestId);
-
- logger.info("request: uri={} method={} auth={}", uri, method, authorization );
-
- if ( uri == null || uri.isEmpty()) {
- String errmsg = "No URI value provided ";
- err.setMessage(errmsg);
- logger.info( errmsg );
- throw new AuthenticationErrorException( );
- }
- if ( method == null || method.isEmpty()) {
- String errmsg = "No method value provided ";
- err.setMessage(errmsg);
- logger.info( errmsg );
- throw new AuthenticationErrorException( );
- }
- DmaapService dmaapService = new DmaapService();
- Dmaap dmaap = dmaapService.getDmaap();
- String env = dmaap.getDmaapName();
-
- // special case during bootstrap of app when DMaaP environment may not be set.
- // this allows us to authorize certain APIs used for initialization during this window.
- if ( env == null || env.isEmpty() ) {
- env = "boot";
- }
- if ( ! apiPolicy.getUseAuthClass() ) return; // skip authorization if not enabled
- if ( authorization == null || authorization.isEmpty()) {
- String errmsg = "No basic authorization value provided ";
- err.setMessage(errmsg);
- logger.info( errmsg );
- throw new AuthenticationErrorException( );
- }
- String credentials = authorization.substring("Basic".length()).trim();
+ public void checkAuthorization() throws Exception {
+
+ MDC.put(MDC_KEY_REQUEST_ID, requestId);
+
+ logger.info("request: uri={} method={} auth={}", uri, method, authorization);
+
+ if (uri == null || uri.isEmpty()) {
+ String errmsg = "No URI value provided ";
+ err.setMessage(errmsg);
+ logger.info(errmsg);
+ throw new AuthenticationErrorException();
+ }
+ if (method == null || method.isEmpty()) {
+ String errmsg = "No method value provided ";
+ err.setMessage(errmsg);
+ logger.info(errmsg);
+ throw new AuthenticationErrorException();
+ }
+ DmaapService dmaapService = new DmaapService();
+ Dmaap dmaap = dmaapService.getDmaap();
+ String env = dmaap.getDmaapName();
+
+ // special case during bootstrap of app when DMaaP environment may not be set.
+ // this allows us to authorize certain APIs used for initialization during this window.
+ if (env == null || env.isEmpty()) {
+ env = "boot";
+ }
+ if (!apiPolicy.getUseAuthClass()) {
+ return; // skip authorization if not enabled
+ }
+ if (authorization == null || authorization.isEmpty()) {
+ String errmsg = "No basic authorization value provided ";
+ err.setMessage(errmsg);
+ logger.info(errmsg);
+ throw new AuthenticationErrorException();
+ }
+ String credentials = authorization.substring("Basic".length()).trim();
byte[] decoded = DatatypeConverter.parseBase64Binary(credentials);
String decodedString = new String(decoded);
String[] actualCredentials = decodedString.split(":");
String ID = actualCredentials[0];
String Password = actualCredentials[1];
MDC.put(MDC_PARTNER_NAME, ID);
- try {
-
- DmaapPerm p = new DmaapPerm( apiNamespace + "." + uri, env, method );
- apiPolicy.check( ID, Password, p);
- } catch ( AuthenticationErrorException ae ) {
- String errmsg = "User " + ID + " failed authentication/authorization for " + apiNamespace + "." + uriPath + " " + env + " " + method;
- logger.info( errmsg );
- err.setMessage(errmsg);
- throw ae;
-
- }
-
-
- }
- public String getRequestId() {
- return requestId;
- }
- public ApiService setRequestId(String requestId) {
- if ( requestId == null || requestId.isEmpty()) {
- this.requestId = (new RandomString(10)).nextString();
- logger.warn( "X-ECOMP-RequestID not set in HTTP Header. Setting RequestId value to: " + this.requestId );
- } else {
- this.requestId = requestId;
- }
- MDC.put(MDC_KEY_REQUEST_ID, this.requestId);
- return this;
- }
+ try {
+
+ DmaapPerm p = new DmaapPerm(apiNamespace + "." + uri, env, method);
+ apiPolicy.check(ID, Password, p);
+ } catch (AuthenticationErrorException ae) {
+ String errmsg =
+ "User " + ID + " failed authentication/authorization for " + apiNamespace + "." + uriPath + " " + env
+ + " " + method;
+ logger.info(errmsg);
+ err.setMessage(errmsg);
+ throw ae;
+
+ }
+ }
+
+ public ApiService setRequestId(String requestId) {
+ if (requestId == null || requestId.isEmpty()) {
+ this.requestId = (new RandomString(10)).nextString();
+ logger.warn("X-ECOMP-RequestID not set in HTTP Header. Setting RequestId value to: " + this.requestId);
+ } else {
+ this.requestId = requestId;
+ }
+ MDC.put(MDC_KEY_REQUEST_ID, this.requestId);
+ return this;
+ }
}
+
--- /dev/null
+/*-\r
+ * ============LICENSE_START=======================================================\r
+ * org.onap.dmaap\r
+ * ================================================================================\r
+ * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.\r
+ * ================================================================================\r
+ * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ *\r
+ * http://www.apache.org/licenses/LICENSE-2.0\r
+ *\r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ * ============LICENSE_END=========================================================\r
+ */\r
+package org.onap.dmaap.dbcapi.service;\r
+\r
+import static com.att.eelf.configuration.Configuration.MDC_BEGIN_TIMESTAMP;\r
+import static com.att.eelf.configuration.Configuration.MDC_ELAPSED_TIME;\r
+import static com.att.eelf.configuration.Configuration.MDC_END_TIMESTAMP;\r
+\r
+import java.text.SimpleDateFormat;\r
+import java.util.Date;\r
+import java.util.TimeZone;\r
+import org.slf4j.MDC;\r
+\r
+\r
+public class StopWatch {\r
+\r
+ private static final String ISO_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSZ";\r
+ private final static SimpleDateFormat isoFormatter = new SimpleDateFormat(ISO_FORMAT);\r
+ private final static TimeZone utc = TimeZone.getTimeZone("UTC");\r
+\r
+ private long startTimestamp;\r
+ private long elapsedTime;\r
+\r
+ static {\r
+ isoFormatter.setTimeZone(utc);\r
+ }\r
+\r
+ public void start() {\r
+ startTimestamp = System.currentTimeMillis();\r
+ MDC.put(MDC_BEGIN_TIMESTAMP, isoFormatter.format(new Date(startTimestamp)));\r
+ }\r
+\r
+ public void stop() {\r
+ long endTimestamp = System.currentTimeMillis();\r
+ elapsedTime = endTimestamp - startTimestamp;\r
+ MDC.put(MDC_END_TIMESTAMP, isoFormatter.format(new Date(endTimestamp)));\r
+ MDC.put(MDC_ELAPSED_TIME, String.valueOf(elapsedTime));\r
+ }\r
+\r
+ public void resetElapsedTime() {\r
+ elapsedTime = 0;\r
+ }\r
+\r
+ public long getElapsedTime() {\r
+ return elapsedTime;\r
+ }\r
+}\r
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * PNF-REGISTRATION-HANDLER
+ * ================================================================================
+ * Copyright (C) 2019 NOKIA 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.onap.dmaap.dbcapi.resources;
+
+import org.hamcrest.BaseMatcher;
+import org.hamcrest.Description;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+import org.onap.dmaap.dbcapi.model.ApiError;
+
+import static javax.ws.rs.core.Response.Status.BAD_REQUEST;
+import static org.junit.Assert.fail;
+
+public class RequiredCheckerTest {
+
+ private static final String NAME = "field_name";
+ @Rule
+ public ExpectedException thrown = ExpectedException.none();
+ private RequiredChecker requiredChecker = new RequiredChecker();
+
+
+ @Test
+ public void required_shouldThrowExceptionWhenObjectIsNull() throws RequiredFieldException {
+ thrown.expect(RequiredFieldException.class);
+ thrown.expect(new ApiErrorMatcher(new ApiError(BAD_REQUEST.getStatusCode(),
+ "missing required field", NAME)));
+
+ requiredChecker.required(NAME, null);
+ }
+
+ @Test
+ public void required_shouldThrowExceptionWhenRegexValidationFailed() throws RequiredFieldException {
+ thrown.expect(RequiredFieldException.class);
+ thrown.expect(new ApiErrorMatcher(new ApiError(BAD_REQUEST.getStatusCode(),
+ "value 'with white space' violates regexp check '^\\S+$'", NAME)));
+
+ requiredChecker.required(NAME, "with white space", "^\\S+$");
+ }
+
+ @Test
+ public void required_shouldPassValidation() {
+ try {
+ requiredChecker.required(NAME, "value", "^\\S+$");
+ } catch (RequiredFieldException e) {
+ fail("No exception should be thrown");
+ }
+ }
+
+ class ApiErrorMatcher extends BaseMatcher {
+
+ private final ApiError expectedApiEror;
+
+ ApiErrorMatcher(ApiError expectedApiEror) {
+ this.expectedApiEror = expectedApiEror;
+ }
+
+ @Override
+ public boolean matches(Object exception) {
+ return expectedApiEror.equals(((RequiredFieldException) exception).getApiError());
+ }
+
+ @Override
+ public void describeTo(Description description) {
+ description.appendText("Following ApiError is expected: ").appendValue(expectedApiEror);
+ }
+ }
+}
\ No newline at end of file
rh.reflect( "org.onap.dmaap.dbcapi.service.ApiService", "set", v );
}
-
- @Test
- public void test3() {
- ApiService nd = new ApiService();
- nd.setAuth( "auth" );
- try {
- nd.required( "aName", null, "anExpr" );
- } catch ( RequiredFieldException rfe ) {
- }
- try {
- nd.checkAuthorization( "authval", "/uri/Path", "GET" );
- nd.checkAuthorization();
- } catch ( AuthenticationErrorException aee ) {
- } catch ( Exception e ) {
- }
- }
-
-
}
--- /dev/null
+/*-\r
+ * ============LICENSE_START=======================================================\r
+ * org.onap.dmaap\r
+ * ================================================================================\r
+ * Copyright (C) 2019 Nokia Intellectual Property. All rights reserved.\r
+ * ================================================================================\r
+ * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ *\r
+ * http://www.apache.org/licenses/LICENSE-2.0\r
+ *\r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ * ============LICENSE_END=========================================================\r
+ */\r
+package org.onap.dmaap.dbcapi.service;\r
+\r
+import static org.junit.Assert.assertThat;\r
+import static org.junit.Assert.assertTrue;\r
+import static org.junit.Assert.assertEquals;\r
+import org.junit.Test;\r
+import org.onap.dmaap.dbcapi.logging.BaseLoggingClass;\r
+\r
+public class StopWatchTest extends BaseLoggingClass {\r
+\r
+ private StopWatch stopWatch = new StopWatch();\r
+\r
+ @Test\r
+ public void stopWatchShouldReturnElapsedTime() throws InterruptedException {\r
+ stopWatch.start();\r
+ Thread.sleep(50);\r
+ stopWatch.stop();\r
+ assertTrue(stopWatch.getElapsedTime() > 0);\r
+ }\r
+\r
+ @Test\r
+ public void resetShouldSetElapsedTime() {\r
+ stopWatch.start();\r
+ stopWatch.stop();\r
+ stopWatch.resetElapsedTime();\r
+ assertEquals(0,stopWatch.getElapsedTime());\r
+\r
+ }\r
+\r
+}
\ No newline at end of file
Code Review / dmaap / dbcapi.git / commitdiff