com.oneidentity.safeguard.safeguardjava

Interface ISafeguardA2AContext

All Known Implementing Classes:

SafeguardA2AContext

public interface ISafeguardA2AContext

This is a reusable interface for calling Safeguard A2A without having to continually pass the client certificate authentication information.

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.
void	dispose() Dispose of an object
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.

Method Detail

getRetrievableAccounts

List<A2ARetrievableAccount> getRetrievableAccounts()
                                            throws ObjectDisposedException,
                                                   SafeguardForJavaException

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.

Returns:

A list of retrievable accounts.

Throws:

ObjectDisposedException - Object has already been disposed.

SafeguardForJavaException - General Safeguard for Java exception.

retrievePassword

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

Retrieves a password using Safeguard A2A.

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

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

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.

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

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

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.

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

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

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.

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

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

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.

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

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

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

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

void dispose()

Dispose of an object