com.oneidentity.safeguard.safeguardjava

Class SafeguardA2AContext

java.lang.Object

com.oneidentity.safeguard.safeguardjava.SafeguardA2AContext

All Implemented Interfaces:

ISafeguardA2AContext

public class SafeguardA2AContext
extends Object
implements ISafeguardA2AContext

Constructor Summary

Constructors

Constructor and Description
SafeguardA2AContext(String networkAddress, String certificatePath, char[] certificatePassword, int apiVersion, boolean ignoreSsl)
SafeguardA2AContext(String networkAddress, String certificateAlias, int apiVersion, boolean ignoreSsl)
SafeguardA2AContext(String networkAddress, String certificateAlias, String certificatePath, char[] certificatePassword, int apiVersion, boolean ignoreSsl)

Method Summary

Modifier and Type	Method and Description
String	brokerAccessRequest(char[] apiKey, BrokeredAccessRequest accessRequest) Creates an access request on behalf of another user using Safeguard A2A.
Object	cloneObject()
void	dispose() Dispose of an object
protected void	finalize()
ISafeguardEventListener	getA2AEventListener(char[] apiKey, ISafeguardEventHandler handler) Gets an A2A event listener.
ISafeguardEventListener	getA2AEventListener(List<char[]> apiKeys, ISafeguardEventHandler handler) Gets an A2A event listener.
ISafeguardEventListener	getPersistentA2AEventListener(char[] apiKey, ISafeguardEventHandler handler) Gets a persistent A2A event listener.
ISafeguardEventListener	getPersistentA2AEventListener(List<char[]> apiKeys, ISafeguardEventHandler handler) Gets a persistent A2A event listener.
List<A2ARetrievableAccount>	getRetrievableAccounts() Retrieves the list of retrievable accounts for this A2A context.
char[]	retrievePassword(char[] apiKey) Retrieves a password using Safeguard A2A.

Methods inherited from class java.lang.Object

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

Constructor Detail

SafeguardA2AContext

public SafeguardA2AContext(String networkAddress,
                           String certificateAlias,
                           String certificatePath,
                           char[] certificatePassword,
                           int apiVersion,
                           boolean ignoreSsl)

SafeguardA2AContext

public SafeguardA2AContext(String networkAddress,
                           String certificateAlias,
                           int apiVersion,
                           boolean ignoreSsl)

SafeguardA2AContext

public SafeguardA2AContext(String networkAddress,
                           String certificatePath,
                           char[] certificatePassword,
                           int apiVersion,
                           boolean ignoreSsl)

Method Detail

getRetrievableAccounts

public List<A2ARetrievableAccount> getRetrievableAccounts()
                                                   throws ObjectDisposedException,
                                                          SafeguardForJavaException

Description copied from interface: ISafeguardA2AContext

Retrieves the list of retrievable accounts for this A2A context. Listing the retrievable accounts is a new feature for Safeguard v2.8+, and it needs to be enabled in the A2A configuration.

Specified by:

getRetrievableAccounts in interface ISafeguardA2AContext

Returns:

A list of retrievable accounts.

Throws:

ObjectDisposedException - Object has already been disposed.

SafeguardForJavaException - General Safeguard for Java exception.

retrievePassword

public char[] retrievePassword(char[] apiKey)
                        throws ObjectDisposedException,
                               SafeguardForJavaException,
                               ArgumentException

Description copied from interface: ISafeguardA2AContext

Retrieves a password using Safeguard A2A.

Specified by:

retrievePassword in interface ISafeguardA2AContext

Parameters:

apiKey - API key corresponding to the configured account.

Returns:

The password.

Throws:

ObjectDisposedException - Object has already been disposed.

SafeguardForJavaException - General Safeguard for Java exception.

ArgumentException - Invalid argument.

getA2AEventListener

public ISafeguardEventListener getA2AEventListener(char[] apiKey,
                                                   ISafeguardEventHandler handler)
                                            throws ObjectDisposedException,
                                                   ArgumentException

Description copied from interface: ISafeguardA2AContext

Gets an A2A event listener. The handler passed in will be registered for the AssetAccountPasswordUpdated event, which is the only one supported in A2A. You just have to call Start(). The event listener returned by this method WILL NOT automatically recover from a SignalR timeout which occurs when there is a 30+ second outage. To get an event listener that supports recovering from longer term outages, please use getPersistentEventListener() to request a persistent event listener.

