; Fri, 2 Aug 2019 14:41:16 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: svn commit: r1048296 [9/9] - in /websites/production/openwebbeans/content/meecrowave: ./ assets/css/ assets/plugins/ assets/plugins/elegant_font/css/ assets/plugins/font-awesome/css/ meecrowave-core/ meecrowave-gradle/ meecrowave-jolokia/ meecrowave-jp... Date: Fri, 02 Aug 2019 14:41:15 -0000 To: commits@openwebbeans.apache.org From: struberg@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20190802144116.64FFF3A3926@svn01-us-west.apache.org> Modified: websites/production/openwebbeans/content/meecrowave/meecrowave-oauth2/index.html ============================================================================== --- websites/production/openwebbeans/content/meecrowave/meecrowave-oauth2/index.html (original) +++ websites/production/openwebbeans/content/meecrowave/meecrowave-oauth2/index.html Fri Aug 2 14:41:14 2019 @@ -18,7 +18,7 @@ - + @@ -66,310 +66,322 @@

Starting with version 0.3.0.

Coordinates:

<dependency>
+                
+
+
+Starting with version 0.3.0.
+
+
+Coordinates:
+
+
+
+<dependency>
   <groupId>org.apache.meecrowave</groupId>
   <artifactId>meecrowave-oauth2</artifactId>
   <version>${meecrowave.version}</version>
