Package org.hyperledger.aries

Class AriesWebSocketClient

java.lang.Object

org.hyperledger.aries.webhook.ReactiveEventHandler

org.hyperledger.aries.AriesWebSocketClient

All Implemented Interfaces:

AutoCloseable, IEventHandler

public class AriesWebSocketClient
extends ReactiveEventHandler
implements AutoCloseable

ACA-PY Websocket Client: Receives events from aca-py

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AriesWebSocketClient.AriesWebSocketClientBuilder

Constructor Summary

Constructors

Constructor	Description
AriesWebSocketClient(String url, String apiKey, String bearerToken, okhttp3.OkHttpClient client, List<IEventHandler> handler, List<String> walletIdFilter)	Create a new websocket client, supports builder methods like: AriesWebSocketClient.builder().build()

Method Summary

Modifier and Type	Method	Description
static AriesWebSocketClient.AriesWebSocketClientBuilder	builder()
void	close()

Methods inherited from class org.hyperledger.aries.webhook.ReactiveEventHandler

basicMessage, connection, credentialEx, credentialExV2, credentialIssueIndy, credentialIssueLD, discoverFeature, endorseTrx, handleEvent, handleEvent, issuerRevocation, ping, presentationEx, presentationExV2, problemReport, revocationNotification, revocationNotificationV2

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AriesWebSocketClient

public AriesWebSocketClient(@Nullable
                            String url,
                            @Nullable
                            String apiKey,
                            @Nullable
                            String bearerToken,
                            @Nullable
                            okhttp3.OkHttpClient client,
                            List<IEventHandler> handler,
                            @Nullable
                            List<String> walletIdFilter)

Create a new websocket client, supports builder methods like: AriesWebSocketClient.builder().build()

Parameters:

url - Optional: The aca-py ws URL e.g. ws(s)://host:[port]/ws, defaults to localhost

apiKey - Optional: The admin api key if security is enabled

bearerToken - Optional: The Bearer token used in the Authorization header when running in multi tenant mode

client - Optional: OkHttpClient if null or not set a default client is created

handler - Optional: None, one or many custom event handler implementations, defaults to EventHandler.DefaultEventHandler

walletIdFilter - Optional: Filter events by provided walletId

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

builder

public static AriesWebSocketClient.AriesWebSocketClientBuilder builder()