Merge pull request #437 from scouter-project/develop

gunlee01 · web-flow · commit 3d1984a4118e · 2018-02-25T15:26:18.000+09:00
Develop
diff --git a/scouter.document/main/Configuration.md b/scouter.document/main/Configuration.md
@@ -351,6 +351,8 @@ public int sfa_dump_interval_ms = 10000;
 //miscellaneous
 @ConfigDesc("User ID based(0 : Remote Address, 1 : JSessionID, 2 : Scouter Cookie)")
 public int trace_user_mode = 2; // 0:Remote IP, 1:JSessionID, 2:SetCookie
+@ConfigDesc("Setting a cookie path for SCOUTER cookie when trace_user_mode is 2")
+public String trace_user_cookie_path = "/";
 
 @ConfigDesc("Path to file creation directory of process ID file")
 public String counter_object_registry_path = "/tmp/scouter";
diff --git a/scouter.document/main/Configuration_kr.md b/scouter.document/main/Configuration_kr.md
@@ -351,6 +351,8 @@ public int sfa_dump_interval_ms = 10000;
 //miscellaneous
 @ConfigDesc("User ID based(0 : Remote Address, 1 : JSessionID, 2 : Scouter Cookie)")
 public int trace_user_mode = 2; // 0:Remote IP, 1:JSessionID, 2:SetCookie
+@ConfigDesc("Setting a cookie path for SCOUTER cookie when trace_user_mode is 2")
+public String trace_user_cookie_path = "/";
 
 @ConfigDesc("Path to file creation directory of process ID file")
 public String counter_object_registry_path = "/tmp/scouter";
diff --git a/scouter.document/tech/Web-API-Guide.md b/scouter.document/tech/Web-API-Guide.md
@@ -84,8 +84,10 @@ public String net_http_api_auth_ip_header_key;
 
 @ConfigDesc("Enable api access control by JSESSIONID of Cookie")
 public boolean net_http_api_auth_session_enabled = true;
-@ConfigDesc("api http session timeout")
+@ConfigDesc("api http session timeout(sec)")
 public int net_http_api_session_timeout = 3600*24;
+@ConfigDesc("Enable api access control by Bearer token(of Authorization http header) - get access token from /user/loginGetToken.")
+public boolean net_http_api_auth_bearer_token_enabled = false;
 
 @ConfigDesc("api access allow ip addresses")
 @ConfigValueType(ValueType.COMMA_SEPARATED_VALUE)
@@ -399,21 +401,77 @@ public int log_keep_days = 30;
    - `serverId` : (optional if single server)
 
 #### - `GET /v1/kv/{key}`
- - get value of given key from scouter server's key-value store
+ - get value of given key from the scouter server's key-value store. (in the global key space)
  - **Auth** : required
  - **Path params**
    - `key` : (required)
  - **Query params**
    - `serverId` : (optional if single server)
 
 #### - `PUT /v1/kv`
- - set key and value and store it to scouter server's key-value store
+ - store it to the scouter server's key-value store. (in the global key space)
  - **Auth** : required
  - **Request body (type : application/json)**
    - `key` : (required)
    - `value` : (required)
    - `serverId` : (required)
 