-</dependency> 
-    
-   
-   
-   A small OAuth2 server based on CXF implementation. 
-   
-   
-   See https://cxf.apache.org/docs/jax-rs-oauth2.html for more details.
-   
-   
-   Here is the current configuration (mainly based on CXF one): 
-   
-   
-   -    -    -    
-    
-     
-      
-      
-     
-    
-    
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-     
-      
-      
-     
-    
-   
 
 
Name Description
--oauth2-access-token-lifetime How long an access token is valid, default to 3600s
--oauth2-authorization-code-support Is authorization code flow supported
--oauth2-block-unsecure-requests Should unsecured requests be blocked
--oauth2-client-force Is a client mandatory or can a token be issued without any client
--oauth2-default-scopes Comma separated list of default scopes
--oauth2-encrypted-algorithm The algorithm for the key for the encrypted provider
--oauth2-encrypted-key The key for encrypted provider
--oauth2-invisible-scopes Comma separated list of invisible to client scopes
--oauth2-jcache-config JCache configuration uri for the cache manager (jcache or provider)
--oauth2-jcache-jmx Should JCache JMX MBeans be enabled
--oauth2-jcache-loader The loader bean or class name
--oauth2-jcache-statistics Should JCache statistics be enabled
--oauth2-jcache-store-jwt-token-key-only Should JCache store jwt token key only (jcache provider)
--oauth2-jcache-store-value Should JCache store value or not
--oauth2-jcache-writer The writer bean or class name
--oauth2-jpa-database-driver JPA database driver for jpa provider
--oauth2-jpa-database-password JPA database password for jpa provider
--oauth2-jpa-database-url JPA database url for jpa provider
--oauth2-jpa-database-username JPA database username for jpa provider
--oauth2-jpa-max-active JPA max active connections for jpa provider
--oauth2-jpa-max-idle JPA max idle connections for jpa provider
--oauth2-jpa-max-wait JPA max wait for connections for jpa provider
--oauth2-jpa-properties JPA persistence unit properties for jpa provider
--oauth2-jpa-test-on-borrow should connections be tested on borrow for jpa provider
--oauth2-jpa-test-on-return should connections be tested on return for jpa provider
--oauth2-jpa-validation-interval validation interval for jpa provider
--oauth2-jpa-validation-query validation query for jpa provider
--oauth2-jwt-access-token-claim-map The jwt claims configuration
--oauth2-partial-match-scope-validation Is partial match for scope validation activated
--oauth2-provider Which provider type to use: jcache[-code], jpa[-code], encrypted[-code]
--oauth2-redirection-match-redirect-uri-with-application-uri For authorization code flow, should redirect uri be matched with application one
--oauth2-redirection-max-default-session-interval For authorization code flow, how long a session can be
--oauth2-redirection-scopes-requiring-no-consent For authorization code flow, the scopes using no consent
--oauth2-redirection-use-registered-redirect-uri-if-possible For authorization code flow, should the registered uri be used
--oauth2-refresh-token Is issuing of access token issuing a refreh token too
--oauth2-refresh-token-lifetime How long a refresh token is valid, default to eternity (0)
--oauth2-refresh-token-recycling Should refresh token be recycled
--oauth2-required-scopes Comma separated list of required scopes
--oauth2-support-pre-authorized-tokens Are pre-authorized token supported
--oauth2-support-public-client Are public clients supported
--oauth2-token-support Are token flows supported
--oauth2-use-all-client-scopes Are all client scopes used for refresh tokens
--oauth2-use-jaas Should jaas be used - alternative (default) is to delegate to meecrowave/tomcat realms
--oauth2-use-jwt-format-for-access-token Should access token be jwt?
--oauth2-write-custom-errors Should custom errors be written
--oauth2-write-optional-parameters Should optional parameters be written 
-   
-   These options are available through the CLI or through properties as usually with Meecrowave configuration. 
-   
-   
-   Note that meecrowave also provides a bundle which is an executable jar to run an OAuth2 server. 
-   
-   
-   Here is a sample usage of that bundle: 
-   
-   
-    
-    java -jar meecrowave-oauth2-0.3.1-bundle.jar --users test=test --roles test=test 
-    
-   
-   
-   Then just test your token endpoint: 
-   
-   
-    
-    curl -XPOST http://localhost:8080/oauth2/token -d username=test -d password=test -d grant_type=password 
-    
-   
-   
-   And you should get something like: 
-   
-   
-    
-    {
+</dependency>
+
+
+
+A small OAuth2 server based on CXF implementation.
+
+
+See http://cxf.apache.org/docs/jax-rs-oauth2.html for more details.
+
+
+Here is the current configuration (mainly based on CXF one):
+
+
++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+


Name Description
--oauth2-access-token-lifetime How long an access token is valid, default to 3600s
--oauth2-authorization-code-support Is authorization code flow supported
--oauth2-block-unsecure-requests Should unsecured requests be blocked
--oauth2-client-force Is a client mandatory or can a token be issued without any client
--oauth2-default-scopes Comma separated list of default scopes
--oauth2-encrypted-algorithm The algorithm for the key for the encrypted provider
--oauth2-encrypted-key The key for encrypted provider
--oauth2-invisible-scopes Comma separated list of invisible to client scopes
--oauth2-jcache-config JCache configuration uri for the cache manager (jcache or provider)
--oauth2-jcache-jmx Should JCache JMX MBeans be enabled
--oauth2-jcache-loader The loader bean or class name
--oauth2-jcache-statistics Should JCache statistics be enabled
--oauth2-jcache-store-jwt-token-key-only Should JCache store jwt token key only (jcache provider)
--oauth2-jcache-store-value Should JCache store value or not
--oauth2-jcache-writer The writer bean or class name
--oauth2-jpa-database-driver JPA database driver for jpa provider
--oauth2-jpa-database-password JPA database password for jpa provider
--oauth2-jpa-database-url JPA database url for jpa provider
--oauth2-jpa-database-username JPA database username for jpa provider
--oauth2-jpa-max-active JPA max active connections for jpa provider
--oauth2-jpa-max-idle JPA max idle connections for jpa provider
--oauth2-jpa-max-wait JPA max wait for connections for jpa provider
--oauth2-jpa-properties JPA persistence unit properties for jpa provider
--oauth2-jpa-test-on-borrow should connections be tested on borrow for jpa provider
--oauth2-jpa-test-on-return should connections be tested on return for jpa provider
--oauth2-jpa-validation-interval validation interval for jpa provider
--oauth2-jpa-validation-query validation query for jpa provider
--oauth2-jwt-access-token-claim-map The jwt claims configuration
--oauth2-jwt-issuer The jwt issuer (ignored if not set)
--oauth2-partial-match-scope-validation Is partial match for scope validation activated
--oauth2-provider Which provider type to use: jcache[-code], jpa[-code], encrypted[-code]
--oauth2-redirection-match-redirect-uri-with-application-uri For authorization code flow, should redirect uri be matched with application one
--oauth2-redirection-max-default-session-interval For authorization code flow, how long a session can be
--oauth2-redirection-scopes-requiring-no-consent For authorization code flow, the scopes using no consent
--oauth2-redirection-use-registered-redirect-uri-if-possible For authorization code flow, should the registered uri be used
--oauth2-refresh-token Is issuing of access token issuing a refreh token too
--oauth2-refresh-token-lifetime How long a refresh token is valid, default to eternity (0)
--oauth2-refresh-token-recycling Should refresh token be recycled
--oauth2-required-scopes Comma separated list of required scopes
--oauth2-support-pre-authorized-tokens Are pre-authorized token supported
--oauth2-support-public-client Are public clients supported
--oauth2-token-support Are token flows supported
--oauth2-use-all-client-scopes Are all client scopes used for refresh tokens
--oauth2-use-jaas Should jaas be used - alternative (default) is to delegate to meecrowave/tomcat realms
--oauth2-use-jwt-format-for-access-token Should access token be jwt?
--oauth2-write-custom-errors Should custom errors be written
--oauth2-write-optional-parameters Should optional parameters be written
+
+These options are available through the CLI or through properties as usually with Meecrowave configuration.
+
+
+Note that meecrowave also provides a bundle which is an executable jar to run an OAuth2 server.
+
+
+Here is a sample usage of that bundle:
+
+
+
+java -jar meecrowave-oauth2-0.3.1-bundle.jar --users test=test --roles test=test
+
+
+
+Then just test your token endpoint:
+
+
+
+curl -XPOST http://localhost:8080/oauth2/token -d username=test -d password=test -d grant_type=password
+
+
+
+And you should get something like:
+
+
+
+{
   "access_token":"5e2f211d4b4ccaa36a11d0876597f01e",
   "token_type":"Bearer",
   "expires_in":3600,
   "scope":"refreshToken",
   "refresh_token":"7ae5dc2e25925e5514b7e2e632cfa6a"
-} 
-    
-   
-   
-    
-    
-      
-       
-       
-      
-    
-      these example use inline users but you should configure a realm for a real usage.  
-   
-   
-    
-    
-      
-       
-       
-      
-    
-      this module is interesting if you plan to base your application development on Meecrowave because it shows how to use CLI configuration and wire it in your application but also how to use a 3rd party library (CXF there) and build a fatjar.  
-   
-  
- 
- 
- Authorization code case 
-  
-   
-   Authorization code flow is a bit more complicated but services (endpoints) can be activated (see configuration - --oauth2-authorization-code-support). 
-   
-   
-   You will need to configure CXF to point to the keystore/key to crypt/sign the token in session. It is properties based. All CXF properties (rs.security.) are supported but prefixed with oauth2.cxf. to avoid to mix it with another configuration starting with rs.. 
-   
-   
-   For instance you can use: 
-   
-   
-    
-    oauth2.cxf.rs.security.keystore.type = jks
+}
+
+
+
+
+
+
+
+
+
+
+ 
+these example use inline users but you should configure a realm for a real usage.
+
+
+
+
+
+
+
+
+
+
+ 
+this module is interesting if you plan to base your application development
+on Meecrowave because it shows how to use CLI configuration and wire it in your application
+but also how to use a 3rd party library (CXF there) and build a fatjar.
+
+
+
+
+
+Authorization code case
+
+
+Authorization code flow is a bit more complicated but services (endpoints) can be activated (see configuration - --oauth2-authorization-code-support).
+
+
+You will need to configure CXF to point to the keystore/key to crypt/sign the token in session.
+It is properties based. All CXF properties (rs.security.) are supported but prefixed with oauth2.cxf. to avoid
+to mix it with another configuration starting with rs..
+
+
+For instance you can use:
+
+
+
+oauth2.cxf.rs.security.keystore.type = jks
 oauth2.cxf.rs.security.keystore.file = /opt/keystores/oauth2.jks
 oauth2.cxf.rs.security.keystore.password = password
 oauth2.cxf.rs.security.keystore.alias = alice
