com.oneidentity.safeguard.safeguardjava

Class Safeguard

java.lang.Object

com.oneidentity.safeguard.safeguardjava.Safeguard

public final class Safeguard
extends Object

This static class provides static methods for connecting to Safeguard API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Safeguard.A2A This static class provides access to Safeguard A2A functionality.
static class	Safeguard.Event This static class provides access to Safeguard Event functionality with persistent event listeners.

Method Summary

Modifier and Type	Method and Description
static ISafeguardConnection	connect(String networkAddress, char[] accessToken, Integer apiVersion, Boolean ignoreSsl) Connect to Safeguard API using an API access token.
static ISafeguardConnection	connect(String networkAddress, Integer apiVersion, Boolean ignoreSsl) Connect to Safeguard API anonymously.
static ISafeguardConnection	connect(String networkAddress, String certificatePath, char[] certificatePassword, Integer apiVersion, Boolean ignoreSsl) Connect to Safeguard API using a certificate stored in a file.
static ISafeguardConnection	connect(String networkAddress, String keystorePath, char[] keystorePassword, String certificateAlias, Integer apiVersion, Boolean ignoreSsl) Connect to Safeguard API using a certificate from the keystore.
static ISafeguardConnection	connect(String networkAddress, String provider, String username, char[] password, Integer apiVersion, Boolean ignoreSsl) Connect to Safeguard API using a user name and password.

Methods inherited from class java.lang.Object

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

Method Detail

connect

public static ISafeguardConnection connect(String networkAddress,
                                           char[] accessToken,
                                           Integer apiVersion,
                                           Boolean ignoreSsl)
                                    throws ArgumentException

Connect to Safeguard API using an API access token.

Parameters:

networkAddress - Network address of Safeguard appliance.

accessToken - Existing API access token.

apiVersion - Target API version to use.

ignoreSsl - Ignore server certificate validation.

Returns:

Reusable Safeguard API connection.

Throws:

ArgumentException - Invalid argument.

connect

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

Connect to Safeguard API using a user name and password.

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:

Reusable Safeguard API connection.

Throws:

ObjectDisposedException - Object has already been disposed.

ArgumentException - Invalid argument.

SafeguardForJavaException - General Safeguard for Java exception.

connect

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

Connect to Safeguard API using a certificate from the keystore. The appropriate keystore must have been loaded in the java process.

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:

Reusable Safeguard API connection.

Throws:

ObjectDisposedException - Object has already been disposed.

SafeguardForJavaException - General Safeguard for Java exception.

connect

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

Connect to Safeguard API using a 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:

Reusable Safeguard API connection.

Throws:

ObjectDisposedException - Object has already been disposed.

SafeguardForJavaException - General Safeguard for Java exception.

connect

public static ISafeguardConnection connect(String networkAddress,
                                           Integer apiVersion,
                                           Boolean ignoreSsl)

Connect to Safeguard API anonymously.

Parameters:

networkAddress - Network address.

apiVersion - API version.

ignoreSsl - If set to true ignore ssl.

Returns:

The connect.