Package oracle.pgx.config

Class ClientConfig

  • @Generated("config_generator.py")
public class ClientConfig
extends AbstractClientConfig
    PGX Engine Client Config

    • Method Detail

      • 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

      • isEmpty

        public boolean isEmpty()
        Checks if it's empty.
        Returns:
        true, if the Map 'values' is empty.

      • 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

      • getValuesWithoutDefaults

        public java.util.Map<ClientConfig.Field,​java.lang.Object> getValuesWithoutDefaults()
        Gets the values without defaults.
        Returns:
        the values without defaults

      • getLeftoverValues

        public java.util.Map<java.lang.String,​java.lang.Object> getLeftoverValues()
        Gets the values that do not belong to any field.
        Returns:
        the values that do not belong to any field

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • toString

        public java.lang.String toString​(boolean hideSensitiveData)

      • 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

      • getPrefetchSize

        public java.lang.Integer getPrefetchSize()
        How many items should be prefetched in remote iterators.

      • getUploadBatchSize

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

      • 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.

      • 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

      • isEnableCctrace

        public java.lang.Boolean isEnableCctrace()
        if true log every call to a Control or Core interface

      • getCctraceOut

        public java.lang.String getCctraceOut()
        [relevant for enable_cctrace] when cctrace is enabled, specifies a path to a file where cctrace should log to. If null it will use the default PGX logger on level TRACE. If it is the special value :stderr: it will log to stderr

      • isCctracePrintStacktraces

        public java.lang.Boolean isCctracePrintStacktraces()
        [relevant for enable_cctrace] when cctrace is enabled, print the stacktrace for each request and result

      • 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.

      • 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.

      • getAccessToken

        public java.lang.String getAccessToken()
        the authentication token (if server requires authentication)

      • getMaxClientHttpConnections

        public java.lang.Integer getMaxClientHttpConnections()
        Maximum number of connections to open to the PGX server

      • getClientServerInteractionMode

        public InteractionMode getClientServerInteractionMode()
        if async_polling the PGX client would poll the status of the future until it's completed. If blocking the PGX client would send a request to directly get the value of the future and the server would block until the future result is ready

      • getTlsVersion

        public java.lang.String getTlsVersion()
        TLS version to be used by the client. For example, TLSv1.2

      • getRealmClientConfig

        public java.util.Map getRealmClientConfig()
        implementation dependent configuration options for the realm client

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object