-oauth2.cxf.rs.security.key.password = pwd 
-    
-   
-  
+oauth2.cxf.rs.security.key.password = pwd

Name	Description
--oauth2-access-token-lifetime	How long an access token is valid, default to 3600s
--oauth2-authorization-code-support	Is authorization code flow supported
--oauth2-block-unsecure-requests	Should unsecured requests be blocked
--oauth2-client-force	Is a client mandatory or can a token be issued without any client
--oauth2-default-scopes	Comma separated list of default scopes
--oauth2-encrypted-algorithm	The algorithm for the key for the encrypted provider
--oauth2-encrypted-key	The key for encrypted provider
--oauth2-invisible-scopes	Comma separated list of invisible to client scopes
--oauth2-jcache-config	JCache configuration uri for the cache manager (jcache or provider)
--oauth2-jcache-jmx	Should JCache JMX MBeans be enabled
--oauth2-jcache-loader	The loader bean or class name
--oauth2-jcache-statistics	Should JCache statistics be enabled
--oauth2-jcache-store-jwt-token-key-only	Should JCache store jwt token key only (jcache provider)
--oauth2-jcache-store-value	Should JCache store value or not
--oauth2-jcache-writer	The writer bean or class name
--oauth2-jpa-database-driver	JPA database driver for jpa provider
--oauth2-jpa-database-password	JPA database password for jpa provider
--oauth2-jpa-database-url	JPA database url for jpa provider
--oauth2-jpa-database-username	JPA database username for jpa provider
--oauth2-jpa-max-active	JPA max active connections for jpa provider
--oauth2-jpa-max-idle	JPA max idle connections for jpa provider
--oauth2-jpa-max-wait	JPA max wait for connections for jpa provider
--oauth2-jpa-properties	JPA persistence unit properties for jpa provider
--oauth2-jpa-test-on-borrow	should connections be tested on borrow for jpa provider
--oauth2-jpa-test-on-return	should connections be tested on return for jpa provider
--oauth2-jpa-validation-interval	validation interval for jpa provider
--oauth2-jpa-validation-query	validation query for jpa provider
--oauth2-jwt-access-token-claim-map	The jwt claims configuration
--oauth2-partial-match-scope-validation	Is partial match for scope validation activated
--oauth2-provider	Which provider type to use: jcache[-code], jpa[-code], encrypted[-code]
--oauth2-redirection-match-redirect-uri-with-application-uri	For authorization code flow, should redirect uri be matched with application one
--oauth2-redirection-max-default-session-interval	For authorization code flow, how long a session can be
--oauth2-redirection-scopes-requiring-no-consent	For authorization code flow, the scopes using no consent
--oauth2-redirection-use-registered-redirect-uri-if-possible	For authorization code flow, should the registered uri be used
--oauth2-refresh-token	Is issuing of access token issuing a refreh token too
--oauth2-refresh-token-lifetime	How long a refresh token is valid, default to eternity (0)
--oauth2-refresh-token-recycling	Should refresh token be recycled
--oauth2-required-scopes	Comma separated list of required scopes
--oauth2-support-pre-authorized-tokens	Are pre-authorized token supported
--oauth2-support-public-client	Are public clients supported
--oauth2-token-support	Are token flows supported
--oauth2-use-all-client-scopes	Are all client scopes used for refresh tokens
--oauth2-use-jaas	Should jaas be used - alternative (default) is to delegate to meecrowave/tomcat realms
--oauth2-use-jwt-format-for-access-token	Should access token be jwt?
--oauth2-write-custom-errors	Should custom errors be written
--oauth2-write-optional-parameters	Should optional parameters be written