+#### - `GET /v1/kv/{keys}/:bulk`
+ - get values of given keys from the scouter server's key-value store. (in the global key space)
+ - **Auth** : required
+ - **Path params**
+   - `keys` : (required) keys by comma separator. also allowed with bracket. eg) mykey-1,mykey2 or [mykey-1,mykey2]
+ - **Query params**
+   - `serverId` : (optional if single server)
+
+#### - `PUT /v1/kv/:bulk`
+ - store key&values to the scouter server's key-value store. (in the global key space)
+ - **Auth** : required
+ - **Request body (type : application/json)**
+   - `kvList` : (required) array of key & value
+      - `key` : (required)
+      - `value` : (required)
+   - `serverId` : (required)
+
+#### - `GET /v1/kv/space/{keySpace}/{key}`
+ - get value of given key from the key space of scouter server's key-value store.
+ - **Auth** : required
+ - **Path params**
+   - `keySpace` : (required)
+   - `key` : (required)
+ - **Query params**
+   - `serverId` : (optional if single server)
+
+#### - `PUT /v1/kv/space/{keySpace}`
+ - store it to the key space of scouter server's key-value store
+ - **Auth** : required
+ - **Path params**
+    - `keySpace` : (required)
+ - **Request body (type : application/json)**
+   - `key` : (required)
+   - `value` : (required)
+   - `serverId` : (required)
+
+#### - `GET /v1/kv/space/{keySpace}/{keys}/:bulk`
+ - get values of given keys from the key space of scouter server's key-value store
+ - **Auth** : required
+ - **Path params**
+   - `keySpace` : (required)
+   - `keys` : (required) keys by comma separator. also allowed with bracket. eg) mykey-1,mykey2 or [mykey-1,mykey2]
+ - **Query params**
+   - `serverId` : (optional if single server)
+
+#### - `PUT /v1/kv/space/{keySpace}/:bulk`
+ - store key&values to the key space of scouter server's key-value store
+ - **Auth** : required
+ - **Path params**
+    - `keySpace` : (required)
+ - **Request body (type : application/json)**
+   - `kvList` : (required) array of key & value
+      - `key` : (required)
+      - `value` : (required)
+   - `serverId` : (required)
+
 #### - `GET /v1/object/host/realTime/top/ofObject/{objHash}`
  - retrieve all OS processes cpu, memory usage of the given object
  - **Auth** : required
@@ -422,6 +480,23 @@ public int log_keep_days = 30;
  - **Query params**
    - `serverId` : (optional if single server)
 
+#### - `PUT /v1/user/loginGetToken`
+ - login with id & password, and get bearer token.
+   - this token required on Authorization header for authorized request.
+     - auth header example : `Authorization: Bearer V1.B3R4FSGEF3POJ.me`
+ - **Auth** : none
+ - **Request body (type : application/json)**
+   - `user` : (required)
+     - `id` : (required)
+     - `password` : (required)
+   - `serverId` : (required)
 
