Package oracle.pgx.config

Class AbstractPgxConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.AbstractEngineConfig

oracle.pgx.config.AbstractPgxConfig

Direct Known Subclasses:

PgxConfig

public abstract class AbstractPgxConfig
extends AbstractEngineConfig

In-memory representation of a PGX config.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_FILE_NAME
static java.lang.String	FILE_PATH_PROPERTY

Fields inherited from class oracle.pgx.config.AbstractConfig

ENV_SEPARATOR, ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX

Constructor Summary

Constructors

Constructor	Description
AbstractPgxConfig()

Method Summary

Modifier and Type	Method	Description
static PgxConfig	configFromJson(java.lang.String json)
static PgxConfig	configFromMap(java.util.Map<PgxConfig.Field,java.lang.Object> configValues)
abstract java.util.List<AuthorizationEntityConfig>	getAuthorization()
abstract java.util.List<AuthorizationLocationConfig>	getFileLocations()
static java.lang.String	getFilePath()
static PgxConfig	getInstance()
static PgxConfig	getInstance(java.io.InputStream is, java.lang.String parent)	creates a server config from an input stream specified by parameter.
static PgxConfig	getInstance(java.lang.String path)	creates a server config from a file path specified by parameter.
abstract java.util.List<PreloadGraphConfig>	getPreloadGraphs()
java.util.Map<java.lang.String,AbstractAuthorizationEntityConfig.Permissions>	getRolePermissionMapping()
RuntimeConfig	getRuntimeConfig()
abstract java.lang.String	getUdfConfigDirectory()
java.util.Map<java.lang.String,AbstractAuthorizationEntityConfig.Permissions>	getUserPermissionMapping()
abstract java.util.Map<PgxConfig.Field,java.lang.Object>	getValues()
boolean	isClusterLeader()
boolean	isDistConfig()
boolean	isSmConfig()
void	validate()

Methods inherited from class oracle.pgx.config.AbstractEngineConfig

getAdminRequestCacheTimeout, getAllowedRemoteLoadingLocations, getDataMemoryLimits, getIntervalToPollMax, getMaxHttpClientRequestSize, getRoleMaxMemoryLimits, getTmpDir, getUserMaxMemoryLimits, isEnableCsrfTokenChecks

Methods inherited from class oracle.pgx.config.AbstractConfig

getDefault, getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

Methods inherited from class java.lang.Object

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

Field Detail

FILE_PATH_PROPERTY

public static final java.lang.String FILE_PATH_PROPERTY

See Also:

Constant Field Values

DEFAULT_FILE_NAME

public static final java.lang.String DEFAULT_FILE_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractPgxConfig

public AbstractPgxConfig()

Method Detail

getFilePath

public static java.lang.String getFilePath()
                                    throws java.io.IOException

Returns:

a file path of the pgxConfig

Throws:

java.io.IOException

Since:

24.1.0

getInstance

public static PgxConfig getInstance()

Returns:

a pgxConfig initialized with the default values

Since:

2.4.0

getInstance

public static PgxConfig getInstance(java.lang.String path)

creates a server config from a file path specified by parameter. If any configuration entry is missing, the default as specified in PgxConfig.Field will be used

Parameters:

path -

Throws:

java.io.IOException

Since:

24.1.0

getInstance

public static PgxConfig getInstance(java.io.InputStream is,
                                    java.lang.String parent)
                             throws java.io.IOException

creates a server config from an input stream specified by parameter. If any configuration entry is missing, the default as specified in PgxConfig.Field will be used

Parameters:

is -

Throws:

java.io.IOException

Since:

2.4.0

configFromJson

public static PgxConfig configFromJson(java.lang.String json)
                                throws java.io.IOException

Throws:

java.io.IOException

configFromMap

public static PgxConfig configFromMap(java.util.Map<PgxConfig.Field,java.lang.Object> configValues)
                               throws java.io.IOException

Throws:

java.io.IOException

getRuntimeConfig

public RuntimeConfig getRuntimeConfig()

Returns:

the runtime config part of the Pgx config

Since:

2.4.0

getValues

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

Specified by:

getValues in class AbstractConfig

getUdfConfigDirectory

public abstract java.lang.String getUdfConfigDirectory()

getPreloadGraphs

public abstract java.util.List<PreloadGraphConfig> getPreloadGraphs()

getFileLocations

public abstract java.util.List<AuthorizationLocationConfig> getFileLocations()

getAuthorization

public abstract java.util.List<AuthorizationEntityConfig> getAuthorization()

Specified by:

getAuthorization in class AbstractEngineConfig

getUserPermissionMapping

public java.util.Map<java.lang.String,AbstractAuthorizationEntityConfig.Permissions> getUserPermissionMapping()

getRolePermissionMapping

public java.util.Map<java.lang.String,AbstractAuthorizationEntityConfig.Permissions> getRolePermissionMapping()

validate

public void validate()

Overrides:

validate in class AbstractEngineConfig

isDistConfig

public boolean isDistConfig()

isSmConfig

public boolean isSmConfig()

isClusterLeader

public boolean isClusterLeader()