Skip to content

Commit 43010ec

Browse files
author
Open Identity Platform Community
committed
upload OpenIG docs after deploy 7e020ffe09b894da97e0ba975724ca8ef8121498
1 parent e2f5fb2 commit 43010ec

26 files changed

Lines changed: 1975 additions & 143 deletions

openig/apidocs/allclasses-index.html

Lines changed: 135 additions & 116 deletions
Large diffs are not rendered by default.

openig/apidocs/allclasses.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
166166
<li><a href="org/forgerock/openig/filter/MdcRouteIdFilter.html" title="class in org.forgerock.openig.filter">MdcRouteIdFilter</a></li>
167167
<li><a href="org/forgerock/openig/decoration/capture/MessageCapture.html" title="class in org.forgerock.openig.decoration.capture">MessageCapture</a></li>
168168
<li><a href="org/forgerock/openig/util/MessageType.html" title="enum in org.forgerock.openig.util">MessageType</a></li>
169+
<li><a href="org/forgerock/openig/handler/MockDataGenerator.html" title="class in org.forgerock.openig.handler">MockDataGenerator</a></li>
169170
<li><a href="org/openidentityplatform/openig/mq/MQ_IBM.html" title="class in org.openidentityplatform.openig.mq">MQ_IBM</a></li>
170171
<li><a href="org/openidentityplatform/openig/mq/MQ_IBM.Heaplet.html" title="class in org.openidentityplatform.openig.mq">MQ_IBM.Heaplet</a></li>
171172
<li><a href="org/openidentityplatform/openig/mq/MQ_Kafka.html" title="class in org.openidentityplatform.openig.mq">MQ_Kafka</a></li>
@@ -178,6 +179,8 @@ <h1 class="bar">All&nbsp;Classes</h1>
178179
<li><a href="org/forgerock/openig/filter/oauth2/client/OAuth2ErrorException.html" title="class in org.forgerock.openig.filter.oauth2.client">OAuth2ErrorException</a></li>
179180
<li><a href="org/forgerock/openig/filter/oauth2/OAuth2ResourceServerFilterHeaplet.html" title="class in org.forgerock.openig.filter.oauth2">OAuth2ResourceServerFilterHeaplet</a></li>
180181
<li><a href="org/forgerock/openig/openam/OpenAMClassAliasResolver.html" title="class in org.forgerock.openig.openam">OpenAMClassAliasResolver</a></li>
182+
<li><a href="org/forgerock/openig/handler/OpenApiMockResponseHandler.html" title="class in org.forgerock.openig.handler">OpenApiMockResponseHandler</a></li>
183+
<li><a href="org/forgerock/openig/handler/OpenApiMockResponseHandler.Heaplet.html" title="class in org.forgerock.openig.handler">OpenApiMockResponseHandler.Heaplet</a></li>
181184
<li><a href="org/forgerock/openig/handler/router/OpenApiRouteBuilder.html" title="class in org.forgerock.openig.handler.router">OpenApiRouteBuilder</a></li>
182185
<li><a href="org/forgerock/openig/handler/router/OpenApiSpecLoader.html" title="class in org.forgerock.openig.handler.router">OpenApiSpecLoader</a></li>
183186
<li><a href="org/forgerock/openig/filter/OpenApiValidationFilter.html" title="class in org.forgerock.openig.filter">OpenApiValidationFilter</a></li>

