From 37b4cecd910eae40dcb3433b1677258a1bfc931c Mon Sep 17 00:00:00 2001 From: charlesdaniels Date: Wed, 31 Jul 2024 20:07:49 +0000 Subject: [PATCH] deploy: 330cf485fe3c743998d15fdd820f2688b576a237 --- index.html | 2 +- javadoc/allclasses-index.html | 8 +++--- javadoc/allpackages-index.html | 2 +- .../ConstantContextDataProvider.html | 2 +- .../opa/springboot/ContextDataProvider.html | 2 +- .../springboot/OPAAuthorizationManager.html | 26 ++++++++++++++++--- .../com/styra/opa/springboot/OPAResponse.html | 4 +-- .../opa/springboot/OPAResponseContext.html | 4 +-- .../styra/opa/springboot/package-summary.html | 8 +++--- .../styra/opa/springboot/package-tree.html | 2 +- javadoc/help-doc.html | 2 +- javadoc/index-all.html | 13 +++++++--- javadoc/index.html | 2 +- javadoc/member-search-index.js | 2 +- javadoc/overview-tree.html | 2 +- 15 files changed, 53 insertions(+), 28 deletions(-) diff --git a/index.html b/index.html index 0d62117..c8f95d5 100644 --- a/index.html +++ b/index.html @@ -9,6 +9,6 @@ Page Redirection - redirect to OPA-SpringBoot javadoc. + redirect to OPA Spring Boot SDK javadoc. diff --git a/javadoc/allclasses-index.html b/javadoc/allclasses-index.html index 9fe1eee..6751c87 100644 --- a/javadoc/allclasses-index.html +++ b/javadoc/allclasses-index.html @@ -2,7 +2,7 @@ -All Classes and Interfaces (springboot 0.0.4 API) +All Classes and Interfaces (springboot 0.0.5 API) @@ -70,16 +70,16 @@

