Skip to content

Commit

Permalink
Updated for version 4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@robtimus
robtimus committed Apr 13, 2024
1 parent aeedb86 commit 0ff5135
Show file tree
Hide file tree
Showing 137 changed files with 10,698 additions and 16,825 deletions.
51 changes: 25 additions & 26 deletions actuator-endpoints.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@


<!--
| Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/xhtml/actuator-endpoints.xhtml at 2023-09-27
| Generated by Apache Maven Doxia Site Renderer 1.11.1 from src/site/xhtml/actuator-endpoints.xhtml at 2024-04-13
| Rendered using Apache Maven Fluido Skin 1.11.2
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
Expand Down Expand Up @@ -30,9 +30,9 @@

<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2023-09-27<span class="divider">|</span>
<li id="publishDate">Last Published: 2024-04-13<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 3.8</li>
<li id="projectVersion">Version: 4.0</li>
</ul>
</div>
</header>
Expand Down Expand Up @@ -75,21 +75,21 @@ <h2><a name="Actuator_endpoints"></a>Actuator endpoints</h2>

<p>By default all endpoints are exposed over JMX, but only the <code>info</code> and <code>health</code> endpoints are exposed over HTTP.
To expose these custom endpoints over HTTP as well you need to set property <code>management.endpoints.web.exposure.include</code> with all endpoints you want enabled.
See <a class="externalLink" href="https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-endpoints.html#production-ready-endpoints-exposing-endpoints">Exposing Endpoints</a> for more information.</p>
See <a class="externalLink" href="https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.endpoints">Exposing Endpoints</a> for more information.</p>

<section>
<h3><a name="Logging"></a>Logging</h3>

<p>ID: <code>connectSdkLogging</code></p>

<p>This actuator endpoint allows you to <a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/logging/LoggingCapable.html">enable and disable logging</a> during runtime.
<p>This actuator endpoint allows you to <a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/logging/LoggingCapable.html">enable and disable logging</a> during runtime.
It defines the following operations:</p>

<section>
<h4><a name="listLoggingCapableAndLoggerBeans"></a>listLoggingCapableAndLoggerBeans</h4>

<p>Lists all available <a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/logging/LoggingCapable.html">LoggingCapable</a>
and <a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/logging/CommunicatorLogger.html">CommunicatorLogger</a> beans.</p>
<p>Lists all available <a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/logging/LoggingCapable.html">LoggingCapable</a>
and <a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/logging/CommunicatorLogger.html">CommunicatorLogger</a> beans.</p>

<p>HTTP endpoint example:</p>

Expand All @@ -99,9 +99,9 @@ <h4><a name="listLoggingCapableAndLoggerBeans"></a>listLoggingCapableAndLoggerBe
</section><section>
<h4><a name="enableLogging"></a>enableLogging</h4>

<p>Enables logging on all <a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/logging/LoggingCapable.html">LoggingCapable</a> beans.</p>
<p>Enables logging on all <a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/logging/LoggingCapable.html">LoggingCapable</a> beans.</p>

<p>By default all available <a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/logging/CommunicatorLogger.html">CommunicatorLogger</a> beans will be used in a compound logger.
<p>By default all available <a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/logging/CommunicatorLogger.html">CommunicatorLogger</a> beans will be used in a compound logger.
By providing argument <code>logger</code> you can specify a single <code>CommunicatorLogger</code> instead.</p>

<p>HTTP endpoint examples:</p>
Expand All @@ -114,9 +114,9 @@ <h4><a name="enableLogging"></a>enableLogging</h4>
</section><section>
<h4><a name="enableLoggingOnBean"></a>enableLoggingOnBean</h4>

<p>Enables logging on a specific <a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/logging/LoggingCapable.html">LoggingCapable</a> bean.</p>
<p>Enables logging on a specific <a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/logging/LoggingCapable.html">LoggingCapable</a> bean.</p>

<p>By default all available <a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/logging/CommunicatorLogger.html">CommunicatorLogger</a> beans will be used in a compound logger.
<p>By default all available <a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/logging/CommunicatorLogger.html">CommunicatorLogger</a> beans will be used in a compound logger.
By providing argument <code>logger</code> you can specify a single <code>CommunicatorLogger</code> instead.</p>

<p>HTTP endpoint examples:</p>
Expand All @@ -129,7 +129,7 @@ <h4><a name="enableLoggingOnBean"></a>enableLoggingOnBean</h4>
</section><section>
<h4><a name="disableLogging"></a>disableLogging</h4>

<p>Disables logging on all <a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/logging/LoggingCapable.html">LoggingCapable</a> beans.</p>
<p>Disables logging on all <a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/logging/LoggingCapable.html">LoggingCapable</a> beans.</p>

<p>HTTP endpoint example:</p>

Expand All @@ -139,7 +139,7 @@ <h4><a name="disableLogging"></a>disableLogging</h4>
</section><section>
<h4><a name="disableLoggingOnBean"></a>disableLoggingOnBean</h4>

