com.oneidentity.safeguard.safeguardjava.event

Interface ISafeguardEventListener

All Known Implementing Classes:

PersistentSafeguardA2AEventListener, PersistentSafeguardEventListener, PersistentSafeguardEventListenerBase, SafeguardEventListener

public interface ISafeguardEventListener

This is an event listener interface that will allow you to be notified each time something changes on Safeguard. The events that you are notified for depend on the role and event registrations of the authenticated user. Safeguard event listeners use SignalR to make long-lived connections to Safeguard.

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes of the connection.
boolean	isStarted() Indicates whether the SignalR connection has completed start up.
void	registerEventHandler(String eventName, ISafeguardEventHandler handler) Register an event handler to be called each time the specified event occurs.
void	start() Start listening for Safeguard events in a background thread.
void	stop() Stop listening for Safeguard events in a background thread.

Method Detail

registerEventHandler

void registerEventHandler(String eventName,
                          ISafeguardEventHandler handler)
                   throws ObjectDisposedException

Register an event handler to be called each time the specified event occurs. Multiple handlers may be registered for each event.

Parameters:

eventName - Name of the event.

handler - Callback method.

Throws:

ObjectDisposedException - Object has already been disposed

start

void start()
    throws ObjectDisposedException,
           SafeguardForJavaException,
           SafeguardEventListenerDisconnectedException

Start listening for Safeguard events in a background thread.

Throws:

ObjectDisposedException - Object has already been disposed

SafeguardForJavaException - General Safeguard for Java exception

SafeguardEventListenerDisconnectedException - Event listener has been disconnected

stop

void stop()
   throws ObjectDisposedException,
          SafeguardForJavaException

Stop listening for Safeguard events in a background thread.

Throws:

ObjectDisposedException - Object has already been disposed

SafeguardForJavaException - General Safeguard for Java exception

isStarted

boolean isStarted()

Indicates whether the SignalR connection has completed start up.

Returns:

boolean flag

dispose

void dispose()

Disposes of the connection.