Name	Description
--oauth2-access-token-lifetime	How long an access token is valid, default to 3600s
--oauth2-authorization-code-support	Is authorization code flow supported
--oauth2-block-unsecure-requests	Should unsecured requests be blocked
--oauth2-client-force	Is a client mandatory or can a token be issued without any client
--oauth2-default-scopes	Comma separated list of default scopes
--oauth2-encrypted-algorithm	The algorithm for the key for the encrypted provider
--oauth2-encrypted-key	The key for encrypted provider
--oauth2-invisible-scopes	Comma separated list of invisible to client scopes
--oauth2-jcache-config	JCache configuration uri for the cache manager (jcache or provider)
--oauth2-jcache-jmx	Should JCache JMX MBeans be enabled
--oauth2-jcache-loader	The loader bean or class name
--oauth2-jcache-statistics	Should JCache statistics be enabled
--oauth2-jcache-store-jwt-token-key-only	Should JCache store jwt token key only (jcache provider)
--oauth2-jcache-store-value	Should JCache store value or not
--oauth2-jcache-writer	The writer bean or class name
--oauth2-jpa-database-driver	JPA database driver for jpa provider
--oauth2-jpa-database-password	JPA database password for jpa provider
--oauth2-jpa-database-url	JPA database url for jpa provider
--oauth2-jpa-database-username	JPA database username for jpa provider
--oauth2-jpa-max-active	JPA max active connections for jpa provider
--oauth2-jpa-max-idle	JPA max idle connections for jpa provider
--oauth2-jpa-max-wait	JPA max wait for connections for jpa provider
--oauth2-jpa-properties	JPA persistence unit properties for jpa provider
--oauth2-jpa-test-on-borrow	should connections be tested on borrow for jpa provider
--oauth2-jpa-test-on-return	should connections be tested on return for jpa provider
--oauth2-jpa-validation-interval	validation interval for jpa provider
--oauth2-jpa-validation-query	validation query for jpa provider
--oauth2-jwt-access-token-claim-map	The jwt claims configuration
--oauth2-jwt-issuer	The jwt issuer (ignored if not set)
--oauth2-partial-match-scope-validation	Is partial match for scope validation activated
--oauth2-provider	Which provider type to use: jcache[-code], jpa[-code], encrypted[-code]
--oauth2-redirection-match-redirect-uri-with-application-uri	For authorization code flow, should redirect uri be matched with application one
--oauth2-redirection-max-default-session-interval	For authorization code flow, how long a session can be
--oauth2-redirection-scopes-requiring-no-consent	For authorization code flow, the scopes using no consent
--oauth2-redirection-use-registered-redirect-uri-if-possible	For authorization code flow, should the registered uri be used
--oauth2-refresh-token	Is issuing of access token issuing a refreh token too
--oauth2-refresh-token-lifetime	How long a refresh token is valid, default to eternity (0)
--oauth2-refresh-token-recycling	Should refresh token be recycled
--oauth2-required-scopes	Comma separated list of required scopes
--oauth2-support-pre-authorized-tokens	Are pre-authorized token supported
--oauth2-support-public-client	Are public clients supported
--oauth2-token-support	Are token flows supported
--oauth2-use-all-client-scopes	Are all client scopes used for refresh tokens
--oauth2-use-jaas	Should jaas be used - alternative (default) is to delegate to meecrowave/tomcat realms
--oauth2-use-jwt-format-for-access-token	Should access token be jwt?
--oauth2-write-custom-errors	Should custom errors be written
--oauth2-write-optional-parameters	Should optional parameters be written

