Extract class StopWatch from ApiService 06/82906/5
authorPawel <pawel.kasperkiewicz@nokia.com>
Thu, 21 Mar 2019 09:33:21 +0000 (05:33 -0400)
committerPawel <pawel.kasperkiewicz@nokia.com>
Thu, 21 Mar 2019 13:38:46 +0000 (09:38 -0400)
Issue-ID: DMAAP-1109

Change-Id: I05f706b8f2e7fe0ceb632ddb008c897b32f576b2
Signed-off-by: Pawel <pawel.kasperkiewicz@nokia.com>
src/main/java/org/onap/dmaap/dbcapi/service/ApiService.java
src/main/java/org/onap/dmaap/dbcapi/service/StopWatch.java [new file with mode: 0644]
src/test/java/org/onap/dmaap/dbcapi/service/StopWatchTest.java [new file with mode: 0644]

index 23f4fef..b2eee6f 100644 (file)
@@ -7,9 +7,9 @@
  * 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;
@@ -48,233 +40,199 @@ 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() );
-       }
-
-
-       public void setCode(int statusCode) {
-               err.setCode(statusCode);
-       }
-
-
-       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();
+
+    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;
+    }
+
+
+    // 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());
+    }
+
+
+    public void setCode(int statusCode) {
+        err.setCode(statusCode);
+    }
+
+
+    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();
         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 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;
+    }
 }
diff --git a/src/main/java/org/onap/dmaap/dbcapi/service/StopWatch.java b/src/main/java/org/onap/dmaap/dbcapi/service/StopWatch.java
new file mode 100644 (file)
index 0000000..6dc8fe9
--- /dev/null
@@ -0,0 +1,64 @@
+/*-\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
diff --git a/src/test/java/org/onap/dmaap/dbcapi/service/StopWatchTest.java b/src/test/java/org/onap/dmaap/dbcapi/service/StopWatchTest.java
new file mode 100644 (file)
index 0000000..b4b6af2
--- /dev/null
@@ -0,0 +1,49 @@
+/*-\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