You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@unomi.apache.org by jk...@apache.org on 2021/03/31 17:36:18 UTC

[unomi] branch guestAuthenticationPublicRest updated: UNOMI-453: update java doc

This is an automated email from the ASF dual-hosted git repository.

jkevan pushed a commit to branch guestAuthenticationPublicRest
in repository https://gitbox.apache.org/repos/asf/unomi.git


The following commit(s) were added to refs/heads/guestAuthenticationPublicRest by this push:
     new 37945bf  UNOMI-453: update java doc
37945bf is described below

commit 37945bff275aff991a45e65c88182de7e5d23e40
Author: Kevan <ke...@jahia.com>
AuthorDate: Wed Mar 31 19:36:13 2021 +0200

    UNOMI-453: update java doc
---
 .../unomi/rest/authentication/RestAuthenticationConfig.java    | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/rest/src/main/java/org/apache/unomi/rest/authentication/RestAuthenticationConfig.java b/rest/src/main/java/org/apache/unomi/rest/authentication/RestAuthenticationConfig.java
index 4fd26e8..e18a201 100644
--- a/rest/src/main/java/org/apache/unomi/rest/authentication/RestAuthenticationConfig.java
+++ b/rest/src/main/java/org/apache/unomi/rest/authentication/RestAuthenticationConfig.java
@@ -24,9 +24,17 @@ import java.util.regex.Pattern;
  * This interface provide rest authentication configuration for the rest server.
  */
 public interface RestAuthenticationConfig {
+    
     /**
+     * The patterns will be tested against this format: "HTTP_METHOD HTTP_PATH"
      *
-     * @return the list of public paths (expected format is: "HTTP_METHOD HTTP_PATH", like: "GET context.json")
+     * sample pattern for allowing GET, POST and OPTIONS on context.json request would be:
+     * "(GET|POST|OPTIONS) context\\.json"
+     *
+     * sample pattern for allowing GET only on all paths starting by "client/":
+     * "GET client/.*"
+     *
+     * @return the list of public paths patterns
      */
     List<Pattern> getPublicPathPatterns();