@@ -397,8 +409,8 @@ oauth2.cxf.rs.security.key.password = pw

@@ -413,10 +425,13 @@ oauth2.cxf.rs.security.key.password = pw - + + + + + - Modified: websites/production/openwebbeans/content/meecrowave/meecrowave-oauth2/index.pdf ============================================================================== Binary files - no diff available. Added: websites/production/openwebbeans/content/meecrowave/meecrowave-proxy/index.html ============================================================================== --- websites/production/openwebbeans/content/meecrowave/meecrowave-proxy/index.html (added) +++ websites/production/openwebbeans/content/meecrowave/meecrowave-proxy/index.html Fri Aug 2 14:41:14 2019 @@ -0,0 +1,317 @@ + + + + + + Meecrowave :: the customizable server + + + + + + + + + + + + + + + + + + + + + + + +

+ +

+ + + Meecrowave + +

Meecrowave Proxy

+ +

+ + + + + + + + +

Coordinates:

<dependency>
+  <groupId>org.apache.meecrowave</groupId>
+  <artifactId>meecrowave-proxy</artifactId>
+  <version>${meecrowave.version}</version>
+</dependency>

Simple proxy module using Meecrowave as backbone. +It can be extended using CDI programming model and JAX-RS client.

Configuration

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name

Description

--proxy-async-timeout

Asynchronous execution timeout.

--proxy-configuration

The route file.

--proxy-mapping

Where to bind the proxy (url pattern).

--proxy-multipart

Is multipart explicit.

--proxy-multipart-maxfilesizethreshold

Max file size threshold for multipart requests.

--proxy-multipart-location

The multipart temporary folder.

--proxy-multipart-maxfilesize

Max file size for multipart requests.

--proxy-multipart-maxrequestsize

Max request size for multipart requests.

--proxy-skip

Should default setup be ignored

+ + + + + +

+ +	+you can use that servlet in a plain Servlet container (adding JAX-RS+JSON-B client). +An integration example can be found in `org.apache.meecrowave.proxy.servlet.meecrowave.ProxyServletSetup#accept`. +

Configuration File

Each route defines an execution context which means:

+
A way to match the incoming request (by method + prefix for now),
+
+
A way to forward the incoming request (which target server is called),
+
+
A way to execute the request isolated in a dedicated thread (how many threads are allocated to the route, which timeout to use, …).
+

The routes file follows the following shape:

{
+  "defaultRoute": { // optional
+    // ... anything a route can get, it is used as default for plain "routes"
+  },
+  "routes": [
+    {
+      "id": "get-simple",
+      "requestConfiguration": {
+        "method": "GET",
+        "prefix": "/prefix-to-match",
+        "addedHeaders" : { "Authorization": "Value", ... },
+        "skippedHeaders" : [ "Content-Length", ... ],
+        "skippedCookies" : [ "Cookie", ... ],
+      },
+      "responseConfiguration": {
+        "target": "http://....",
+        "skippedHeaders" : [ "Content-Length", ... ],
+        "skippedCookies" : [ "Cookie", ... ],
+      },
+      "clientConfiguration": {
+        "executor": {
+            "core": 8,
+            "max": 512,
+            "keepAlive": 60000,
+            "shutdownTimeout": 1
+        },
+        "timeouts": {
+            "connect": 30000,
+            "read": 30000,
+            "execution": 60000
+        },
+        "sslConfiguration": {
+            "acceptAnyCertificate": false,
+            "keystoreLocation": "...",
+            "keystoreType": "...",
+            "keystorePassword": "...",
+            "truststoreType": "...",
+            "verifiedHostnames": ["..."]
+        }
+      },
+      "extensions": { // optional, used for custom extensions and let the user enrich the route configuration
+      }
+    },
+    // ...
+  ],
+  "extensions": { // optional
+  }
+}

+ + + + + +

+ +	+the file is filtered with system properties so you can use `${system-prop-key}`. +

Extend

The default implementation uses CDIProxyServlet which triggers multiple events to let you extend the proxy implementation:

