oracle.pgx.config

Class ClientConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.AbstractClientConfig

oracle.pgx.config.ClientConfig

@Generated(value="config_generator.py")
public class ClientConfig
extends AbstractClientConfig

PGX Engine Client Config

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientConfig.Field Fields of PGX Engine Client Config

Field Summary

Fields inherited from class oracle.pgx.config.AbstractConfig

ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBaseUrl() The base url in the format host [ : port][ /path] of the PGX server REST end-point.
java.lang.String	getKeystore() path to the keystore to use for client connections.
java.lang.String	getPassword() The HTTP Basic Auth password
java.lang.Integer	getPrefetchSize() How many items should be prefetched in remote iterators.
java.lang.Integer	getRemoteFuturePendingRetryInterval() How many milliseconds to wait before sending another request in case a GET request for a PgxRemoteFuture receives a 202 - Accepted response
java.lang.Integer	getRemoteFutureTimeout() How long one GET request for a PgxRemoteFuture will be alive, until it times out and tries again.
java.lang.String	getTruststore() path to the truststore to use for client connections.
java.lang.Integer	getUploadBatchSize() How many items will be uploaded in a batch.
java.lang.String	getUsername() The HTTP Basic Auth username
java.util.Map<ClientConfig.Field,java.lang.Object>	getValues() Gets the parsed values.
java.util.Map<ClientConfig.Field,java.lang.Object>	getValuesWithoutDefaults() Gets the values without defaults.
boolean	hasDefaultValue(ClientConfig.Field field) Checks for default value.
boolean	isEmpty() Checks if it's empty.
java.lang.Boolean	isEnableCctrace() if true log every call to a Control or Core interface
static ClientConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath) Parses an input stream.
static ClientConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath) Parses a raw key/value mapping.
static ClientConfig	parse(java.util.Properties props, boolean strict) Parses a properties file.
java.lang.String	toString()

Methods inherited from class oracle.pgx.config.AbstractClientConfig

getCleanedBaseUrl, getInstance

Methods inherited from class oracle.pgx.config.AbstractConfig

getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

Methods inherited from class java.lang.Object

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

Method Detail

getBaseUrl

public java.lang.String getBaseUrl()

The base url in the format host [ : port][ /path] of the PGX server REST end-point. If the base_url is null, the default will be used which points to embedded PGX instance.

Specified by:

getBaseUrl in class AbstractClientConfig

getKeystore

public java.lang.String getKeystore()

path to the keystore to use for client connections. The keystore is used to authenticate this client at the PGX server if two-way SSL/TLS is enabled.

getPassword

public java.lang.String getPassword()

The HTTP Basic Auth password

getPrefetchSize

public java.lang.Integer getPrefetchSize()

How many items should be prefetched in remote iterators.

getRemoteFuturePendingRetryInterval

public java.lang.Integer getRemoteFuturePendingRetryInterval()

How many milliseconds to wait before sending another request in case a GET request for a PgxRemoteFuture receives a 202 - Accepted response

getRemoteFutureTimeout

public java.lang.Integer getRemoteFutureTimeout()

How long one GET request for a PgxRemoteFuture will be alive, until it times out and tries again. Time in milliseconds, set it to zero for an infinite timeout. See HTTP Client SO_TIMEOUT for more details.

getTruststore

public java.lang.String getTruststore()

path to the truststore to use for client connections. The truststore is used to validate the server certificate if communicating over SSL/TLS.

getUploadBatchSize

public java.lang.Integer getUploadBatchSize()

How many items will be uploaded in a batch. This is used in Core#addAllToCollection() and Core#setProperty()

getUsername

public java.lang.String getUsername()

The HTTP Basic Auth username

getValues

public java.util.Map<ClientConfig.Field,java.lang.Object> getValues()

Gets the parsed values.

Returns:

the parsed values

getValuesWithoutDefaults

public java.util.Map<ClientConfig.Field,java.lang.Object> getValuesWithoutDefaults()

Gets the values without defaults.

Returns:

the values without defaults

hasDefaultValue

public boolean hasDefaultValue(ClientConfig.Field field)

Checks for default value.

Parameters:

field - the field

Returns:

true, if value for given field is the default value

isEmpty

public boolean isEmpty()

Checks if it's empty.

Returns:

true, if the Map 'values' is empty.

isEnableCctrace

public java.lang.Boolean isEnableCctrace()

if true log every call to a Control or Core interface

parse

public static ClientConfig parse(java.io.InputStream is,
                                 boolean strict,
                                 java.lang.String parentPath)
                          throws java.io.IOException

Parses an input stream.

Parameters:

is - the input stream

strict - if true, parses in strict mode

parentPath - if not null, resolves relative paths against this parentPath

Returns:

the parsed graph config

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

parse

public static ClientConfig parse(java.util.Map<java.lang.String,java.lang.Object> raw,
                                 boolean strict,
                                 java.lang.String parentPath)

Parses a raw key/value mapping.

Parameters:

raw - the raw key/value mapping to parse

strict - if true, parses in strict mode

parentPath - if not null, resolves relative paths against this parentPath

Returns:

the parsed graph config

parse

public static ClientConfig parse(java.util.Properties props,
                                 boolean strict)

Parses a properties file.

Parameters:

props - the properties to parse

strict - if true, parses in strict mode

Returns:

the parsed graph config

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object