com.oneidentity.safeguard.safeguardjava.event

Class SafeguardEventListener

java.lang.Object

com.oneidentity.safeguard.safeguardjava.event.SafeguardEventListener

All Implemented Interfaces:

ISafeguardEventListener

public class SafeguardEventListener
extends Object
implements ISafeguardEventListener

Field Summary

Fields

Modifier and Type	Field and Description
HubProxy	signalrHubProxy

Constructor Summary

Constructors

Constructor and Description
SafeguardEventListener(String eventUrl, CertificateContext clientCertificate, char[] apiKey, boolean ignoreSsl)
SafeguardEventListener(String eventUrl, CertificateContext clientCertificate, List<char[]> apiKeys, boolean ignoreSsl)
SafeguardEventListener(String eventUrl, char[] accessToken, boolean ignoreSsl)
SafeguardEventListener(String eventUrl, String clientCertificatePath, char[] certificatePassword, String certificateAlias, char[] apiKey, boolean ignoreSsl)
SafeguardEventListener(String eventUrl, String clientCertificatePath, char[] certificatePassword, String certificateAlias, List<char[]> apiKeys, boolean ignoreSsl)

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes of the connection.
protected void	finalize()
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	setDisconnectHandler(IDisconnectHandler handler)
void	setEventHandlerRegistry(EventHandlerRegistry registry)
void	start() Start listening for Safeguard events in a background thread.
void	stop() Stop listening for Safeguard events in a background thread.

Methods inherited from class java.lang.Object

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

Field Detail

signalrHubProxy

public HubProxy signalrHubProxy

Constructor Detail

SafeguardEventListener

public SafeguardEventListener(String eventUrl,
                              char[] accessToken,
                              boolean ignoreSsl)
                       throws ArgumentException

Throws:

ArgumentException

SafeguardEventListener

public SafeguardEventListener(String eventUrl,
                              String clientCertificatePath,
                              char[] certificatePassword,
                              String certificateAlias,
                              char[] apiKey,
                              boolean ignoreSsl)
                       throws ArgumentException

Throws:

ArgumentException

SafeguardEventListener

public SafeguardEventListener(String eventUrl,
                              CertificateContext clientCertificate,
                              char[] apiKey,
                              boolean ignoreSsl)
                       throws ArgumentException

Throws:

ArgumentException

SafeguardEventListener

public SafeguardEventListener(String eventUrl,
                              String clientCertificatePath,
                              char[] certificatePassword,
                              String certificateAlias,
                              List<char[]> apiKeys,
                              boolean ignoreSsl)
                       throws ArgumentException

Throws:

ArgumentException

SafeguardEventListener

public SafeguardEventListener(String eventUrl,
                              CertificateContext clientCertificate,
                              List<char[]> apiKeys,
                              boolean ignoreSsl)
                       throws ArgumentException

Throws:

ArgumentException

Method Detail

setDisconnectHandler

public void setDisconnectHandler(IDisconnectHandler handler)

setEventHandlerRegistry

public void setEventHandlerRegistry(EventHandlerRegistry registry)

isStarted

public boolean isStarted()

Description copied from interface: ISafeguardEventListener

Indicates whether the SignalR connection has completed start up.

Specified by:

isStarted in interface ISafeguardEventListener

Returns:

boolean flag

registerEventHandler

public void registerEventHandler(String eventName,
                                 ISafeguardEventHandler handler)
                          throws ObjectDisposedException

Description copied from interface: ISafeguardEventListener

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

Specified by:

registerEventHandler in interface ISafeguardEventListener

Parameters:

eventName - Name of the event.

handler - Callback method.

Throws:

ObjectDisposedException - Object has already been disposed

start

public void start()
           throws ObjectDisposedException,
                  SafeguardForJavaException,
                  SafeguardEventListenerDisconnectedException

Description copied from interface: ISafeguardEventListener

Start listening for Safeguard events in a background thread.

Specified by:

start in interface ISafeguardEventListener

Throws:

ObjectDisposedException - Object has already been disposed

SafeguardForJavaException - General Safeguard for Java exception

SafeguardEventListenerDisconnectedException - Event listener has been disconnected

stop

public void stop()
          throws ObjectDisposedException,
                 SafeguardForJavaException

Description copied from interface: ISafeguardEventListener

Stop listening for Safeguard events in a background thread.

Specified by:

stop in interface ISafeguardEventListener

Throws:

ObjectDisposedException - Object has already been disposed

SafeguardForJavaException - General Safeguard for Java exception

dispose

public void dispose()

Description copied from interface: ISafeguardEventListener

Disposes of the connection.

Specified by:

dispose in interface ISafeguardEventListener

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable