oracle.pg.rdbms

Class AdbGraphClientConfiguration

java.lang.Object

oracle.pg.rdbms.AdbGraphClientConfiguration

public class AdbGraphClientConfiguration
extends java.lang.Object

ADB Graph Client configuration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.concurrent.TimeUnit	DEFAULT_REFRESH_TIME_BEFORE_TOKEN_EXPIRY_TIME_UNIT Default value for refreshTimeBeforeTokenExpiryTimeUnit

Method Summary

Modifier and Type	Method and Description
static AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder	builder()
java.net.URI	createBrokerBaseURI()
java.net.URI	createGraphStudioBaseURI()
java.net.URI	createPgxBaseURI()
java.lang.String	getBrokerBaseUrl() Set the broker base URL to use.
java.lang.String	getDatabase() The Autonomous Database name.
java.lang.String	getDataStudioApiVersion() The API version of the Data Studio REST endpoints to use.
java.lang.String	getEndpoint() ADB Graph endpoint URL.
java.util.concurrent.ExecutorService	getExecutorService() The ExecutorService this client should use for background polling threads.
java.lang.String	getGraphStudioApiVersion() The API version of the Graph Studio REST endpoints to use.
java.lang.String	getGraphStudioBaseUrl() Set the Graph Studio base URL to use.
org.apache.http.client.HttpClient	getHttpClient() The Apache HttpClient object to use for HTTP requests.
long	getJobPollInterval() The time interval to use when polling the server for job updates.
java.util.concurrent.TimeUnit	getJobPollIntervalTimeUnit() The time unit for the jobPollInterval time value.
java.lang.String	getPassword() The Database password to use for login.
java.lang.String	getPgxBaseUrl() Set the PGX base URL to use.
int	getRefreshTimeBeforeTokenExpiry() The time to refresh the authentication token automatically before it expires.
java.util.concurrent.TimeUnit	getRefreshTimeBeforeTokenExpiryTimeUnit() The time unit of the refreshTimeBeforeTokenExpiry time value.
java.lang.String	getTenant() OCI tenant name (*not* the tenant OCID).
java.lang.String	getUsername() The Database username to use for login.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REFRESH_TIME_BEFORE_TOKEN_EXPIRY_TIME_UNIT

public static final java.util.concurrent.TimeUnit DEFAULT_REFRESH_TIME_BEFORE_TOKEN_EXPIRY_TIME_UNIT

Default value for refreshTimeBeforeTokenExpiryTimeUnit

Method Detail

builder

public static AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder builder()

createBrokerBaseURI

public java.net.URI createBrokerBaseURI()

createGraphStudioBaseURI

public java.net.URI createGraphStudioBaseURI()

createPgxBaseURI

public java.net.URI createPgxBaseURI()

getBrokerBaseUrl

public java.lang.String getBrokerBaseUrl()

Set the broker base URL to use. If not set, broker URL will be derived from getEndpoint(). URL is expected to end with '/broker/pdbcs'

getDatabase

public java.lang.String getDatabase()

The Autonomous Database name. Note: this is *not* the display name, but the actual database name. Can be obtained from the details page of the Autonomous Database in the OCI console. Mandatory configuration.

Returns:

the tenant name.

getDataStudioApiVersion

public java.lang.String getDataStudioApiVersion()

The API version of the Data Studio REST endpoints to use. Optional configuration. If not set, then {@link #DEFAULT_DATA_STUDIO_API_VERSION) will be used.

Returns:

the data studio API version.

getEndpoint

public java.lang.String getEndpoint()

ADB Graph endpoint URL. Can be obtained from the details page of the Autonomous Database in the OCI console. Mandatory configuration.

Returns:

the endpoint.

getExecutorService

public java.util.concurrent.ExecutorService getExecutorService()

The ExecutorService this client should use for background polling threads. Optional configuration. If not set, then Executors.newFixedThreadPool(int) will be used with the number of threads equaling Runtime.availableProcessors().

Returns:

the ExecutorService of this configuration.

getGraphStudioApiVersion

public java.lang.String getGraphStudioApiVersion()

The API version of the Graph Studio REST endpoints to use. Optional configuration. If not set, then {@link #DEFAULT_GRAPH_STUDIO_API_VERSION) will be used.

Returns:

the graph studio API version.

getGraphStudioBaseUrl

public java.lang.String getGraphStudioBaseUrl()

Set the Graph Studio base URL to use. If not set, Graph Studio URL will be derived from getEndpoint(). URL is expected to end with '/graphstudio'

getHttpClient

public org.apache.http.client.HttpClient getHttpClient()

The Apache HttpClient object to use for HTTP requests. Optional configuration. If not set, then HttpClients.createDefault() will be used.

Returns:

the HTTP client

getJobPollInterval

public long getJobPollInterval()

The time interval to use when polling the server for job updates. The unit of this time value can be specified via the jobPollIntervalTimeUnit configuration. Optional configuration. If not set, then {@link #DEFAULT_JOB_POLL_INTERVAL) will be used.

Returns:

the job poll interval time.

getJobPollIntervalTimeUnit

public java.util.concurrent.TimeUnit getJobPollIntervalTimeUnit()

The time unit for the jobPollInterval time value. Optional configuration. If not set, then {@link #DEFAULT_JOB_POLL_INTERVAL_TIME_UNIT) will be used.

Returns:

the job poll interval time unit.

getPassword

public java.lang.String getPassword()

The Database password to use for login. Mandatory configuration.

Returns:

the database password.

getPgxBaseUrl

public java.lang.String getPgxBaseUrl()

Set the PGX base URL to use. If not set, PGX URL will be derived from getEndpoint(). URL is expected to end with '/graph/pgx'

getRefreshTimeBeforeTokenExpiry

public int getRefreshTimeBeforeTokenExpiry()

The time to refresh the authentication token automatically before it expires. The unit of this time value can be specified via the refreshTimeBeforeTokenExpiryTimeUnit configuration. Optional configuration. If not set, then GraphServer.DEFAULT_TIME_BEFORE_EXPIRY will be used.

Returns:

the refresh time before expiry value.

getRefreshTimeBeforeTokenExpiryTimeUnit

public java.util.concurrent.TimeUnit getRefreshTimeBeforeTokenExpiryTimeUnit()

The time unit of the refreshTimeBeforeTokenExpiry time value. Optional configuration. If not set, then DEFAULT_REFRESH_TIME_BEFORE_TOKEN_EXPIRY_TIME_UNIT will be used.

Returns:

the refresh time before expiry time unit.

getTenant

public java.lang.String getTenant()

OCI tenant name (*not* the tenant OCID). Mandatory configuration.

Returns:

the tenant name.

getUsername

public java.lang.String getUsername()

The Database username to use for login. Mandatory configuration.

Returns:

the database username.