oracle.pgx.api.admin

Interface Control

public interface Control

Encapsulates all administrative functions of PGX

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PGX_CONFIG_FILE_SYSTEM_PROPERTY
static java.lang.String	SERVER_CONFIG_FILE_NAME

Method Summary

Modifier and Type	Method and Description
PgxFuture<java.lang.Void>	addPinnedGraph(GraphConfig cfg) Add a pinned graph (will not be unloaded by engine) to be shared between sessions
PgxFuture<java.lang.Void>	demotePinnedGraph(GraphConfig cfg) Demote pinned graph.
PgxFuture<oracle.pgx.common.pojo.admin.GraphInfo>	getGraphInfo(java.lang.String graphName) Get details of a (shared) persistent graph
PgxFuture<oracle.pgx.common.pojo.admin.GraphInfo>	getGraphInfo(java.lang.String sessionId, java.lang.String graphName) Get details of a session-bound, private graph
PgxFuture<java.util.Collection<oracle.pgx.common.pojo.admin.GraphInfo>>	getGraphInfos() Get a list of currently active graphs.
PgxFuture<oracle.pgx.common.pojo.admin.MemoryInfo>	getMemoryInfo() Gets the memory info.
PgxFuture<java.util.Map<PgxConfig.Field,java.lang.Object>>	getPgxConfig() Gets the pgx config.
default PgxFuture<PgxConfig>	getPgxConfigObject() Gets the pgx config as PgxConfig object
PgxFuture<oracle.pgx.common.pojo.admin.SessionInfo>	getSessionInfo(java.lang.String sessionId) Gets the session info.
PgxFuture<java.util.Collection<oracle.pgx.common.pojo.admin.SessionInfo>>	getSessionInfos() Gets the session infos.
PgxFuture<oracle.pgx.common.pojo.admin.PoolInfo>	getThreadPoolInfo(PoolType type) Gets the thread pool info.
PgxFuture<java.lang.String>	getVersion()
PgxFuture<java.lang.Boolean>	isRunning() Check if the engine is currently up
PgxFuture<java.lang.Void>	killSession(java.lang.String sessionId) Kill session.
PgxFuture<GraphConfig>	lookupPreloadedGraph(java.lang.String name) look up the config of a pre-loaded graph by name.
PgxFuture<java.lang.Void>	resizePool(PoolType poolType, int parallelism) resize a pool to use a different degree of parallelism
PgxFuture<java.lang.Boolean>	shutdown(long timeout, java.util.concurrent.TimeUnit unit) gracefully shuts down the engine and cleans up resources.
PgxFuture<java.lang.Void>	shutdownNow() forces the engine to stop and clean up resources.
PgxFuture<java.lang.Void>	shutdownNowIfRunning()
PgxFuture<java.lang.Void>	start()
PgxFuture<java.lang.Void>	start(java.io.InputStream config)
PgxFuture<java.lang.Void>	start(java.util.Map<PgxConfig.Field,java.lang.Object> config)
default PgxFuture<java.lang.Void>	start(PgxConfig config)
PgxFuture<java.lang.Void>	start(java.lang.String json)

Field Detail

PGX_CONFIG_FILE_SYSTEM_PROPERTY

static final java.lang.String PGX_CONFIG_FILE_SYSTEM_PROPERTY

See Also:

Constant Field Values

SERVER_CONFIG_FILE_NAME

static final java.lang.String SERVER_CONFIG_FILE_NAME

See Also:

Constant Field Values

Method Detail

addPinnedGraph

PgxFuture<java.lang.Void> addPinnedGraph(GraphConfig cfg)

Add a pinned graph (will not be unloaded by engine) to be shared between sessions

Parameters:

cfg -

demotePinnedGraph

PgxFuture<java.lang.Void> demotePinnedGraph(GraphConfig cfg)

Demote pinned graph.

Parameters:

cfg - the cfg

getGraphInfo

PgxFuture<oracle.pgx.common.pojo.admin.GraphInfo> getGraphInfo(java.lang.String graphName)

Get details of a (shared) persistent graph

Parameters:

graphName - internal name of persistent graph

Returns:

details of one specific graph

getGraphInfo

PgxFuture<oracle.pgx.common.pojo.admin.GraphInfo> getGraphInfo(java.lang.String sessionId,
                                                               java.lang.String graphName)

Get details of a session-bound, private graph

Parameters:

sessionId - session id of session holding the graph

graphName - name of graph

Returns:

details of one specific graph

getGraphInfos

PgxFuture<java.util.Collection<oracle.pgx.common.pojo.admin.GraphInfo>> getGraphInfos()

Get a list of currently active graphs. The resulting list will contain both session-private (transient) graphs as well as in-memory copies of graphs loaded from a datasource (persistent).

Returns:

a list of currently active graphs

getMemoryInfo

PgxFuture<oracle.pgx.common.pojo.admin.MemoryInfo> getMemoryInfo()

Gets the memory info.

Returns:

current memory usage statistics

getPgxConfig

PgxFuture<java.util.Map<PgxConfig.Field,java.lang.Object>> getPgxConfig()

Gets the pgx config.

Returns:

current PGX server configuration as JSON string

getPgxConfigObject

default PgxFuture<PgxConfig> getPgxConfigObject()

Gets the pgx config as PgxConfig object

Returns:

current PGX server configuration

getSessionInfo

PgxFuture<oracle.pgx.common.pojo.admin.SessionInfo> getSessionInfo(java.lang.String sessionId)

Gets the session info.

Parameters:

sessionId - the session id

Returns:

details of one specific session

getSessionInfos

PgxFuture<java.util.Collection<oracle.pgx.common.pojo.admin.SessionInfo>> getSessionInfos()

Gets the session infos.

Returns:

a list of currently active sessions

getThreadPoolInfo

PgxFuture<oracle.pgx.common.pojo.admin.PoolInfo> getThreadPoolInfo(PoolType type)

Gets the thread pool info.

Parameters:

type - which thread pool

Returns:

thread pool statistics

getVersion

PgxFuture<java.lang.String> getVersion()

isRunning

PgxFuture<java.lang.Boolean> isRunning()

Check if the engine is currently up

Returns:

true if engine is currently running, false otherwise

killSession

PgxFuture<java.lang.Void> killSession(java.lang.String sessionId)

Kill session.

Parameters:

sessionId - the session to be killed

lookupPreloadedGraph

PgxFuture<GraphConfig> lookupPreloadedGraph(java.lang.String name)

look up the config of a pre-loaded graph by name.

Parameters:

name - the name of the graph

Returns:

the graph config of the pre-loaded graph, null if no such graph was pre-loaded.

resizePool

PgxFuture<java.lang.Void> resizePool(PoolType poolType,
                                     int parallelism)

resize a pool to use a different degree of parallelism

Parameters:

poolType - which pool to resize

parallelism - the target parallelism

shutdown

PgxFuture<java.lang.Boolean> shutdown(long timeout,
                                      java.util.concurrent.TimeUnit unit)

gracefully shuts down the engine and cleans up resources. All currently enqueued tasks will be worked off prior shut down, new incoming requests get rejected. This call blocks until shut down is complete or timed out.

Returns:

true if gracefully shut down. false if timed out before shut down.

shutdownNow

PgxFuture<java.lang.Void> shutdownNow()

forces the engine to stop and clean up resources. Currently running tasks are interrupted. New incoming requests get rejected.

Throws an exception when current tasks didn't finish after a short grace period.

shutdownNowIfRunning

PgxFuture<java.lang.Void> shutdownNowIfRunning()

start

PgxFuture<java.lang.Void> start()

start

PgxFuture<java.lang.Void> start(java.io.InputStream config)

start

PgxFuture<java.lang.Void> start(java.util.Map<PgxConfig.Field,java.lang.Object> config)

start

default PgxFuture<java.lang.Void> start(PgxConfig config)

start

PgxFuture<java.lang.Void> start(java.lang.String json)