+
BeforeRequest and AfterResponse which are sent around the proxying,
+
+
OnRequest and OnResponse which enables you to replace the way the request is mapped to the proxied server and the way the response of the proxied server is mapped to the client.
+

Since meecrowave-proxy is a simple meecrowave module you can embed it and customize it as any CDI application.

+ + + + +

+ + +

+ +

+ + + + + + + + + + + + + + + + + + Propchange: websites/production/openwebbeans/content/meecrowave/meecrowave-proxy/index.html ------------------------------------------------------------------------------ svn:eol-style = native Added: websites/production/openwebbeans/content/meecrowave/meecrowave-proxy/index.pdf ============================================================================== Binary file - no diff available. Propchange: websites/production/openwebbeans/content/meecrowave/meecrowave-proxy/index.pdf ------------------------------------------------------------------------------ svn:mime-type = application/pdf Modified: websites/production/openwebbeans/content/meecrowave/start.html ============================================================================== --- websites/production/openwebbeans/content/meecrowave/start.html (original) +++ websites/production/openwebbeans/content/meecrowave/start.html Fri Aug 2 14:41:14 2019 @@ -18,7 +18,7 @@ - + @@ -66,73 +66,105 @@

Your first application

Meecrowave relies on JAX-RS and CDI so to start you just need to write a JAX-RS endpoint:

@Path("kitchen")
+                
+Your first application
+
+
+Dependencies
+
+Just add in any Maven pom.xml - or gradle build.gradle the following dependency:
+
+
+
+<dependency>
+  <groupId>org.apache.meecrowave</groupId>
+  <artifactId>meecrowave-core</artifactId>
+  <version>${meecrowave.version}</version>
+</dependency>
+
+
+
+If you intend to reuse our Cli main you should also add:
+
+
+
+<dependency>
+  <groupId>commons-cli</groupId>
+  <artifactId>commons-cli</artifactId>
+  <version>1.4</version>
+</dependency>
+
+
+
+
+Runtime
+
+Meecrowave relies on JAX-RS and CDI so to start you just need to write a JAX-RS endpoint:
+
+
+
+@Path("kitchen")
 @ApplicationScoped
 public class HelloKitchen {
     @GET
     public String getMenu() {
         return "good things";
     }
-} 
-    
-   
-   
-   Then booting Meecrowave is as easy as launching: 
-   
-   
-    
-    try (final Meecrowave meecrowave = new Meecrowave().bake()) {
+}
+
+
+
+Then booting Meecrowave is as easy as launching - or reuse org.apache.meecrowave.runner.Cli provided main:
+
+
+
+try (final Meecrowave meecrowave = new Meecrowave().bake()) {
     new Scanner(System.in).nextLine();
-} 
-    
-   
-   
-   You should get some output containing: 
-   
-   
-    
-    [19:54:55.397][INFO][main][.meecrowave.cxf.CxfCdiAutoSetup] REST Application: / -> org.apache.cxf.cdi.DefaultApplication
+}
+
+
+
+You should get some output containing:
+
+
+
+[19:54:55.397][INFO][main][.meecrowave.cxf.CxfCdiAutoSetup] REST Application: / -> org.apache.cxf.cdi.DefaultApplication
 [19:54:55.399][INFO][main][.meecrowave.cxf.CxfCdiAutoSetup]      Service URI: /kitchen  -> org.app.HelloKitchen
-[19:54:55.401][INFO][main][.meecrowave.cxf.CxfCdiAutoSetup]               GET /kitchen/ ->      String getMenu() 
-    
-   
-   
-   And you can check it works doing: 
-   
-   
-    
-    curl http://localhost:8080/kitchen 
-    
-   
-  
- 
- 
- Youâre in a hurry? Use groovy! 
-  
-   
-    
-    
-      
-       
-       
-      
-    
-      this feature is supported starting from version 0.3.0 only.  
-   
-   
-   Create a file called hello.groovy: 
-   
-   
-    
-    @Grab('org.apache.meecrowave:meecrowave-core:0.3.0')
+[19:54:55.401][INFO][main][.meecrowave.cxf.CxfCdiAutoSetup]               GET /kitchen/ ->      String getMenu()
+
+
+
+And you can check it works doing:
+
+
+
+curl http://localhost:8080/kitchen
+
+
+
+
+
+
+You’re in a hurry? Use groovy!
+
+
+
+
+
+
+
+
+
+ 
+this feature is supported starting from version 0.3.0 only.
+
+
+
+Create a file called hello.groovy:
+
+
+
+@Grab('org.apache.meecrowave:meecrowave-core:0.3.0')
 
 import org.apache.meecrowave.Meecrowave
 
@@ -149,34 +181,45 @@ class Hello {
     }
 }
 
