xdi2.client

Interface XDIClient<MESSAGINGRESPONSE extends MessagingResponse>

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

XDIAbstractClient, XDIHttpClient, XDILocalClient, XDIWebSocketClient

public interface XDIClient<MESSAGINGRESPONSE extends MessagingResponse>
extends Closeable

An XDIClient can send XDI message envelopes to an XDI endpoint, and retrieve the results.

Author:

markus

Method Summary

Modifier and Type	Method and Description
void	addClientListener(XDIClientListener clientListener) Add a listener for XDI client events.
void	close() Shuts down the client.
void	fireDiscoverEvent(XDIDiscoverEvent discoveryEvent) Fire a discover event.
void	fireSendEvent(XDISendEvent sendEvent) Fire a send event.
void	removeClientListener(XDIClientListener clientListener) Remove a listener for XDI client events.
MESSAGINGRESPONSE	send(MessageEnvelope messageEnvelope) Sends an XDI messaging request to an XDI endpoint.

Method Detail

send

MESSAGINGRESPONSE send(MessageEnvelope messageEnvelope)
                throws Xdi2ClientException

Sends an XDI messaging request to an XDI endpoint.

Parameters:

messageEnvelope - The XDI messaging envelope to send.

Returns:

The messaging response.

Throws:

Xdi2ClientException

close

void close()

Shuts down the client.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

addClientListener

void addClientListener(XDIClientListener clientListener)

Add a listener for XDI client events.

removeClientListener

void removeClientListener(XDIClientListener clientListener)

Remove a listener for XDI client events.

fireSendEvent

void fireSendEvent(XDISendEvent sendEvent)

Fire a send event.

fireDiscoverEvent

void fireDiscoverEvent(XDIDiscoverEvent discoveryEvent)

Fire a discover event.