Specified by:

getA2AEventListener in interface ISafeguardA2AContext

Parameters:

apiKey - API key corresponding to the configured account to listen for.

handler - A delegate to call any time the AssetAccountPasswordUpdate event occurs.

Returns:

The event listener.

Throws:

ObjectDisposedException - The object has already been disposed.

ArgumentException - Invalid argument.

getA2AEventListener

public ISafeguardEventListener getA2AEventListener(List<char[]> apiKeys,
                                                   ISafeguardEventHandler handler)
                                            throws ObjectDisposedException,
                                                   ArgumentException

Description copied from interface: ISafeguardA2AContext

Gets an A2A event listener. The handler passed in will be registered for the AssetAccountPasswordUpdated event, which is the only one supported in A2A. You just have to call Start(). The event listener returned by this method WILL NOT automatically recover from a SignalR timeout which occurs when there is a 30+ second outage. To get an event listener that supports recovering from longer term outages, please use getPersistentEventListener() to request a persistent event listener.

Specified by:

getA2AEventListener in interface ISafeguardA2AContext

Parameters:

apiKeys - A list of API keys corresponding to the configured accounts to listen for.

handler - A delegate to call any time the AssetAccountPasswordUpdate event occurs.

Returns:

The event listener.

Throws:

ObjectDisposedException - The object has already been disposed.

ArgumentException - Invalid argument.

getPersistentA2AEventListener

public ISafeguardEventListener getPersistentA2AEventListener(char[] apiKey,
                                                             ISafeguardEventHandler handler)
                                                      throws ObjectDisposedException,
                                                             ArgumentException

Description copied from interface: ISafeguardA2AContext

Gets a persistent A2A event listener. The handler passed in will be registered for the AssetAccountPasswordUpdated event, which is the only one supported in A2A. You just have to call Start(). The event listener returned by this method will not automatically recover from a SignalR timeout which occurs when there is a 30+ second outage.

Specified by:

getPersistentA2AEventListener in interface ISafeguardA2AContext

Parameters:

apiKey - API key corresponding to the configured account to listen for.

handler - A delegate to call any time the AssetAccountPasswordUpdate event occurs.

Returns:

The event listener.

Throws:

ObjectDisposedException - The object has already been disposed.

ArgumentException - Invalid argument

getPersistentA2AEventListener

public ISafeguardEventListener getPersistentA2AEventListener(List<char[]> apiKeys,
                                                             ISafeguardEventHandler handler)
                                                      throws ObjectDisposedException,
                                                             ArgumentException

Description copied from interface: ISafeguardA2AContext

Gets a persistent A2A event listener. The handler passed in will be registered for the AssetAccountPasswordUpdated event, which is the only one supported in A2A. You just have to call Start(). The event listener returned by this method will not automatically recover from a SignalR timeout which occurs when there is a 30+ second outage.

Specified by:

getPersistentA2AEventListener in interface ISafeguardA2AContext

Parameters:

apiKeys - A list of API keys corresponding to the configured accounts to listen for.

handler - A delegate to call any time the AssetAccountPasswordUpdate event occurs.

Returns:

The event listener.

Throws:

ObjectDisposedException - The object has already been disposed.

ArgumentException - Invalid argument

brokerAccessRequest

public String brokerAccessRequest(char[] apiKey,
                                  BrokeredAccessRequest accessRequest)
                           throws ObjectDisposedException,
                                  SafeguardForJavaException,
                                  ArgumentException

Description copied from interface: ISafeguardA2AContext

Creates an access request on behalf of another user using Safeguard A2A.

Specified by:

brokerAccessRequest in interface ISafeguardA2AContext

Parameters:

apiKey - API key corresponding to the configured account.

accessRequest - The details of the access request to create.

Returns:

A JSON string representing the new access request.

Throws:

ObjectDisposedException - Object has already been disposed.

SafeguardForJavaException - General Safeguard for Java exception.

ArgumentException - Invalid argument

dispose

public void dispose()

Description copied from interface: ISafeguardA2AContext

Dispose of an object

Specified by:

dispose in interface ISafeguardA2AContext

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

cloneObject

public Object cloneObject()