-new Meecrowave().bake().await() 
-    
-   
-   
-   then 
-   
-   
-    
-    groovy hello.groovy 
-    
-   
-   
-   Finally you can test it: 
-   
-   
-    
-    curl http://localhost:8080/hello 
-    
-   
-  
- 
- 
- Sample 
-  
-   
-   https://github.com/apache/openwebbeans-meecrowave-examples contains ready to use examples using meecrowave. 
-   
-  
+new Meecrowave().bake().await()

then

groovy hello.groovy

Finally you can test it:

curl http://localhost:8080/hello

And my war?

See How to deploy a war to see how to use meecrowave to deploy an existing war.

Sample

https://github.com/apache/openwebbeans-meecrowave-examples contains ready to use examples using meecrowave.

You can also find more information on our How To page.

@@ -204,8 +247,8 @@ new Meecrowave().bake().await()

@@ -220,10 +263,13 @@ new Meecrowave().bake().await() - + + + + + - Modified: websites/production/openwebbeans/content/meecrowave/start.pdf ============================================================================== Binary files - no diff available. Modified: websites/production/openwebbeans/content/meecrowave/testing/index.html ============================================================================== --- websites/production/openwebbeans/content/meecrowave/testing/index.html (original) +++ websites/production/openwebbeans/content/meecrowave/testing/index.html Fri Aug 2 14:41:14 2019 @@ -18,7 +18,7 @@ - + @@ -66,32 +66,34 @@

JUnit

Coordinates:

<dependency>
+                
+JUnit
+
+
+Coordinates:
+
+
+
+<dependency>
   <groupId>org.apache.meecrowave</groupId>
   <artifactId>meecrowave-junit</artifactId>
   <version>${meecrowave.version}</version>
-</dependency> 
-    
-   
-   
-   Rules and Runners 
-    
-    Meecrowave provides two flavors of JUnit integration: standalone or runners/rules. The standalone one will ensure there is a single container for the whole JVM. It also fits standalone environments where you want to control the lifecycle. The other one will follow the JUnit lifecycle (per class or test rule). 
-    
-    
-    Here how to use the standalone flavor: 
-    
-    
-     
-     @RunWith(MonoMeecrowave.Runner.class)
+</dependency>
+
+
+
+Rules and Runners
+
+Meecrowave provides two flavors of JUnit integration: standalone or runners/rules. The standalone one will
+ensure there is a single container for the whole JVM. It also fits standalone environments where you want to control the lifecycle.
+The other one will follow the JUnit lifecycle (per class or test rule).
+
+
+Here how to use the standalone flavor:
+
+
+
+@RunWith(MonoMeecrowave.Runner.class)
 public class MonoMeecrowaveRuleTest {
     /* or
     @ClassRule
@@ -105,21 +107,23 @@ public class MonoMeecrowaveRuleTest {
     public void test() throws IOException {
         // use "http://localhost:" + config.getHttpPort()
     }
-} 
-     
-    
-    
-    When using the standalone, @MonoMeecrowave.Runner.ConfigurationInject allows to still access the configuration and random HTTP port. 
-    
-    
-    For the configuration, the standalone runner will use a global configuration shared by all tests. To load it it will use a standard ServiceLoader on type org.apache.meecrowave.Meecrowave$ConfigurationCustomizer. 
-    
-    
-    And here is the one bound to the JUnit lifecycle 
-    
-    
-     
-     public class MeecrowaveRuleTest {
+}
+
+
+
+When using the standalone, @MonoMeecrowave.Runner.ConfigurationInject allows to still
+access the configuration and random HTTP port.
+
+
+For the configuration, the standalone runner will use a global configuration shared by all tests. To load it
+it will use a standard ServiceLoader on type org.apache.meecrowave.Meecrowave$ConfigurationCustomizer.
+
+
+And here is the one bound to the JUnit lifecycle
+
+
+
+public class MeecrowaveRuleTest {
     @ClassRule // started once for the class, @Rule would be per method
     public static final MeecrowaveRule RULE = new MeecrowaveRule();
 
@@ -127,24 +131,27 @@ public class MonoMeecrowaveRuleTest {
     public void test() throws IOException {
         // use "http://localhost:" + RULE.getConfiguration().getHttpPort()
     }
-} 
-     
-    
-    
-    As usual with JUnit rules, you can decide whereas the Meecrowave instance is bound to the entire test class or a method by using @ClassRule or @Rule. 
-    
-   
-   
-   JUnit 5 
-    
-    JUnit 5 integrates a new Extension system. It is not yet very well supported by IDEs but you can already use it with Gradle and Maven (see http://junit.org/junit5/docs/current/user-guide/#running-tests). 
-    
-    
-    The usage has two annotations: @MeecrowaveConfig which remaps most of the configuration of Meecrowave and @MonoMeecrowaveConfig which is close to MonoMeecrowave.Runner in term of usage. 
-    
-    
-     
-     @MeecrowaveConfig /*(some config)*/
+}
+
+
+
+As usual with JUnit rules, you can decide whereas the Meecrowave instance is bound to the entire test class
+or a method by using @ClassRule or @Rule.
+
+
+
+JUnit 5
+
+JUnit 5 integrates a new Extension system. It is not yet very well supported by IDEs but you can already use it with
+Gradle and Maven (see http://junit.org/junit5/docs/current/user-guide/#running-tests).
+
+
+The usage has two annotations: @MeecrowaveConfig which remaps most of the configuration of Meecrowave and @MonoMeecrowaveConfig
+which is close to MonoMeecrowave.Runner in term of usage.
+
+
+
+@MeecrowaveConfig /*(some config)*/
 public class MeecrowaveConfigTest {
     @ConfigurationInject
     private Meecrowave.Builder config;
@@ -154,62 +161,67 @@ public class MeecrowaveConfigTest {
         final String base = "http://localhost:" + config.getHttpPort();
         // asserts
     }
-} 
-     
-    
-    
-    Or 
-    
-    
-     
-     @MonoMeecrowaveConfig
+}
+
+
+
+Or
+
+
+
+@MonoMeecrowaveConfig
 public class MeecrowaveConfigTest {
     // ...
-} 
-     
-    
-    
-     
-     
-       
-        
-        
-       
-     
-       JUnit 5 integration provides an @AfterFirstInjection method and @AfterLastTest which can be used to setup/reset some environment using injections once for a set of test methods. The methods must not have any parameter.  
-    
-   
-  
- 
- 
- Arquillian Container 
-  
-   
-   Container dependency: 
-   
-   
-    
-    <dependency>
+}
+
+
+
+
+
+
+
+
+
+
+ 
+JUnit 5 integration provides an @AfterFirstInjection method and @AfterLastTest
+which can be used to setup/reset some environment using injections once for a set of test methods.
+The methods must not have any parameter.
+
+
+
+
+
+
+Arquillian Container
+
+
+Container dependency:
+
+
+
+<dependency>
   <groupId>org.apache.meecrowave</groupId>
   <artifactId>meecrowave-arquillian</artifactId>
   <version>${meecrowave.version}</version>
