de.fhg.aisec.ids.comm.client

Class IdscpClient

java.lang.Object

de.fhg.aisec.ids.comm.client.IdscpClient

public class IdscpClient
extends java.lang.Object

A standalone client implementation for the IDSCP protocol.

Simply call connect() and use the returned WebSocket object for bidirectional text/binary web socket communication with the remote endpoint.

Make sure to check handleAttestationResult() and getMetaData() to assess trustworthiness of the remote endpoint and the self description returned by it.

Constructor Summary

Constructors

Constructor and Description
IdscpClient()

Method Summary

Modifier and Type	Method and Description
@NonNull IdscpClient	config(@NonNull ClientConfiguration config) Sets the configuration of this client.
org.asynchttpclient.ws.WebSocket	connect(@NonNull java.lang.String host, int port) Connects to a remote endpoint, executes the IDSCP handshake and returns the ready-to-use WebSocket object.
org.asynchttpclient.ws.WebSocket	connect(java.net.URI uri) Deprecated.
@Nullable de.fhg.aisec.ids.api.conm.RatResult	getAttestationResult() Returns null if attestation has not yet finished, or status code of remote attestation otherwise.
@Nullable java.lang.String	getMetaData() Returns meta data about the remote endpoint or null if no meta data has been exchanged.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdscpClient

public IdscpClient()

Method Detail

connect

@Deprecated
public org.asynchttpclient.ws.WebSocket connect(java.net.URI uri)
                                                     throws java.lang.InterruptedException,
                                                            java.util.concurrent.ExecutionException,
                                                            java.security.KeyManagementException,
                                                            java.security.NoSuchAlgorithmException

Deprecated.

Connects to a remote endpoint, executes the IDSCP handshake and returns the ready-to-use WebSocket object.

Throws:

java.security.NoSuchAlgorithmException - Use connect(String host, int port) instead.

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.security.KeyManagementException

connect

public org.asynchttpclient.ws.WebSocket connect(@NonNull java.lang.String host,
                                                int port)
                                         throws java.lang.InterruptedException,
                                                java.util.concurrent.ExecutionException,
                                                java.security.KeyManagementException,
                                                java.security.NoSuchAlgorithmException

Connects to a remote endpoint, executes the IDSCP handshake and returns the ready-to-use WebSocket object.

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.security.KeyManagementException

java.security.NoSuchAlgorithmException

config

public @NonNull IdscpClient config(@NonNull ClientConfiguration config)

Sets the configuration of this client.

Use this method in a fluent API style before calling connect():

 new IdscpClient().config(config).connect(url);
 

getAttestationResult

public @Nullable de.fhg.aisec.ids.api.conm.RatResult getAttestationResult()

Returns null if attestation has not yet finished, or status code of remote attestation otherwise.

getMetaData

public @Nullable java.lang.String getMetaData()

Returns meta data about the remote endpoint or null if no meta data has been exchanged.