<p>Disables logging on a specific <a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/logging/LoggingCapable.html">LoggingCapable</a> bean.</p>
<p>Disables logging on a specific <a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/logging/LoggingCapable.html">LoggingCapable</a> bean.</p>

<p>HTTP endpoint example:</p>

Expand All @@ -154,9 +154,9 @@ <h3><a name="Connections"></a>Connections</h3>
<p>ID: <code>connectSdkConnections</code></p>

<p>This actuator endpoint allows you to call <code>closeIdleConnections</code> and <code>closeExpiredConnections</code> on beans of types
<a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/PooledConnection.html">PooledConnection</a>,
<a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/Communicator.html">Communicator</a> and
<a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/Client.html">Client</a>.
<a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/communication/PooledConnection.html">PooledConnection</a>,
<a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/Communicator.html">Communicator</a> and
<a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/Client.html">Client</a>.
It defines the following operations:</p>

<section>
Expand All @@ -173,9 +173,9 @@ <h4><a name="listCloseableBeans"></a>listCloseableBeans</h4>
<h4><a name="closeConnections"></a>closeConnections</h4>

<p>Closes connections for all available
<a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/PooledConnection.html">PooledConnection</a>,
<a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/Communicator.html">Communicator</a> and
<a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/Client.html">Client</a> beans.</p>
<a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/communication/PooledConnection.html">PooledConnection</a>,
<a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/Communicator.html">Communicator</a> and
<a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/Client.html">Client</a> beans.</p>

<p>Argument <code>idleTime</code> is optional, and defaults to the value of the <code>connect.api.close-idle-connections.idle-time</code> <a href="properties.html">property</a>.
It can be specified <a class="externalLink" href="https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.external-config.typesafe-configuration-properties.conversion.durations">as a duration in the Spring Boot supported format</a>.</p>
Expand All @@ -195,9 +195,9 @@ <h4><a name="closeConnections"></a>closeConnections</h4>
<h4><a name="closeConnectionsForBean"></a>closeConnectionsForBean</h4>

<p>Closes connections for a specific
<a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/PooledConnection.html">PooledConnection</a>,
<a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/Communicator.html">Communicator</a> or
<a class="externalLink" href="https://ingenico-epayments.github.io/connect-sdk-java/apidocs/latest/com/ingenico/connect/gateway/sdk/java/Client.html">Client</a> bean.</p>
<a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/communication/PooledConnection.html">PooledConnection</a>,
<a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/Communicator.html">Communicator</a> or
<a class="externalLink" href="https://worldline-global-collect.github.io/connect-sdk-java/apidocs/latest/com/worldline/connect/sdk/java/Client.html">Client</a> bean.</p>

<p>Argument <code>idleTime</code> is optional, and defaults to the value of the <code>connect.api.close-idle-connections.idle-time</code> <a href="properties.html">property</a>.
It can be specified <a class="externalLink" href="https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.external-config.typesafe-configuration-properties.conversion.durations">as a duration in the Spring Boot supported format</a>.</p>
Expand Down Expand Up @@ -226,13 +226,12 @@ <h3><a name="Authentication"></a>Authentication</h3>
<section>
<h4><a name="setApiKey"></a>setApiKey</h4>

<p>Changes the API key id, secret API key and authorization type (defaults to <code>V1HMAC</code>) of the auto-configured <code>Authenticator</code>.</p>
<p>Changes the API key id and secret API key of the auto-configured v1HMAC <code>Authenticator</code>.</p>

<p>HTTP endpoint example:</p>

<div>
<pre>curl -X POST http://&lt;host&gt;/actuator/connectSdkApiKey -H Content-Type:application/json -d '{&quot;apiKeyId&quot;: &quot;myApiKeyId&quot;, &quot;secretApiKey&quot;: &quot;mySecretKeyId&quot;}'
curl -X POST http://&lt;host&gt;/actuator/connectSdkApiKey -H Content-Type:application/json -d '{&quot;apiKeyId&quot;: &quot;myApiKeyId&quot;, &quot;secretApiKey&quot;: &quot;mySecretKeyId&quot;, &quot;authorizationType&quot;: &quot;V1HMAC&quot;}'</pre></div>
<pre>curl -X POST http://&lt;host&gt;/actuator/connectSdkApiKey -H Content-Type:application/json -d '{&quot;apiKeyId&quot;: &quot;myApiKeyId&quot;, &quot;secretApiKey&quot;: &quot;mySecretKeyId&quot;}'</pre></div>

</section></section></section>

Expand All @@ -243,7 +242,7 @@ <h4><a name="setApiKey"></a>setApiKey</h4>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p>&#169; 2019&#x2013;2023
<p>&#169; 2019&#x2013;2024
</p>
</div>
</div>
Expand Down
Loading

0 comments on commit 0ff5135

Please sign in to comment.