Skip to content

Commit

Permalink
deploy: 330cf48
Browse files Browse the repository at this point in the history
  • Loading branch information
charlesdaniels committed Jul 31, 2024
1 parent 37f538d commit 37b4cec
Show file tree
Hide file tree
Showing 15 changed files with 53 additions and 28 deletions.
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@
<title>Page Redirection</title>
</head>
<body>
<a href='./javadoc'>redirect to OPA-SpringBoot javadoc</a>.
<a href='./javadoc'>redirect to OPA Spring Boot SDK javadoc</a>.
</body>
</html>
8 changes: 4 additions & 4 deletions javadoc/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>All Classes and Interfaces (springboot 0.0.4 API)</title>
<title>All Classes and Interfaces (springboot 0.0.5 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="class index">
Expand Down Expand Up @@ -70,16 +70,16 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/styra/opa/springboot/OPAAuthorizationManager.html" title="class in com.styra.opa.springboot">OPAAuthorizationManager</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">This class implements a Spring AuthorizationManager which wraps the OPA-Java
<div class="block">This class implements a Spring AuthorizationManager which wraps the OPA Java
SDK (https://github.com/StyraInc/opa-java).</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/styra/opa/springboot/OPAResponse.html" title="class in com.styra.opa.springboot">OPAResponse</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">This class models the data to be returned from an OPA-SpringBoot policy.</div>
<div class="block">This class models the data to be returned from an OPA Spring Boot SDK policy.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/styra/opa/springboot/OPAResponseContext.html" title="class in com.styra.opa.springboot">OPAResponseContext</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">This class models the data to be returned from an OPA-SpringBoot policy
<div class="block">This class models the data to be returned from an OPA Spring Boot SDK policy
under the context key.</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion javadoc/allpackages-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>All Packages (springboot 0.0.4 API)</title>
<title>All Packages (springboot 0.0.5 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="package index">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ConstantContextDataProvider (springboot 0.0.4 API)</title>
<title>ConstantContextDataProvider (springboot 0.0.5 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: com.styra.opa.springboot, class: ConstantContextDataProvider">
Expand Down
2 changes: 1 addition & 1 deletion javadoc/com/styra/opa/springboot/ContextDataProvider.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ContextDataProvider (springboot 0.0.4 API)</title>
<title>ContextDataProvider (springboot 0.0.5 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: com.styra.opa.springboot, interface: ContextDataProvider">
Expand Down
26 changes: 23 additions & 3 deletions javadoc/com/styra/opa/springboot/OPAAuthorizationManager.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>OPAAuthorizationManager (springboot 0.0.4 API)</title>
<title>OPAAuthorizationManager (springboot 0.0.5 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: com.styra.opa.springboot, class: OPAAuthorizationManager">
Expand Down Expand Up @@ -82,7 +82,7 @@ <h1 title="Class OPAAuthorizationManager" class="title">Class OPAAuthorizationMa
</span><span class="modifiers">public class </span><span class="element-name type-name-label">OPAAuthorizationManager</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
implements org.springframework.security.authorization.AuthorizationManager&lt;org.springframework.security.web.access.intercept.RequestAuthorizationContext&gt;</span></div>
<div class="block">This class implements a Spring AuthorizationManager which wraps the OPA-Java
<div class="block">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
Expand Down Expand Up @@ -134,6 +134,12 @@ <h2>Constructor Summary</h2>
<div class="col-last odd-row-color">
<div class="block">The authorization manager will internally instantiate an OPA client.</div>
</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,com.styra.opa.springboot.ContextDataProvider)" class="member-name-link">OPAAuthorizationManager</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;newOpaPath,
<a href="ContextDataProvider.html" title="interface in com.styra.opa.springboot">ContextDataProvider</a>&nbsp;newProvider)</code></div>
<div class="col-last even-row-color">
<div class="block">The authorization manager will instantiate an OPA client internally, but
use a caller-supplied path, and ContextDataProvider.</div>
</div>
</div>
</section>
</li>
Expand Down Expand Up @@ -274,6 +280,20 @@ <h3>OPAAuthorizationManager</h3>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(java.lang.String,com.styra.opa.springboot.ContextDataProvider)">
<h3>OPAAuthorizationManager</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">OPAAuthorizationManager</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;newOpaPath,
<a href="ContextDataProvider.html" title="interface in com.styra.opa.springboot">ContextDataProvider</a>&nbsp;newProvider)</span></div>
<div class="block">The authorization manager will instantiate an OPA client internally, but
use a caller-supplied path, and ContextDataProvider.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>newOpaPath</code> - </dd>
<dd><code>newProvider</code> - </dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
Expand Down Expand Up @@ -309,7 +329,7 @@ <h3>opaRequest</h3>
org.springframework.security.web.access.intercept.RequestAuthorizationContext&nbsp;object)</span></div>
<div class="block">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.</div>
</section>
Expand Down
4 changes: 2 additions & 2 deletions javadoc/com/styra/opa/springboot/OPAResponse.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>OPAResponse (springboot 0.0.4 API)</title>
<title>OPAResponse (springboot 0.0.5 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: com.styra.opa.springboot, class: OPAResponse">
Expand Down Expand Up @@ -76,7 +76,7 @@ <h1 title="Class OPAResponse" class="title">Class OPAResponse</h1>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">OPAResponse</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<div class="block">This class models the data to be returned from an OPA-SpringBoot policy. The
<div class="block">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).</div>
</section>
Expand Down
4 changes: 2 additions & 2 deletions javadoc/com/styra/opa/springboot/OPAResponseContext.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>OPAResponseContext (springboot 0.0.4 API)</title>
<title>OPAResponseContext (springboot 0.0.5 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: com.styra.opa.springboot, class: OPAResponseContext">
Expand Down Expand Up @@ -76,7 +76,7 @@ <h1 title="Class OPAResponseContext" class="title">Class OPAResponseContext</h1>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">OPAResponseContext</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<div class="block">This class models the data to be returned from an OPA-SpringBoot policy
<div class="block">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:
Expand Down
8 changes: 4 additions & 4 deletions javadoc/com/styra/opa/springboot/package-summary.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>com.styra.opa.springboot (springboot 0.0.4 API)</title>
<title>com.styra.opa.springboot (springboot 0.0.5 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: com.styra.opa.springboot">
Expand Down Expand Up @@ -83,16 +83,16 @@ <h1 title="Package com.styra.opa.springboot" class="title">Package com.styra.opa
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="OPAAuthorizationManager.html" title="class in com.styra.opa.springboot">OPAAuthorizationManager</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">This class implements a Spring AuthorizationManager which wraps the OPA-Java
<div class="block">This class implements a Spring AuthorizationManager which wraps the OPA Java
SDK (https://github.com/StyraInc/opa-java).</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="OPAResponse.html" title="class in com.styra.opa.springboot">OPAResponse</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">This class models the data to be returned from an OPA-SpringBoot policy.</div>
<div class="block">This class models the data to be returned from an OPA Spring Boot SDK policy.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="OPAResponseContext.html" title="class in com.styra.opa.springboot">OPAResponseContext</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">This class models the data to be returned from an OPA-SpringBoot policy
<div class="block">This class models the data to be returned from an OPA Spring Boot SDK policy
under the context key.</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion javadoc/com/styra/opa/springboot/package-tree.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>com.styra.opa.springboot Class Hierarchy (springboot 0.0.4 API)</title>
<title>com.styra.opa.springboot Class Hierarchy (springboot 0.0.5 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="tree: package: com.styra.opa.springboot">
Expand Down
2 changes: 1 addition & 1 deletion javadoc/help-doc.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>API Help (springboot 0.0.4 API)</title>
<title>API Help (springboot 0.0.5 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="help">
Expand Down
13 changes: 9 additions & 4 deletions javadoc/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Index (springboot 0.0.4 API)</title>
<title>Index (springboot 0.0.5 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="index">
Expand Down Expand Up @@ -102,7 +102,7 @@ <h2 class="title" id="I:O">O</h2>
<dl class="index">
<dt><a href="com/styra/opa/springboot/OPAAuthorizationManager.html" class="type-name-link" title="class in com.styra.opa.springboot">OPAAuthorizationManager</a> - Class in <a href="com/styra/opa/springboot/package-summary.html">com.styra.opa.springboot</a></dt>
<dd>
<div class="block">This class implements a Spring AuthorizationManager which wraps the OPA-Java
<div class="block">This class implements a Spring AuthorizationManager which wraps the OPA Java
SDK (https://github.com/StyraInc/opa-java).</div>
</dd>
<dt><a href="com/styra/opa/springboot/OPAAuthorizationManager.html#%3Cinit%3E()" class="member-name-link">OPAAuthorizationManager()</a> - Constructor for class com.styra.opa.springboot.<a href="com/styra/opa/springboot/OPAAuthorizationManager.html" title="class in com.styra.opa.springboot">OPAAuthorizationManager</a></dt>
Expand Down Expand Up @@ -137,20 +137,25 @@ <h2 class="title" id="I:O">O</h2>
<dd>
<div class="block">The authorization manager will internally instantiate an OPA client.</div>
</dd>
<dt><a href="com/styra/opa/springboot/OPAAuthorizationManager.html#%3Cinit%3E(java.lang.String,com.styra.opa.springboot.ContextDataProvider)" class="member-name-link">OPAAuthorizationManager(String, ContextDataProvider)</a> - Constructor for class com.styra.opa.springboot.<a href="com/styra/opa/springboot/OPAAuthorizationManager.html" title="class in com.styra.opa.springboot">OPAAuthorizationManager</a></dt>
<dd>
<div class="block">The authorization manager will instantiate an OPA client internally, but
use a caller-supplied path, and ContextDataProvider.</div>
</dd>
<dt><a href="com/styra/opa/springboot/OPAAuthorizationManager.html#opaRequest(java.util.function.Supplier,org.springframework.security.web.access.intercept.RequestAuthorizationContext)" class="member-name-link">opaRequest(Supplier&lt;Authentication&gt;, RequestAuthorizationContext)</a> - Method in class com.styra.opa.springboot.<a href="com/styra/opa/springboot/OPAAuthorizationManager.html" title="class in com.styra.opa.springboot">OPAAuthorizationManager</a></dt>
<dd>
<div class="block">This method can be used to directly call OPA without generating an
AuthorizationDecision, which can be used to examine the OPA response.</div>
</dd>
<dt><a href="com/styra/opa/springboot/OPAResponse.html" class="type-name-link" title="class in com.styra.opa.springboot">OPAResponse</a> - Class in <a href="com/styra/opa/springboot/package-summary.html">com.styra.opa.springboot</a></dt>
<dd>
<div class="block">This class models the data to be returned from an OPA-SpringBoot policy.</div>
<div class="block">This class models the data to be returned from an OPA Spring Boot SDK policy.</div>
</dd>
<dt><a href="com/styra/opa/springboot/OPAResponse.html#%3Cinit%3E()" class="member-name-link">OPAResponse()</a> - Constructor for class com.styra.opa.springboot.<a href="com/styra/opa/springboot/OPAResponse.html" title="class in com.styra.opa.springboot">OPAResponse</a></dt>
<dd>&nbsp;</dd>
<dt><a href="com/styra/opa/springboot/OPAResponseContext.html" class="type-name-link" title="class in com.styra.opa.springboot">OPAResponseContext</a> - Class in <a href="com/styra/opa/springboot/package-summary.html">com.styra.opa.springboot</a></dt>
<dd>
<div class="block">This class models the data to be returned from an OPA-SpringBoot policy
<div class="block">This class models the data to be returned from an OPA Spring Boot SDK policy
under the context key.</div>
</dd>
<dt><a href="com/styra/opa/springboot/OPAResponseContext.html#%3Cinit%3E()" class="member-name-link">OPAResponseContext()</a> - Constructor for class com.styra.opa.springboot.<a href="com/styra/opa/springboot/OPAResponseContext.html" title="class in com.styra.opa.springboot">OPAResponseContext</a></dt>
Expand Down
2 changes: 1 addition & 1 deletion javadoc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>springboot 0.0.4 API</title>
<title>springboot 0.0.5 API</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="index redirect">
Expand Down
Loading

0 comments on commit 37b4cec

Please sign in to comment.