-</dependency> 
-    
-   
-   
-   For the configuration check Core configuration. 
-   
-   
-   Here is a sample: 
-   
-   
-    
-    <?xml version="1.0" encoding="UTF-8"?>
+</dependency>
+
+
+
+For the configuration check Core configuration.
+
+
+Here is a sample:
+
+
+
+<?xml version="1.0" encoding="UTF-8"?>
 <arquillian xmlns="http://jboss.org/schema/arquillian"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://jboss.org/schema/arquillian http://jboss.org/schema/arquillian/arquillian_1_0.xsd">
   <container qualifier="meecrowave" default="true">
     <configuration>
+      <property name="antiResourceLocking">false</property>
       <property name="arquillianProtocol">Servlet 3.1</property>
       <property name="cdiConversation">false</property>
       <property name="clientAuth"></property>
@@ -274,10 +286,11 @@ public class MeecrowaveConfigTest {
       <property name="ssl">false</property>
       <property name="sslProtocol"></property>
       <property name="stopPort">-1</property>
-      <property name="tempDir">/var/folders/cc/5g6j5x3x74154g2rmmtpz_4w0000gn/T/meecrowave_184680423404202</property>
+      <property name="tempDir">/var/folders/cc/5g6j5x3x74154g2rmmtpz_4w0000gn/T/meecrowave_997692605269638</property>
       <property name="tomcatAccessLogPattern"></property>
       <property name="tomcatAutoSetup">true</property>
       <property name="tomcatFilter"></property>
+      <property name="tomcatJspDevelopment">false</property>
       <property name="tomcatNoJmx">true</property>
       <property name="tomcatScanning">true</property>
       <property name="tomcatWrapLoader">true</property>
@@ -294,10 +307,10 @@ public class MeecrowaveConfigTest {
       <property name="webXml"></property>
     </configuration>
   </container>
-</arquillian> 
-    
-   
-  
+</arquillian>

@@ -325,8 +338,8 @@ public class MeecrowaveConfigTest {

Authorization code case

Authorization code case

Configuration

Configuration File

Extend

Your first application

Dependencies

Runtime

Youâre in a hurry? Use groovy!

You’re in a hurry? Use groovy!

Sample

JUnit

Rules and Runners

Rules and Runners

JUnit 5

JUnit 5

Arquillian Container

Arquillian Container

Youâre in a hurry? Use groovy!