com.oneidentity.safeguard.safeguardjava

Interface ISafeguardConnection

public interface ISafeguardConnection

This is the reusable connection interface that can be used to call Safeguard API after connecting using the API access token obtained during authentication.

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes of the connection.
int	getAccessTokenLifetimeRemaining() Number of minutes remaining in the lifetime of the Safeguard API access token.
SafeguardEventListener	getEventListener() Gets a Safeguard event listener.
ISafeguardEventListener	getPersistentEventListener() Gets a persistent Safeguard event listener.
String	invokeMethod(Service service, Method method, String relativeUrl, String body, Map<String,String> parameters, Map<String,String> additionalHeaders) Call a Safeguard API method and get any response as a string.
String	invokeMethodCsv(Service service, Method method, String relativeUrl, String body, Map<String,String> parameters, Map<String,String> additionalHeaders)
FullResponse	invokeMethodFull(Service service, Method method, String relativeUrl, String body, Map<String,String> parameters, Map<String,String> additionalHeaders) Call a Safeguard API method and get a detailed response with status code, headers, and body.
void	logOut() Call Safeguard API to invalidate current access token and clear its value from the connection.
void	refreshAccessToken() Request a new Safeguard API access token with the underlying credentials used to initial create the connection.

Method Detail

getAccessTokenLifetimeRemaining

int getAccessTokenLifetimeRemaining()
                             throws ObjectDisposedException,
                                    SafeguardForJavaException

Number of minutes remaining in the lifetime of the Safeguard API access token.

Returns:

Remaining token life time

Throws:

ObjectDisposedException - Object has already been disposed.

SafeguardForJavaException - General Safeguard for Java exception.

refreshAccessToken

void refreshAccessToken()
                 throws ObjectDisposedException,
                        SafeguardForJavaException

Request a new Safeguard API access token with the underlying credentials used to initial create the connection.

Throws:

ObjectDisposedException - Object has already been disposed.

SafeguardForJavaException - General Safeguard for Java exception.

invokeMethod

String invokeMethod(Service service,
                    Method method,
                    String relativeUrl,
                    String body,
                    Map<String,String> parameters,
                    Map<String,String> additionalHeaders)
             throws ObjectDisposedException,
                    SafeguardForJavaException,
                    ArgumentException

Call a Safeguard API method and get any response as a string. Some Safeguard API methods will return an empty body. If there is a failure a SafeguardDotNetException will be thrown.

Parameters:

service - Safeguard service to call.

method - Safeguard method type to use.

relativeUrl - Relative URL of the service to use.

body - Request body to pass to the method.

parameters - Additional parameters to add to the URL.

additionalHeaders - Additional headers to add to the request.

Returns:

Response body as a string.

Throws:

ObjectDisposedException - Object has already been disposed.

SafeguardForJavaException - General Safeguard for Java exception.

ArgumentException - Invalid argument.

invokeMethodFull

FullResponse invokeMethodFull(Service service,
                              Method method,
                              String relativeUrl,
                              String body,
                              Map<String,String> parameters,
                              Map<String,String> additionalHeaders)
                       throws ObjectDisposedException,
                              SafeguardForJavaException,
                              ArgumentException

Call a Safeguard API method and get a detailed response with status code, headers, and body. If there is a failure a SafeguardDotNetException will be thrown.

Parameters:

service - Safeguard service to call.

method - Safeguard method type to use.

relativeUrl - Relative URL of the service to use.

body - Request body to pass to the method.

parameters - Additional parameters to add to the URL.

additionalHeaders - Additional headers to add to the request.

Returns:

Response with status code, headers, and body as string.

Throws:

ObjectDisposedException - Object has already been disposed.

SafeguardForJavaException - General Safeguard for Java exception.

ArgumentException - Invalid argument.

invokeMethodCsv

String invokeMethodCsv(Service service,
                       Method method,
                       String relativeUrl,
                       String body,
                       Map<String,String> parameters,
                       Map<String,String> additionalHeaders)
                throws ObjectDisposedException,
                       SafeguardForJavaException,
                       ArgumentException

Throws:

ObjectDisposedException

SafeguardForJavaException

ArgumentException

getEventListener

SafeguardEventListener getEventListener()
                                 throws ObjectDisposedException,
                                        ArgumentException

Gets a Safeguard event listener. You will need to call the RegisterEventHandler() method to establish callbacks. Then, you just have to call Start(). Call Stop() when you are finished. 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.

Returns:

The event listener.

Throws:

ObjectDisposedException - Object has already been disposed.

ArgumentException - Invalid argument.

getPersistentEventListener

ISafeguardEventListener getPersistentEventListener()
                                            throws ObjectDisposedException,
                                                   SafeguardForJavaException

Gets a persistent Safeguard event listener. You will need to call the RegisterEventHandler() method to establish callbacks. Then, you just have to call Start(). Call Stop() when you are finished. The event listener returned by this method WILL automatically recover from a SignalR timeout which occurs when there is a 30+ second outage.

Returns:

The persistent event listener.

Throws:

ObjectDisposedException - Object has already been disposed.

SafeguardForJavaException - General Safeguard for Java exception.

logOut

void logOut()
     throws ObjectDisposedException

Call Safeguard API to invalidate current access token and clear its value from the connection. In order to continue using the connection you will need to call RefreshAccessToken().

Throws:

ObjectDisposedException - Object has already been disposed.

dispose

void dispose()

Disposes of the connection.