-
-
+#### - `PUT /v1/user/login`
+ - login with id & password for traditional web application.
+   - this api is answered including with SET-COOKIE response header.
+ - **Auth** : none
+ - **Request body (type : application/json)**
+   - `user` : (required)
+     - `id` : (required)
+     - `password` : (required)
+   - `serverId` : (required)
diff --git a/scouter.document/tech/Web-API-Guide_kr.md b/scouter.document/tech/Web-API-Guide_kr.md
@@ -66,6 +66,7 @@ If you include this widget path when setting up a custom alarm, you can use it m
 
 ## Configuration
 ```java
+
 @ConfigDesc("Collector connection infos - eg) host:6100:id:pw,host2:6100:id2:pw2")
 @ConfigValueType(ValueType.COMMA_SEPARATED_VALUE)
 public String net_collector_ip_port_id_pws = "127.0.0.1:6100:admin:admin";
@@ -82,8 +83,10 @@ public String net_http_api_auth_ip_header_key;
 
 @ConfigDesc("Enable api access control by JSESSIONID of Cookie")
 public boolean net_http_api_auth_session_enabled = true;
-@ConfigDesc("api http session timeout")
+@ConfigDesc("api http session timeout(sec)")
 public int net_http_api_session_timeout = 3600*24;
+@ConfigDesc("Enable api access control by Bearer token(of Authorization http header) - get access token from /user/loginGetToken.")
+public boolean net_http_api_auth_bearer_token_enabled = false;
 
 @ConfigDesc("api access allow ip addresses")
 @ConfigValueType(ValueType.COMMA_SEPARATED_VALUE)
@@ -397,21 +400,77 @@ public int log_keep_days = 30;
    - `serverId` : (optional if single server)
 
 #### - `GET /v1/kv/{key}`
- - get value of given key from scouter server's key-value store
+ - get value of given key from the scouter server's key-value store. (in the global key space)
  - **Auth** : required
  - **Path params**
    - `key` : (required)
  - **Query params**
    - `serverId` : (optional if single server)
 
 #### - `PUT /v1/kv`
- - set key and value and store it to scouter server's key-value store
+ - store it to the scouter server's key-value store. (in the global key space)
  - **Auth** : required
  - **Request body (type : application/json)**
    - `key` : (required)
    - `value` : (required)
    - `serverId` : (required)
 
+#### - `GET /v1/kv/{keys}/:bulk`
+ - get values of given keys from the scouter server's key-value store. (in the global key space)
+ - **Auth** : required
+ - **Path params**
+   - `keys` : (required) keys by comma separator. also allowed with bracket. eg) mykey-1,mykey2 or [mykey-1,mykey2]
+ - **Query params**
+   - `serverId` : (optional if single server)
+
+#### - `PUT /v1/kv/:bulk`
+ - store key&values to the scouter server's key-value store. (in the global key space)
+ - **Auth** : required
+ - **Request body (type : application/json)**
+   - `kvList` : (required) array of key & value
+      - `key` : (required)
+      - `value` : (required)
+   - `serverId` : (required)
+
+#### - `GET /v1/kv/space/{keySpace}/{key}`
+ - get value of given key from the key space of scouter server's key-value store.
+ - **Auth** : required
+ - **Path params**
+   - `keySpace` : (required)
+   - `key` : (required)
+ - **Query params**
+   - `serverId` : (optional if single server)
+
+#### - `PUT /v1/kv/space/{keySpace}`
+ - store it to the key space of scouter server's key-value store
+ - **Auth** : required
+ - **Path params**
+    - `keySpace` : (required)
+ - **Request body (type : application/json)**
+   - `key` : (required)
+   - `value` : (required)
+   - `serverId` : (required)
+
+#### - `GET /v1/kv/space/{keySpace}/{keys}/:bulk`
+ - get values of given keys from the key space of scouter server's key-value store
+ - **Auth** : required
+ - **Path params**
+   - `keySpace` : (required)
+   - `keys` : (required) keys by comma separator. also allowed with bracket. eg) mykey-1,mykey2 or [mykey-1,mykey2]
+ - **Query params**
+   - `serverId` : (optional if single server)
+
+#### - `PUT /v1/kv/space/{keySpace}/:bulk`
+ - store key&values to the key space of scouter server's key-value store
+ - **Auth** : required
+ - **Path params**
+    - `keySpace` : (required)
+ - **Request body (type : application/json)**
+   - `kvList` : (required) array of key & value
+      - `key` : (required)
+      - `value` : (required)
+   - `serverId` : (required)
+
 #### - `GET /v1/object/host/realTime/top/ofObject/{objHash}`
  - retrieve all OS processes cpu, memory usage of the given object
  - **Auth** : required
@@ -420,6 +479,23 @@ public int log_keep_days = 30;
  - **Query params**
    - `serverId` : (optional if single server)
 
+#### - `PUT /v1/user/loginGetToken`
+ - login with id & password, and get bearer token.
+   - this token required on Authorization header for authorized request.
+     - auth header example : `Authorization: Bearer V1.B3R4FSGEF3POJ.me`
+ - **Auth** : none
+ - **Request body (type : application/json)**
+   - `user` : (required)
+     - `id` : (required)
+     - `password` : (required)
+   - `serverId` : (required)
 
-
-
+#### - `PUT /v1/user/login`
+ - login with id & password for traditional web application.
+   - this api is answered including with SET-COOKIE response header.
+ - **Auth** : none
+ - **Request body (type : application/json)**
+   - `user` : (required)
+     - `id` : (required)
+     - `password` : (required)
+   - `serverId` : (required)
diff --git a/scouter.webapp/src/main/java/scouterx/webapp/layer/controller/ProfileController.java b/scouter.webapp/src/main/java/scouterx/webapp/layer/controller/ProfileController.java
@@ -18,11 +18,12 @@
 
 package scouterx.webapp.layer.controller;
 
+import io.swagger.annotations.Api;
 import lombok.extern.slf4j.Slf4j;
 import scouter.lang.step.Step;
-import scouterx.webapp.view.CommonResultView;
-import scouterx.webapp.request.ProfileRequest;
 import scouterx.webapp.layer.service.ProfileService;
+import scouterx.webapp.request.ProfileRequest;
+import scouterx.webapp.view.CommonResultView;
 
 import javax.inject.Singleton;
 import javax.validation.Valid;
@@ -37,6 +38,7 @@
  * @author Gun Lee (gunlee01@gmail.com) on 2017. 9. 3.
  */
 @Path("/v1/profile")
+@Api("Raw profile")
 @Singleton
 @Produces(MediaType.APPLICATION_JSON)
 @Slf4j
diff --git a/scouter.webapp/src/main/java/scouterx/webapp/layer/controller/UserController.java b/scouter.webapp/src/main/java/scouterx/webapp/layer/controller/UserController.java
@@ -18,6 +18,7 @@
 
 package scouterx.webapp.layer.controller;
 
+import io.swagger.annotations.Api;
 import scouterx.webapp.framework.annotation.NoAuth;
 import scouterx.webapp.framework.client.server.Server;
 import scouterx.webapp.framework.client.server.ServerManager;
@@ -32,7 +33,6 @@
 import javax.inject.Singleton;
 import javax.servlet.http.HttpServletRequest;
 import javax.validation.Valid;
-import javax.ws.rs.BeanParam;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.POST;
 import javax.ws.rs.Path;
@@ -47,6 +47,7 @@
  * @author Gun Lee (gunlee01@gmail.com) on 2017. 8. 27.
  */
 @Path("/v1/user")
+@Api("User")
 @Singleton
 @Produces(MediaType.APPLICATION_JSON)
 public class UserController {
@@ -64,7 +65,7 @@ public class UserController {
     @NoAuth
     @POST @Path("/login")
     @Consumes(MediaType.APPLICATION_JSON)
-    public CommonResultView<Boolean> login(@BeanParam @Valid final LoginRequest loginRequest) {
+    public CommonResultView<Boolean> login(@Valid final LoginRequest loginRequest) {
         userService.login(ServerManager.getInstance().getServer(loginRequest.getServerId()), loginRequest.getUser());
         servletRequest.getSession(true).setAttribute("user", new SUser(loginRequest.getUser().getId()));
 
diff --git a/scouter.webapp/src/main/java/scouterx/webapp/layer/controller/XLogController.java b/scouter.webapp/src/main/java/scouterx/webapp/layer/controller/XLogController.java
@@ -19,6 +19,7 @@
 package scouterx.webapp.layer.controller;
 
 import com.fasterxml.jackson.core.JsonGenerator;
+import io.swagger.annotations.Api;
 import lombok.extern.slf4j.Slf4j;
 import scouter.lang.constants.ParamConstant;
 import scouter.lang.pack.MapPack;
@@ -55,6 +56,7 @@
  * @author Gun Lee (gunlee01@gmail.com) on 2017. 8. 29.
  */
 @Path("/v1/xlog")
+@Api("Raw xlog")
 @Singleton
 @Produces(MediaType.APPLICATION_JSON)
 @Slf4j
diff --git a/scouter.webapp/src/main/java/scouterx/webapp/swagger/Bootstrap.java b/scouter.webapp/src/main/java/scouterx/webapp/swagger/Bootstrap.java
@@ -1,6 +1,10 @@
 package scouterx.webapp.swagger;
 
 import io.swagger.jaxrs.config.BeanConfig;
+import io.swagger.jaxrs.config.SwaggerContextService;
+import io.swagger.models.Swagger;
+import io.swagger.models.auth.ApiKeyAuthDefinition;
+import io.swagger.models.auth.In;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
 import scouterx.webapp.framework.configure.ConfigureAdaptor;
@@ -43,5 +47,10 @@ public void init(ServletConfig config) throws ServletException {
         beanConfig.setResourcePackage("scouterx.webapp");
         beanConfig.setFilterClass(this.filterClass);
         beanConfig.setScan(true);
+
+        Swagger swagger = new Swagger();
+        swagger.securityDefinition("Scouter auth token", new ApiKeyAuthDefinition("Authorization", In.HEADER));
+        new SwaggerContextService().withServletConfig(config).updateSwagger(swagger);
+
     }
 }