openig/apidocs/index-all.html

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -424,6 +424,10 @@ <h2 class="title">B</h2>
424424
<dd>
425425
<div class="block">Builds an OpenIG route <code>JsonValue</code> for the supplied OpenAPI specification.</div>
426426
</dd>
427+
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/router/OpenApiRouteBuilder.html#buildRouteJson(io.swagger.v3.oas.models.OpenAPI,java.io.File,boolean,boolean)">buildRouteJson(OpenAPI, File, boolean, boolean)</a></span> - Method in class org.forgerock.openig.handler.router.<a href="org/forgerock/openig/handler/router/OpenApiRouteBuilder.html" title="class in org.forgerock.openig.handler.router">OpenApiRouteBuilder</a></dt>
428+
<dd>
429+
<div class="block">Builds an OpenIG route <code>JsonValue</code> for the supplied OpenAPI specification.</div>
430+
</dd>
427431
</dl>
428432
<a id="I:C">
429433
<!-- -->
@@ -734,6 +738,8 @@ <h2 class="title">C</h2>
734738
<dd>&nbsp;</dd>
735739
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/DispatchHandler.Heaplet.html#create()">create()</a></span> - Method in class org.forgerock.openig.handler.<a href="org/forgerock/openig/handler/DispatchHandler.Heaplet.html" title="class in org.forgerock.openig.handler">DispatchHandler.Heaplet</a></dt>
736740
<dd>&nbsp;</dd>
741+
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/OpenApiMockResponseHandler.Heaplet.html#create()">create()</a></span> - Method in class org.forgerock.openig.handler.<a href="org/forgerock/openig/handler/OpenApiMockResponseHandler.Heaplet.html" title="class in org.forgerock.openig.handler">OpenApiMockResponseHandler.Heaplet</a></dt>
742+
<dd>&nbsp;</dd>
737743
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/router/AuditServiceObjectHeaplet.html#create()">create()</a></span> - Method in class org.forgerock.openig.handler.router.<a href="org/forgerock/openig/handler/router/AuditServiceObjectHeaplet.html" title="class in org.forgerock.openig.handler.router">AuditServiceObjectHeaplet</a></dt>
738744
<dd>&nbsp;</dd>
739745
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/router/RouterHandler.Heaplet.html#create()">create()</a></span> - Method in class org.forgerock.openig.handler.router.<a href="org/forgerock/openig/handler/router/RouterHandler.Heaplet.html" title="class in org.forgerock.openig.handler.router">RouterHandler.Heaplet</a></dt>
@@ -1543,6 +1549,10 @@ <h2 class="title">G</h2>
15431549
<dd>
15441550
<div class="block">Construct a <a href="org/forgerock/openig/http/GatewayHttpApplication.html" title="class in org.forgerock.openig.http"><code>GatewayHttpApplication</code></a>.</div>
15451551
</dd>
1552+
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/MockDataGenerator.html#generate(java.lang.String,io.swagger.v3.oas.models.media.Schema)">generate(String, Schema&lt;?&gt;)</a></span> - Static method in class org.forgerock.openig.handler.<a href="org/forgerock/openig/handler/MockDataGenerator.html" title="class in org.forgerock.openig.handler">MockDataGenerator</a></dt>
1553+
<dd>
1554+
<div class="block">Generates a realistic mock value for the given field name and schema.</div>
1555+
</dd>
15461556
<dt><a href="org/forgerock/openig/heap/GenericHeaplet.html" title="class in org.forgerock.openig.heap"><span class="typeNameLink">GenericHeaplet</span></a> - Class in <a href="org/forgerock/openig/heap/package-summary.html">org.forgerock.openig.heap</a></dt>
15471557
<dd>
15481558
<div class="block">A generic base class for heaplets with automatically injected fields.</div>
@@ -2109,6 +2119,8 @@ <h2 class="title">H</h2>
21092119
<dd>&nbsp;</dd>
21102120
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/DispatchHandler.html#handle(org.forgerock.services.context.Context,org.forgerock.http.protocol.Request)">handle(Context, Request)</a></span> - Method in class org.forgerock.openig.handler.<a href="org/forgerock/openig/handler/DispatchHandler.html" title="class in org.forgerock.openig.handler">DispatchHandler</a></dt>
21112121
<dd>&nbsp;</dd>
2122+
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/OpenApiMockResponseHandler.html#handle(org.forgerock.services.context.Context,org.forgerock.http.protocol.Request)">handle(Context, Request)</a></span> - Method in class org.forgerock.openig.handler.<a href="org/forgerock/openig/handler/OpenApiMockResponseHandler.html" title="class in org.forgerock.openig.handler">OpenApiMockResponseHandler</a></dt>
2123+
<dd>&nbsp;</dd>
21122124
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/resources/ResourceHandler.html#handle(org.forgerock.services.context.Context,org.forgerock.http.protocol.Request)">handle(Context, Request)</a></span> - Method in class org.forgerock.openig.handler.resources.<a href="org/forgerock/openig/handler/resources/ResourceHandler.html" title="class in org.forgerock.openig.handler.resources">ResourceHandler</a></dt>
21132125
<dd>&nbsp;</dd>
21142126
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/router/RouterHandler.html#handle(org.forgerock.services.context.Context,org.forgerock.http.protocol.Request)">handle(Context, Request)</a></span> - Method in class org.forgerock.openig.handler.router.<a href="org/forgerock/openig/handler/router/RouterHandler.html" title="class in org.forgerock.openig.handler.router">RouterHandler</a></dt>
@@ -2288,6 +2300,8 @@ <h2 class="title">H</h2>
22882300
<dd>&nbsp;</dd>
22892301
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/DispatchHandler.Heaplet.html#%3Cinit%3E()">Heaplet()</a></span> - Constructor for class org.forgerock.openig.handler.<a href="org/forgerock/openig/handler/DispatchHandler.Heaplet.html" title="class in org.forgerock.openig.handler">DispatchHandler.Heaplet</a></dt>
22902302
<dd>&nbsp;</dd>
2303+
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/OpenApiMockResponseHandler.Heaplet.html#%3Cinit%3E()">Heaplet()</a></span> - Constructor for class org.forgerock.openig.handler.<a href="org/forgerock/openig/handler/OpenApiMockResponseHandler.Heaplet.html" title="class in org.forgerock.openig.handler">OpenApiMockResponseHandler.Heaplet</a></dt>
2304+
<dd>&nbsp;</dd>
22912305
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/router/RouterHandler.Heaplet.html#%3Cinit%3E()">Heaplet()</a></span> - Constructor for class org.forgerock.openig.handler.router.<a href="org/forgerock/openig/handler/router/RouterHandler.Heaplet.html" title="class in org.forgerock.openig.handler.router">RouterHandler.Heaplet</a></dt>
22922306
<dd>&nbsp;</dd>
22932307
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/saml/SamlFederationHandler.Heaplet.html#%3Cinit%3E()">Heaplet()</a></span> - Constructor for class org.forgerock.openig.handler.saml.<a href="org/forgerock/openig/handler/saml/SamlFederationHandler.Heaplet.html" title="class in org.forgerock.openig.handler.saml">SamlFederationHandler.Heaplet</a></dt>
@@ -2749,6 +2763,12 @@ <h2 class="title">M</h2>
27492763
<dd>&nbsp;</dd>
27502764
<dt><span class="memberNameLink"><a href="org/openidentityplatform/openig/ai/filter/llm/LLMProvider.html#MISTRAL">MISTRAL</a></span> - org.openidentityplatform.openig.ai.filter.llm.<a href="org/openidentityplatform/openig/ai/filter/llm/LLMProvider.html" title="enum in org.openidentityplatform.openig.ai.filter.llm">LLMProvider</a></dt>
27512765
<dd>&nbsp;</dd>
2766+
<dt><a href="org/forgerock/openig/handler/MockDataGenerator.html" title="class in org.forgerock.openig.handler"><span class="typeNameLink">MockDataGenerator</span></a> - Class in <a href="org/forgerock/openig/handler/package-summary.html">org.forgerock.openig.handler</a></dt>
2767+
<dd>
2768+
<div class="block">Generates realistic mock values for OpenAPI schema properties.</div>
2769+
</dd>
2770+
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/router/RouterHandler.OpenApiValidationSettings.html#mockMode">mockMode</a></span> - Variable in class org.forgerock.openig.handler.router.<a href="org/forgerock/openig/handler/router/RouterHandler.OpenApiValidationSettings.html" title="class in org.forgerock.openig.handler.router">RouterHandler.OpenApiValidationSettings</a></dt>
2771+
<dd>&nbsp;</dd>
27522772
<dt><span class="memberNameLink"><a href="org/forgerock/openig/ldap/LdapConnection.html#modify(java.lang.String...)">modify(String...)</a></span> - Method in class org.forgerock.openig.ldap.<a href="org/forgerock/openig/ldap/LdapConnection.html" title="class in org.forgerock.openig.ldap">LdapConnection</a></dt>
27532773
<dd>
27542774
<div class="block">Modifies an entry in the Directory Server using the provided lines of
@@ -2970,6 +2990,19 @@ <h2 class="title">O</h2>
29702990
</dd>
29712991
<dt><span class="memberNameLink"><a href="org/forgerock/openig/openam/OpenAMClassAliasResolver.html#%3Cinit%3E()">OpenAMClassAliasResolver()</a></span> - Constructor for class org.forgerock.openig.openam.<a href="org/forgerock/openig/openam/OpenAMClassAliasResolver.html" title="class in org.forgerock.openig.openam">OpenAMClassAliasResolver</a></dt>
29722992
<dd>&nbsp;</dd>
2993+
<dt><a href="org/forgerock/openig/handler/OpenApiMockResponseHandler.html" title="class in org.forgerock.openig.handler"><span class="typeNameLink">OpenApiMockResponseHandler</span></a> - Class in <a href="org/forgerock/openig/handler/package-summary.html">org.forgerock.openig.handler</a></dt>
2994+
<dd>
2995+
<div class="block">A <code>Handler</code> that generates valid mock HTTP responses with realistic test data
2996+
derived from an OpenAPI / Swagger specification.</div>
2997+
</dd>
2998+
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/OpenApiMockResponseHandler.html#%3Cinit%3E(java.lang.String,int,int)">OpenApiMockResponseHandler(String, int, int)</a></span> - Constructor for class org.forgerock.openig.handler.<a href="org/forgerock/openig/handler/OpenApiMockResponseHandler.html" title="class in org.forgerock.openig.handler">OpenApiMockResponseHandler</a></dt>
2999+
<dd>
3000+
<div class="block">Creates a new mock handler backed by the supplied spec content.</div>
3001+
</dd>
3002+
<dt><a href="org/forgerock/openig/handler/OpenApiMockResponseHandler.Heaplet.html" title="class in org.forgerock.openig.handler"><span class="typeNameLink">OpenApiMockResponseHandler.Heaplet</span></a> - Class in <a href="org/forgerock/openig/handler/package-summary.html">org.forgerock.openig.handler</a></dt>
3003+
<dd>
3004+
<div class="block">Creates and initialises an <a href="org/forgerock/openig/handler/OpenApiMockResponseHandler.html" title="class in org.forgerock.openig.handler"><code>OpenApiMockResponseHandler</code></a> in a heap environment.</div>
3005+
</dd>
29733006
<dt><a href="org/forgerock/openig/handler/router/OpenApiRouteBuilder.html" title="class in org.forgerock.openig.handler.router"><span class="typeNameLink">OpenApiRouteBuilder</span></a> - Class in <a href="org/forgerock/openig/handler/router/package-summary.html">org.forgerock.openig.handler.router</a></dt>
29743007
<dd>
29753008
<div class="block">Converts a parsed <code>OpenAPI</code> model into an OpenIG route <code>JsonValue</code>.</div>
@@ -2994,6 +3027,8 @@ <h2 class="title">O</h2>
29943027
<dd>&nbsp;</dd>
29953028
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/router/RouterHandler.OpenApiValidationSettings.html#%3Cinit%3E(boolean,boolean)">OpenApiValidationSettings(boolean, boolean)</a></span> - Constructor for class org.forgerock.openig.handler.router.<a href="org/forgerock/openig/handler/router/RouterHandler.OpenApiValidationSettings.html" title="class in org.forgerock.openig.handler.router">RouterHandler.OpenApiValidationSettings</a></dt>
29963029
<dd>&nbsp;</dd>
3030+
<dt><span class="memberNameLink"><a href="org/forgerock/openig/handler/router/RouterHandler.OpenApiValidationSettings.html#%3Cinit%3E(boolean,boolean,boolean)">OpenApiValidationSettings(boolean, boolean, boolean)</a></span> - Constructor for class org.forgerock.openig.handler.router.<a href="org/forgerock/openig/handler/router/RouterHandler.OpenApiValidationSettings.html" title="class in org.forgerock.openig.handler.router">RouterHandler.OpenApiValidationSettings</a></dt>
3031+
<dd>&nbsp;</dd>
29973032
<dt><span class="memberNameLink"><a href="org/forgerock/openig/jwt/JwtCookieSession.html#OPENIG_JWT_SESSION">OPENIG_JWT_SESSION</a></span> - Static variable in class org.forgerock.openig.jwt.<a href="org/forgerock/openig/jwt/JwtCookieSession.html" title="class in org.forgerock.openig.jwt">JwtCookieSession</a></dt>
29983033
<dd>
29993034
<div class="block">Name of the cookie that will store the JWT session.</div>

openig/apidocs/member-search-index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
128 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)