com.oneidentity.safeguard.safeguardjava

Class Safeguard.Event

java.lang.Object

com.oneidentity.safeguard.safeguardjava.Safeguard.Event

Enclosing class:

Safeguard

public static class Safeguard.Event
extends Object

This static class provides access to Safeguard Event functionality with persistent event listeners. Persistent event listeners can handle longer term service outages to reconnect SignalR even after it times out. It is recommended to use these interfaces when listening for Safeguard events from a long-running service.

Constructor Summary

Constructors

Constructor and Description
Event()

Method Summary

Modifier and Type	Method and Description
static ISafeguardEventListener	getPersistentEventListener(String networkAddress, String certificatePath, char[] certificatePassword, Integer apiVersion, Boolean ignoreSsl) Get a persistent event listener using a client certificate stored in a file.
static ISafeguardEventListener	getPersistentEventListener(String networkAddress, String keystorePath, char[] keystorePassword, String certificateAlias, Integer apiVersion, Boolean ignoreSsl) Get a persistent event listener using a client certificate from the certificate keystore for authentication.
static ISafeguardEventListener	getPersistentEventListener(String networkAddress, String provider, String username, char[] password, Integer apiVersion, Boolean ignoreSsl) Get a persistent event listener using a username and password credential for authentication.

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event()

Method Detail

getPersistentEventListener

public static ISafeguardEventListener getPersistentEventListener(String networkAddress,
                                                                 String provider,
                                                                 String username,
                                                                 char[] password,
                                                                 Integer apiVersion,
                                                                 Boolean ignoreSsl)
                                                          throws ObjectDisposedException,
                                                                 SafeguardForJavaException,
                                                                 ArgumentException

Get a persistent event listener using a username and password credential for authentication.

Parameters:

networkAddress - Network address of Safeguard appliance.

provider - Safeguard authentication provider name (e.g. local).

username - User name to use for authentication.

password - User password to use for authentication.

apiVersion - Target API version to use.

ignoreSsl - Ignore server certificate validation.

Returns:

New persistent Safeguard event listener.

Throws:

ObjectDisposedException - Object has already been disposed.

SafeguardForJavaException - General Safeguard for Java

ArgumentException - Invalid argument. exception.

getPersistentEventListener

public static ISafeguardEventListener getPersistentEventListener(String networkAddress,
                                                                 String certificatePath,
                                                                 char[] certificatePassword,
                                                                 Integer apiVersion,
                                                                 Boolean ignoreSsl)
                                                          throws ObjectDisposedException,
                                                                 SafeguardForJavaException

Get a persistent event listener using a client certificate stored in a file.

Parameters:

networkAddress - Network address of Safeguard appliance.

certificatePath - Path to PFX (or PKCS12) certificate file also containing private key.

certificatePassword - Password to decrypt the certificate file.

apiVersion - Target API version to use.

ignoreSsl - Ignore server certificate validation.

Returns:

New persistent Safeguard event listener.

Throws:

ObjectDisposedException - Object has already been disposed.

SafeguardForJavaException - General Safeguard for Java exception.

getPersistentEventListener

public static ISafeguardEventListener getPersistentEventListener(String networkAddress,
                                                                 String keystorePath,
                                                                 char[] keystorePassword,
                                                                 String certificateAlias,
                                                                 Integer apiVersion,
                                                                 Boolean ignoreSsl)
                                                          throws ObjectDisposedException,
                                                                 SafeguardForJavaException

Get a persistent event listener using a client certificate from the certificate keystore for authentication.

Parameters:

networkAddress - Network address of Safeguard appliance.

keystorePath - Path to the keystore containing the client certificate.

keystorePassword - Keystore password.

certificateAlias - Alias identifying a client certificate in the keystore.

apiVersion - Target API version to use.

ignoreSsl - Ignore server certificate validation.

Returns:

New persistent Safeguard event listener.

Throws:

ObjectDisposedException - Object has already been disposed.

SafeguardForJavaException - General Safeguard for Java exception.