All Classes and Interfaces<
OPAAuthorizationManager
-
This class implements a Spring AuthorizationManager which wraps the OPA-Java +
This class implements a Spring AuthorizationManager which wraps the OPA Java SDK (https://github.com/StyraInc/opa-java).
OPAResponse
-
This class models the data to be returned from an OPA-SpringBoot policy.
+
This class models the data to be returned from an OPA Spring Boot SDK policy.
OPAResponseContext
-
This class models the data to be returned from an OPA-SpringBoot policy +
This class models the data to be returned from an OPA Spring Boot SDK policy under the context key.
diff --git a/javadoc/allpackages-index.html b/javadoc/allpackages-index.html index a07c29c..3d5253e 100644 --- a/javadoc/allpackages-index.html +++ b/javadoc/allpackages-index.html @@ -2,7 +2,7 @@ -All Packages (springboot 0.0.4 API) +All Packages (springboot 0.0.5 API) diff --git a/javadoc/com/styra/opa/springboot/ConstantContextDataProvider.html b/javadoc/com/styra/opa/springboot/ConstantContextDataProvider.html index 28e6ee9..1921b36 100644 --- a/javadoc/com/styra/opa/springboot/ConstantContextDataProvider.html +++ b/javadoc/com/styra/opa/springboot/ConstantContextDataProvider.html @@ -2,7 +2,7 @@ -ConstantContextDataProvider (springboot 0.0.4 API) +ConstantContextDataProvider (springboot 0.0.5 API) diff --git a/javadoc/com/styra/opa/springboot/ContextDataProvider.html b/javadoc/com/styra/opa/springboot/ContextDataProvider.html index ec8fc18..577a372 100644 --- a/javadoc/com/styra/opa/springboot/ContextDataProvider.html +++ b/javadoc/com/styra/opa/springboot/ContextDataProvider.html @@ -2,7 +2,7 @@ -ContextDataProvider (springboot 0.0.4 API) +ContextDataProvider (springboot 0.0.5 API) diff --git a/javadoc/com/styra/opa/springboot/OPAAuthorizationManager.html b/javadoc/com/styra/opa/springboot/OPAAuthorizationManager.html index 0c967ac..21a36ee 100644 --- a/javadoc/com/styra/opa/springboot/OPAAuthorizationManager.html +++ b/javadoc/com/styra/opa/springboot/OPAAuthorizationManager.html @@ -2,7 +2,7 @@ -OPAAuthorizationManager (springboot 0.0.4 API) +OPAAuthorizationManager (springboot 0.0.5 API) @@ -82,7 +82,7 @@

Class OPAAuthorizationMa public class OPAAuthorizationManager extends Object implements org.springframework.security.authorization.AuthorizationManager<org.springframework.security.web.access.intercept.RequestAuthorizationContext>

-
This class implements a Spring AuthorizationManager which wraps the OPA-Java +
This class implements a Spring AuthorizationManager which wraps the OPA Java SDK (https://github.com/StyraInc/opa-java). OPA inputs are constructed by inspecting the Spring Authentication and RequestAuthorizationContext arguments to check and verify, and are compliant with the AuthZEN spec @@ -134,6 +134,12 @@

Constructor Summary

The authorization manager will internally instantiate an OPA client.
+
OPAAuthorizationManager(String newOpaPath, + ContextDataProvider newProvider)
+
+
The authorization manager will instantiate an OPA client internally, but + use a caller-supplied path, and ContextDataProvider.
+
@@ -274,6 +280,20 @@

OPAAuthorizationManager

+
  • +
    +

    OPAAuthorizationManager

    +
    public OPAAuthorizationManager(String newOpaPath, + ContextDataProvider newProvider)
    +
    The authorization manager will instantiate an OPA client internally, but + use a caller-supplied path, and ContextDataProvider.
    +
    +
    Parameters:
    +
    newOpaPath -
    +
    newProvider -
    +
    +
    +
    • @@ -309,7 +329,7 @@

    opaRequest

    org.springframework.security.web.access.intercept.RequestAuthorizationContext object)
    This method can be used to directly call OPA without generating an AuthorizationDecision, which can be used to examine the OPA response. - You should consider using the OPA-Java SDK (which OPA-SpringBoot depends + You should consider using the OPA Java SDK (which the OPA Spring Boot SDK depends on) directly rather than using this method, as it should not be needed during normal use.
    diff --git a/javadoc/com/styra/opa/springboot/OPAResponse.html b/javadoc/com/styra/opa/springboot/OPAResponse.html index 1bc7d44..82a425a 100644 --- a/javadoc/com/styra/opa/springboot/OPAResponse.html +++ b/javadoc/com/styra/opa/springboot/OPAResponse.html @@ -2,7 +2,7 @@ -OPAResponse (springboot 0.0.4 API) +OPAResponse (springboot 0.0.5 API) @@ -76,7 +76,7 @@

    Class OPAResponse

    public class OPAResponse extends Object
    -
    This class models the data to be returned from an OPA-SpringBoot policy. The +
    This class models the data to be returned from an OPA Spring Boot SDK policy. The structure of the response is defined by the AuthZEN spec (https://openid.github.io/authzen).
    diff --git a/javadoc/com/styra/opa/springboot/OPAResponseContext.html b/javadoc/com/styra/opa/springboot/OPAResponseContext.html index 585c4a4..637e5d9 100644 --- a/javadoc/com/styra/opa/springboot/OPAResponseContext.html +++ b/javadoc/com/styra/opa/springboot/OPAResponseContext.html @@ -2,7 +2,7 @@ -OPAResponseContext (springboot 0.0.4 API) +OPAResponseContext (springboot 0.0.5 API) @@ -76,7 +76,7 @@

    Class OPAResponseContext

    public class OPAResponseContext extends Object
    -
    This class models the data to be returned from an OPA-SpringBoot policy +
    This class models the data to be returned from an OPA Spring Boot SDK policy under the context key. This corresponds to the Context object in the AuthZen spec, see: diff --git a/javadoc/com/styra/opa/springboot/package-summary.html b/javadoc/com/styra/opa/springboot/package-summary.html index 296da9e..98485cd 100644 --- a/javadoc/com/styra/opa/springboot/package-summary.html +++ b/javadoc/com/styra/opa/springboot/package-summary.html @@ -2,7 +2,7 @@ -com.styra.opa.springboot (springboot 0.0.4 API) +com.styra.opa.springboot (springboot 0.0.5 API) @@ -83,16 +83,16 @@

    Package com.styra.opa

    OPAAuthorizationManager
    -
    This class implements a Spring AuthorizationManager which wraps the OPA-Java +
    This class implements a Spring AuthorizationManager which wraps the OPA Java SDK (https://github.com/StyraInc/opa-java).
    OPAResponse
    -
    This class models the data to be returned from an OPA-SpringBoot policy.
    +
    This class models the data to be returned from an OPA Spring Boot SDK policy.
    OPAResponseContext
    -
    This class models the data to be returned from an OPA-SpringBoot policy +
    This class models the data to be returned from an OPA Spring Boot SDK policy under the context key.
    diff --git a/javadoc/com/styra/opa/springboot/package-tree.html b/javadoc/com/styra/opa/springboot/package-tree.html index 6e07dfb..8435a39 100644 --- a/javadoc/com/styra/opa/springboot/package-tree.html +++ b/javadoc/com/styra/opa/springboot/package-tree.html @@ -2,7 +2,7 @@ -com.styra.opa.springboot Class Hierarchy (springboot 0.0.4 API) +com.styra.opa.springboot Class Hierarchy (springboot 0.0.5 API) diff --git a/javadoc/help-doc.html b/javadoc/help-doc.html index 92337ce..d19d445 100644 --- a/javadoc/help-doc.html +++ b/javadoc/help-doc.html @@ -2,7 +2,7 @@ -API Help (springboot 0.0.4 API) +API Help (springboot 0.0.5 API) diff --git a/javadoc/index-all.html b/javadoc/index-all.html index 3751b49..80b972a 100644 --- a/javadoc/index-all.html +++ b/javadoc/index-all.html @@ -2,7 +2,7 @@ -Index (springboot 0.0.4 API) +Index (springboot 0.0.5 API) @@ -102,7 +102,7 @@

    O

    OPAAuthorizationManager - Class in com.styra.opa.springboot
    -
    This class implements a Spring AuthorizationManager which wraps the OPA-Java +
    This class implements a Spring AuthorizationManager which wraps the OPA Java SDK (https://github.com/StyraInc/opa-java).
    OPAAuthorizationManager() - Constructor for class com.styra.opa.springboot.OPAAuthorizationManager
    @@ -137,6 +137,11 @@

    O

    The authorization manager will internally instantiate an OPA client.
    +
    OPAAuthorizationManager(String, ContextDataProvider) - Constructor for class com.styra.opa.springboot.OPAAuthorizationManager
    +
    +
    The authorization manager will instantiate an OPA client internally, but + use a caller-supplied path, and ContextDataProvider.
    +
    opaRequest(Supplier<Authentication>, RequestAuthorizationContext) - Method in class com.styra.opa.springboot.OPAAuthorizationManager
    This method can be used to directly call OPA without generating an @@ -144,13 +149,13 @@

    O

    OPAResponse - Class in com.styra.opa.springboot
    -
    This class models the data to be returned from an OPA-SpringBoot policy.
    +
    This class models the data to be returned from an OPA Spring Boot SDK policy.
    OPAResponse() - Constructor for class com.styra.opa.springboot.OPAResponse
     
    OPAResponseContext - Class in com.styra.opa.springboot
    -
    This class models the data to be returned from an OPA-SpringBoot policy +
    This class models the data to be returned from an OPA Spring Boot SDK policy under the context key.
    OPAResponseContext() - Constructor for class com.styra.opa.springboot.OPAResponseContext
    diff --git a/javadoc/index.html b/javadoc/index.html index ccad22c..0eba9f6 100644 --- a/javadoc/index.html +++ b/javadoc/index.html @@ -2,7 +2,7 @@ -springboot 0.0.4 API +springboot 0.0.5 API diff --git a/javadoc/member-search-index.js b/javadoc/member-search-index.js index aa08610..5b81499 100644 --- a/javadoc/member-search-index.js +++ b/javadoc/member-search-index.js @@ -1 +1 @@ -memberSearchIndex = [{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"check(Supplier, RequestAuthorizationContext)","u":"check(java.util.function.Supplier,org.springframework.security.web.access.intercept.RequestAuthorizationContext)"},{"p":"com.styra.opa.springboot","c":"ConstantContextDataProvider","l":"ConstantContextDataProvider(Object)","u":"%3Cinit%3E(java.lang.Object)"},{"p":"com.styra.opa.springboot","c":"OPAResponse","l":"getContext()"},{"p":"com.styra.opa.springboot","c":"ConstantContextDataProvider","l":"getContextData(Supplier, RequestAuthorizationContext)","u":"getContextData(java.util.function.Supplier,org.springframework.security.web.access.intercept.RequestAuthorizationContext)"},{"p":"com.styra.opa.springboot","c":"ContextDataProvider","l":"getContextData(Supplier, RequestAuthorizationContext)","u":"getContextData(java.util.function.Supplier,org.springframework.security.web.access.intercept.RequestAuthorizationContext)"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"getData()"},{"p":"com.styra.opa.springboot","c":"OPAResponse","l":"getDecision()"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"getId()"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"getReasonAdmin()"},{"p":"com.styra.opa.springboot","c":"OPAResponse","l":"getReasonForDecision(String)","u":"getReasonForDecision(java.lang.String)"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"getReasonForDecision(String)","u":"getReasonForDecision(java.lang.String)"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"getReasonKey()"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"getReasonUser()"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"OPAAuthorizationManager()","u":"%3Cinit%3E()"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"OPAAuthorizationManager(OPAClient)","u":"%3Cinit%3E(com.styra.opa.OPAClient)"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"OPAAuthorizationManager(OPAClient, ContextDataProvider)","u":"%3Cinit%3E(com.styra.opa.OPAClient,com.styra.opa.springboot.ContextDataProvider)"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"OPAAuthorizationManager(OPAClient, String)","u":"%3Cinit%3E(com.styra.opa.OPAClient,java.lang.String)"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"OPAAuthorizationManager(OPAClient, String, ContextDataProvider)","u":"%3Cinit%3E(com.styra.opa.OPAClient,java.lang.String,com.styra.opa.springboot.ContextDataProvider)"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"OPAAuthorizationManager(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"opaRequest(Supplier, RequestAuthorizationContext)","u":"opaRequest(java.util.function.Supplier,org.springframework.security.web.access.intercept.RequestAuthorizationContext)"},{"p":"com.styra.opa.springboot","c":"OPAResponse","l":"OPAResponse()","u":"%3Cinit%3E()"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"OPAResponseContext()","u":"%3Cinit%3E()"},{"p":"com.styra.opa.springboot","c":"OPAResponse","l":"setContext(OPAResponseContext)","u":"setContext(com.styra.opa.springboot.OPAResponseContext)"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"setData(Map)","u":"setData(java.util.Map)"},{"p":"com.styra.opa.springboot","c":"OPAResponse","l":"setDecision(boolean)"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"setId(String)","u":"setId(java.lang.String)"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"setReasonAdmin(Map)","u":"setReasonAdmin(java.util.Map)"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"setReasonKey(String)","u":"setReasonKey(java.lang.String)"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"setReasonUser(Map)","u":"setReasonUser(java.util.Map)"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"verify(Supplier, RequestAuthorizationContext)","u":"verify(java.util.function.Supplier,org.springframework.security.web.access.intercept.RequestAuthorizationContext)"}];updateSearchResults(); \ No newline at end of file +memberSearchIndex = [{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"check(Supplier, RequestAuthorizationContext)","u":"check(java.util.function.Supplier,org.springframework.security.web.access.intercept.RequestAuthorizationContext)"},{"p":"com.styra.opa.springboot","c":"ConstantContextDataProvider","l":"ConstantContextDataProvider(Object)","u":"%3Cinit%3E(java.lang.Object)"},{"p":"com.styra.opa.springboot","c":"OPAResponse","l":"getContext()"},{"p":"com.styra.opa.springboot","c":"ConstantContextDataProvider","l":"getContextData(Supplier, RequestAuthorizationContext)","u":"getContextData(java.util.function.Supplier,org.springframework.security.web.access.intercept.RequestAuthorizationContext)"},{"p":"com.styra.opa.springboot","c":"ContextDataProvider","l":"getContextData(Supplier, RequestAuthorizationContext)","u":"getContextData(java.util.function.Supplier,org.springframework.security.web.access.intercept.RequestAuthorizationContext)"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"getData()"},{"p":"com.styra.opa.springboot","c":"OPAResponse","l":"getDecision()"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"getId()"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"getReasonAdmin()"},{"p":"com.styra.opa.springboot","c":"OPAResponse","l":"getReasonForDecision(String)","u":"getReasonForDecision(java.lang.String)"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"getReasonForDecision(String)","u":"getReasonForDecision(java.lang.String)"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"getReasonKey()"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"getReasonUser()"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"OPAAuthorizationManager()","u":"%3Cinit%3E()"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"OPAAuthorizationManager(OPAClient)","u":"%3Cinit%3E(com.styra.opa.OPAClient)"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"OPAAuthorizationManager(OPAClient, ContextDataProvider)","u":"%3Cinit%3E(com.styra.opa.OPAClient,com.styra.opa.springboot.ContextDataProvider)"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"OPAAuthorizationManager(OPAClient, String)","u":"%3Cinit%3E(com.styra.opa.OPAClient,java.lang.String)"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"OPAAuthorizationManager(OPAClient, String, ContextDataProvider)","u":"%3Cinit%3E(com.styra.opa.OPAClient,java.lang.String,com.styra.opa.springboot.ContextDataProvider)"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"OPAAuthorizationManager(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"OPAAuthorizationManager(String, ContextDataProvider)","u":"%3Cinit%3E(java.lang.String,com.styra.opa.springboot.ContextDataProvider)"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"opaRequest(Supplier, RequestAuthorizationContext)","u":"opaRequest(java.util.function.Supplier,org.springframework.security.web.access.intercept.RequestAuthorizationContext)"},{"p":"com.styra.opa.springboot","c":"OPAResponse","l":"OPAResponse()","u":"%3Cinit%3E()"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"OPAResponseContext()","u":"%3Cinit%3E()"},{"p":"com.styra.opa.springboot","c":"OPAResponse","l":"setContext(OPAResponseContext)","u":"setContext(com.styra.opa.springboot.OPAResponseContext)"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"setData(Map)","u":"setData(java.util.Map)"},{"p":"com.styra.opa.springboot","c":"OPAResponse","l":"setDecision(boolean)"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"setId(String)","u":"setId(java.lang.String)"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"setReasonAdmin(Map)","u":"setReasonAdmin(java.util.Map)"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"setReasonKey(String)","u":"setReasonKey(java.lang.String)"},{"p":"com.styra.opa.springboot","c":"OPAResponseContext","l":"setReasonUser(Map)","u":"setReasonUser(java.util.Map)"},{"p":"com.styra.opa.springboot","c":"OPAAuthorizationManager","l":"verify(Supplier, RequestAuthorizationContext)","u":"verify(java.util.function.Supplier,org.springframework.security.web.access.intercept.RequestAuthorizationContext)"}];updateSearchResults(); \ No newline at end of file diff --git a/javadoc/overview-tree.html b/javadoc/overview-tree.html index aca044f..ab53724 100644 --- a/javadoc/overview-tree.html +++ b/javadoc/overview-tree.html @@ -2,7 +2,7 @@ -Class Hierarchy (springboot 0.0.4 API) +Class Hierarchy (springboot 0.0.5 API)