oracle.pgx.api

Class ServerInstance

java.lang.Object

oracle.pgx.api.internal.ApiObject

oracle.pgx.api.ServerInstance

public class ServerInstance
extends oracle.pgx.api.internal.ApiObject

A PGX server instance.

Method Summary

Modifier and Type	Method and Description
void	addPinnedGraph(GraphConfig cfg) Blocking version of addPinnedGraphAsync(GraphConfig).
PgxFuture<java.lang.Void>	addPinnedGraphAsync(GraphConfig cfg) Add a pinned graph (will not be unloaded by engine) to be shared between sessions
PgxSession	createSession(java.lang.String source) Blocking version of createSessionAsync(String).
PgxSession	createSession(java.lang.String source, java.lang.Long idleTimeout, java.lang.Long taskTimeout, java.util.concurrent.TimeUnit unit) Blocking version of createSessionAsync(String).
PgxFuture<PgxSession>	createSessionAsync(java.lang.String source) Create a new session.
PgxFuture<PgxSession>	createSessionAsync(java.lang.String source, java.lang.Long idleTimeout, java.lang.Long taskTimeout, java.util.concurrent.TimeUnit unit) Creates a new session.
void	demotePinnedGraph(GraphConfig cfg) Blocking version of demotePinnedGraphAsync(GraphConfig).
PgxFuture<java.lang.Void>	demotePinnedGraphAsync(GraphConfig cfg) Demote pinned graph.
boolean	equals(java.lang.Object obj)
oracle.pgx.common.pojo.admin.CacheStatistics	freeCachedMemory() Blocking version of freeCachedMemoryAsync().
oracle.pgx.common.pojo.admin.CacheStatistics	freeCachedMemory(double threshold) Blocking version of freeCachedMemoryAsync(double).
PgxFuture<oracle.pgx.common.pojo.admin.CacheStatistics>	freeCachedMemoryAsync() Trigger memory cleanup to free unused graphs if RELEASE_MEMORY_THRESHOLD is reached
PgxFuture<oracle.pgx.common.pojo.admin.CacheStatistics>	freeCachedMemoryAsync(double threshold) Trigger memory cleanup to free unused graphs if threshold is reached.
java.lang.String	getBaseUrl() Gets the base url this instance object is pointing to.
InteractionMode	getClientServerInteractionMode() Gets the client/server interaction mode (InteractionMode.BLOCKING, InteractionMode.ASYNC_POLLING)
PgxFuture<Control>	getControl()
PgxFuture<oracle.pgx.api.internal.Core>	getCore()
java.util.Map<PgxConfig.Field,java.lang.Object>	getPgxConfig() Blocking version of getPgxConfigAsync().
PgxFuture<java.util.Map<PgxConfig.Field,java.lang.Object>>	getPgxConfigAsync() Gets the PGX config.
PgxConfig	getPgxConfigObject() Blocking version of getPgxConfigObjectAsync().
PgxFuture<PgxConfig>	getPgxConfigObjectAsync() Gets the PGX config.
java.lang.Integer	getPrefetchSize() Gets the prefetchSize of this instance.
oracle.pgx.api.internal.ProxyServer	getProxyServer()
java.lang.Integer	getRemoteFuturePendingRetryInterval() Gets the remoteFuturePendingRetryInterval of this instance.
java.lang.Integer	getRemoteFutureTimeout() Gets the remoteFutureTimeout of this instance.
com.fasterxml.jackson.databind.JsonNode	getServerState() Blocking version of getServerStateAsync().
PgxFuture<com.fasterxml.jackson.databind.JsonNode>	getServerStateAsync() Gets the server state info.
PgxSession	getSession(java.lang.String id) Blocking version of getSessionAsync(String).
PgxFuture<PgxSession>	getSessionAsync(java.lang.String id) Gets a session by ID.
java.lang.Integer	getUploadBatchSize() Gets the uploadBatchSize of this instance.
java.lang.String	getUsername() Gets the user name this instance is using
oracle.pgx.common.VersionInfo	getVersion() Blocking version of getVersionAsync().
PgxFuture<oracle.pgx.common.VersionInfo>	getVersionAsync() Gets the PGX extended version of this instance.
int	hashCode()
boolean	isEmbeddedInstance() Checks if is embedded instance.
boolean	isEngineRunning() Blocking version of isEngineRunningAsync().
PgxFuture<java.lang.Boolean>	isEngineRunningAsync() Check if the engine is currently up
void	killSession(java.lang.String sessionId) Blocking version of killSessionAsync(String).
PgxFuture<java.lang.Void>	killSessionAsync(java.lang.String sessionId) Kill a session.
void	resizePool(PoolType poolType, int parallelism) Blocking version of resizePoolAsync(PoolType, int).
PgxFuture<java.lang.Void>	resizePoolAsync(PoolType poolType, int parallelism) Resize a pool to use a different degree of parallelism
void	setToken(java.lang.String token)
boolean	shutdownEngine(long timeout, java.util.concurrent.TimeUnit unit) Blocking version of shutdownEngineAsync(long, TimeUnit).
PgxFuture<java.lang.Boolean>	shutdownEngineAsync(long timeout, java.util.concurrent.TimeUnit unit) Gracefully shuts down the engine and cleans up resources.
void	shutdownEngineNow() Blocking version of shutdownEngineNowAsync().
PgxFuture<java.lang.Void>	shutdownEngineNowAsync() Forces the engine to stop and clean up resources.
void	shutdownEngineNowIfRunning() Blocking version of shutdownEngineNowIfRunningAsync().
PgxFuture<java.lang.Void>	shutdownEngineNowIfRunningAsync() If the engine is currently up forces it to stop and clean up resources.
void	startEngine() Blocking version of startEngineAsync().
void	startEngine(java.io.InputStream config) Blocking version of startEngineAsync(InputStream).
void	startEngine(java.util.Map<PgxConfig.Field,java.lang.Object> config) Blocking version of startEngineAsync(Map).
void	startEngine(PgxConfig config) Blocking version of startEngineAsync(PgxConfig).
void	startEngine(java.lang.String path) Blocking version of startEngineAsync(String).
PgxFuture<java.lang.Void>	startEngineAsync() Starts the PGX engine.
PgxFuture<java.lang.Void>	startEngineAsync(java.io.InputStream config) Starts the PGX engine with a custom configuration.
PgxFuture<java.lang.Void>	startEngineAsync(java.util.Map<PgxConfig.Field,java.lang.Object> config) Starts the PGX engine with a custom configuration.
PgxFuture<java.lang.Void>	startEngineAsync(PgxConfig config) Starts the PGX engine with a custom configuration.
PgxFuture<java.lang.Void>	startEngineAsync(java.lang.String path) Starts the PGX engine with a custom configuration given as path.
java.lang.String	toString()
void	updatePgxConfig(java.io.InputStream config) Blocking version of updatePgxConfigAsync(InputStream).
void	updatePgxConfig(java.util.Map<PgxConfig.Field,java.lang.Object> config) Blocking version of updatePgxConfigAsync(Map).
void	updatePgxConfig(PgxConfig config) Blocking version of updatePgxConfigAsync(PgxConfig).
void	updatePgxConfig(java.lang.String path) Blocking version of updatePgxConfigAsync(String).
PgxFuture<java.lang.Void>	updatePgxConfigAsync(java.io.InputStream config) Replaces the current PGX config with the given configuration.
PgxFuture<java.lang.Void>	updatePgxConfigAsync(java.util.Map<PgxConfig.Field,java.lang.Object> config) Replaces the current PGX config with the given configuration.
PgxFuture<java.lang.Void>	updatePgxConfigAsync(PgxConfig config) Replaces the current PGX config with the given configuration.
PgxFuture<java.lang.Void>	updatePgxConfigAsync(java.lang.String path) Replaces the current PGX config with the given configuration.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

addPinnedGraph

public void addPinnedGraph(GraphConfig cfg)
                    throws java.util.concurrent.ExecutionException,
                           java.lang.InterruptedException

Blocking version of addPinnedGraphAsync(GraphConfig). Calls addPinnedGraphAsync(GraphConfig) and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

addPinnedGraphAsync

public PgxFuture<java.lang.Void> addPinnedGraphAsync(GraphConfig cfg)

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

Parameters:

cfg -

createSession

public PgxSession createSession(java.lang.String source)
                         throws java.util.concurrent.ExecutionException,
                                java.lang.InterruptedException

Blocking version of createSessionAsync(String). Calls createSessionAsync(String) and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

createSession

public PgxSession createSession(java.lang.String source,
                                java.lang.Long idleTimeout,
                                java.lang.Long taskTimeout,
                                java.util.concurrent.TimeUnit unit)
                         throws java.util.concurrent.ExecutionException,
                                java.lang.InterruptedException

Blocking version of createSessionAsync(String). Calls createSessionAsync(String) and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

createSessionAsync

public PgxFuture<PgxSession> createSessionAsync(java.lang.String source)

Create a new session.

Parameters:

source - a descriptive string identifying the client

Returns:

created session

createSessionAsync

public PgxFuture<PgxSession> createSessionAsync(java.lang.String source,
                                                java.lang.Long idleTimeout,
                                                java.lang.Long taskTimeout,
                                                java.util.concurrent.TimeUnit unit)

Creates a new session.

Parameters:

source - a descriptive string identifying the client

idleTimeout - if not null, tries to overwrite server default idle timeout

taskTimeout - if not null, tries to overwrite server default task timeout

unit - time unit of idleTimeout and taskTimeout

Returns:

created session

demotePinnedGraph

public void demotePinnedGraph(GraphConfig cfg)
                       throws java.util.concurrent.ExecutionException,
                              java.lang.InterruptedException

Blocking version of demotePinnedGraphAsync(GraphConfig). Calls demotePinnedGraphAsync(GraphConfig) and waits for returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

demotePinnedGraphAsync

public PgxFuture<java.lang.Void> demotePinnedGraphAsync(GraphConfig cfg)

Demote pinned graph.

Parameters:

cfg - the cfg

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

freeCachedMemory

public oracle.pgx.common.pojo.admin.CacheStatistics freeCachedMemory()
                                                              throws java.util.concurrent.ExecutionException,
                                                                     java.lang.InterruptedException

Blocking version of freeCachedMemoryAsync(). Calls freeCachedMemoryAsync() and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

freeCachedMemory

public oracle.pgx.common.pojo.admin.CacheStatistics freeCachedMemory(double threshold)
                                                              throws java.util.concurrent.ExecutionException,
                                                                     java.lang.InterruptedException

Blocking version of freeCachedMemoryAsync(double). Calls freeCachedMemoryAsync(double) and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

freeCachedMemoryAsync

public PgxFuture<oracle.pgx.common.pojo.admin.CacheStatistics> freeCachedMemoryAsync()

Trigger memory cleanup to free unused graphs if RELEASE_MEMORY_THRESHOLD is reached

Returns:

amount of released memory

See Also:

for more details.

freeCachedMemoryAsync

public PgxFuture<oracle.pgx.common.pojo.admin.CacheStatistics> freeCachedMemoryAsync(double threshold)

Trigger memory cleanup to free unused graphs if threshold is reached.

Parameters:

threshold - percentage of used memory after which the engine starts freeing un-used graphs

Returns:

amount of released memory

See Also:

for more details.

getBaseUrl

public java.lang.String getBaseUrl()

Gets the base url this instance object is pointing to.

Returns:

base url

getClientServerInteractionMode

public InteractionMode getClientServerInteractionMode()

Gets the client/server interaction mode (InteractionMode.BLOCKING, InteractionMode.ASYNC_POLLING)

Returns:

interaction mode.

getControl

public PgxFuture<Control> getControl()

getCore

public PgxFuture<oracle.pgx.api.internal.Core> getCore()

getPgxConfig

public java.util.Map<PgxConfig.Field,java.lang.Object> getPgxConfig()
                                                             throws java.util.concurrent.ExecutionException,
                                                                    java.lang.InterruptedException

Blocking version of getPgxConfigAsync(). Calls getPgxConfigAsync() and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

getPgxConfigAsync

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

Gets the PGX config.

Returns:

current PGX server configuration as JSON string

getPgxConfigObject

public PgxConfig getPgxConfigObject()
                             throws java.util.concurrent.ExecutionException,
                                    java.lang.InterruptedException

Blocking version of getPgxConfigObjectAsync(). Calls getPgxConfigObjectAsync() and waits for returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

getPgxConfigObjectAsync

public PgxFuture<PgxConfig> getPgxConfigObjectAsync()

Gets the PGX config.

Returns:

current PGX server configuration as PgxConfig instance

getPrefetchSize

public java.lang.Integer getPrefetchSize()

Gets the prefetchSize of this instance. Note that prefetchSize is ignored if this instance is an embedded instance (isEmbeddedInstance()).

Returns:

the prefetchSize.

getProxyServer

public oracle.pgx.api.internal.ProxyServer getProxyServer()

getRemoteFuturePendingRetryInterval

public java.lang.Integer getRemoteFuturePendingRetryInterval()

Gets the remoteFuturePendingRetryInterval of this instance. Note that remoteFuturePendingRetryInterval is ignored if this instance is an embedded instance (isEmbeddedInstance()).

Returns:

the remoteFuturePendingRetryInterval.

getRemoteFutureTimeout

public java.lang.Integer getRemoteFutureTimeout()

Gets the remoteFutureTimeout of this instance. Note that remoteFutureTimeout is ignored if this instance is an embedded instance (isEmbeddedInstance()).

Returns:

the remoteFutureTimeout.

getServerState

public com.fasterxml.jackson.databind.JsonNode getServerState()
                                                       throws java.util.concurrent.ExecutionException,
                                                              java.lang.InterruptedException

Blocking version of getServerStateAsync(). Calls getServerStateAsync() and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

Since:

2.7.0

getServerStateAsync

public PgxFuture<com.fasterxml.jackson.databind.JsonNode> getServerStateAsync()

Gets the server state info.

Returns:

sessions, graphs, tasks, threadPools and memory statistics

Since:

2.7.0

getSession

public PgxSession getSession(java.lang.String id)
                      throws java.util.concurrent.ExecutionException,
                             java.lang.InterruptedException

Blocking version of getSessionAsync(String). Calls getSessionAsync(String) and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

getSessionAsync

public PgxFuture<PgxSession> getSessionAsync(java.lang.String id)

Gets a session by ID.

Parameters:

id - the session ID

Returns:

a future completing with the requested PGX session or completing exceptionally if the requested session ID could not be found.

getUploadBatchSize

public java.lang.Integer getUploadBatchSize()

Gets the uploadBatchSize of this instance. Note that uploadBatchSize is ignored if this instance is an embedded instance (isEmbeddedInstance()).

Returns:

the uploadBatchSize.

getUsername

public java.lang.String getUsername()

Gets the user name this instance is using

Returns:

username

getVersion

public oracle.pgx.common.VersionInfo getVersion()
                                         throws java.util.concurrent.ExecutionException,
                                                java.lang.InterruptedException

Blocking version of getVersionAsync(). Calls getVersionAsync() and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

getVersionAsync

public PgxFuture<oracle.pgx.common.VersionInfo> getVersionAsync()

Gets the PGX extended version of this instance.

Returns:

VersionInfo holding information about this PGX version

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isEmbeddedInstance

public boolean isEmbeddedInstance()

Checks if is embedded instance.

Returns:

true, if is embedded instance

isEngineRunning

public boolean isEngineRunning()
                        throws java.util.concurrent.ExecutionException,
                               java.lang.InterruptedException

Blocking version of isEngineRunningAsync(). Calls isEngineRunningAsync() and waits for returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

isEngineRunningAsync

public PgxFuture<java.lang.Boolean> isEngineRunningAsync()

Check if the engine is currently up

Returns:

true if engine is currently running, false otherwise

killSession

public void killSession(java.lang.String sessionId)
                 throws java.util.concurrent.ExecutionException,
                        java.lang.InterruptedException

Blocking version of killSessionAsync(String). Calls killSessionAsync(String) and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

killSessionAsync

public PgxFuture<java.lang.Void> killSessionAsync(java.lang.String sessionId)

Kill a session.

Parameters:

sessionId - the session to be killed

resizePool

public void resizePool(PoolType poolType,
                       int parallelism)
                throws java.util.concurrent.ExecutionException,
                       java.lang.InterruptedException

Blocking version of resizePoolAsync(PoolType, int). Calls resizePoolAsync(PoolType, int) and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

resizePoolAsync

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

Resize a pool to use a different degree of parallelism

Parameters:

poolType - which pool to resize

parallelism - the target parallelism

setToken

public void setToken(java.lang.String token)

shutdownEngine

public boolean shutdownEngine(long timeout,
                              java.util.concurrent.TimeUnit unit)
                       throws java.util.concurrent.ExecutionException,
                              java.lang.InterruptedException

Blocking version of shutdownEngineAsync(long, TimeUnit). Calls shutdownEngineAsync(long, TimeUnit) and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

shutdownEngineAsync

public PgxFuture<java.lang.Boolean> shutdownEngineAsync(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.

shutdownEngineNow

public void shutdownEngineNow()
                       throws java.util.concurrent.ExecutionException,
                              java.lang.InterruptedException

Blocking version of shutdownEngineNowAsync(). Calls shutdownEngineNowAsync() and waits for returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

shutdownEngineNowAsync

public PgxFuture<java.lang.Void> shutdownEngineNowAsync()

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.

shutdownEngineNowIfRunning

public void shutdownEngineNowIfRunning()
                                throws java.util.concurrent.ExecutionException,
                                       java.lang.InterruptedException

Blocking version of shutdownEngineNowIfRunningAsync(). Calls shutdownEngineNowIfRunningAsync() and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

shutdownEngineNowIfRunningAsync

public PgxFuture<java.lang.Void> shutdownEngineNowIfRunningAsync()

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

startEngine

public void startEngine()
                 throws java.util.concurrent.ExecutionException,
                        java.lang.InterruptedException

Blocking version of startEngineAsync(). Calls startEngineAsync() and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

startEngine

public void startEngine(java.io.InputStream config)
                 throws java.util.concurrent.ExecutionException,
                        java.lang.InterruptedException

Blocking version of startEngineAsync(InputStream). Calls startEngineAsync(InputStream) and waits for returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

startEngine

public void startEngine(java.util.Map<PgxConfig.Field,java.lang.Object> config)
                 throws java.util.concurrent.ExecutionException,
                        java.lang.InterruptedException

Blocking version of startEngineAsync(Map). Calls startEngineAsync(Map) and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

startEngine

public void startEngine(PgxConfig config)
                 throws java.util.concurrent.ExecutionException,
                        java.lang.InterruptedException

Blocking version of startEngineAsync(PgxConfig). Calls startEngineAsync(PgxConfig) and waits for returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

startEngine

public void startEngine(java.lang.String path)
                 throws java.util.concurrent.ExecutionException,
                        java.lang.InterruptedException

Blocking version of startEngineAsync(String). Calls startEngineAsync(String) and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

startEngineAsync

public PgxFuture<java.lang.Void> startEngineAsync()

Starts the PGX engine.

startEngineAsync

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

Starts the PGX engine with a custom configuration.

Parameters:

config - the config

startEngineAsync

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

Starts the PGX engine with a custom configuration.

Parameters:

config - the config

startEngineAsync

public PgxFuture<java.lang.Void> startEngineAsync(PgxConfig config)

Starts the PGX engine with a custom configuration.

Parameters:

config - the config

startEngineAsync

public PgxFuture<java.lang.Void> startEngineAsync(java.lang.String path)

Starts the PGX engine with a custom configuration given as path.

Parameters:

path - the path may be prefixed with resource handlers.

See Also:

Path syntax documentation

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

updatePgxConfig

public void updatePgxConfig(java.io.InputStream config)
                     throws java.util.concurrent.ExecutionException,
                            java.lang.InterruptedException

Blocking version of updatePgxConfigAsync(InputStream). Calls updatePgxConfigAsync(InputStream) and waits for returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

updatePgxConfig

public void updatePgxConfig(java.util.Map<PgxConfig.Field,java.lang.Object> config)
                     throws java.util.concurrent.ExecutionException,
                            java.lang.InterruptedException

Blocking version of updatePgxConfigAsync(Map). Calls updatePgxConfigAsync(Map) and waits for returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

updatePgxConfig

public void updatePgxConfig(PgxConfig config)
                     throws java.util.concurrent.ExecutionException,
                            java.lang.InterruptedException

Blocking version of updatePgxConfigAsync(PgxConfig). Calls updatePgxConfigAsync(PgxConfig) and waits for returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

updatePgxConfig

public void updatePgxConfig(java.lang.String path)
                     throws java.util.concurrent.ExecutionException,
                            java.lang.InterruptedException

Blocking version of updatePgxConfigAsync(String). Calls updatePgxConfigAsync(String) and waits for returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

updatePgxConfigAsync

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

Replaces the current PGX config with the given configuration. This only affects static permissions (i.e. non-graph) and redaction rules for pre-loaded graphs. Existing permissions on graphs and frames will not be changed.

Parameters:

config - stream that can be read to a PGX config containing the new authorization config

updatePgxConfigAsync

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

Replaces the current PGX config with the given configuration. This only affects static permissions (i.e. non-graph) and redaction rules for pre-loaded graphs. Existing permissions on graphs and frames will not be changed.

Parameters:

config - PGX config containing the new authorization config

updatePgxConfigAsync

public PgxFuture<java.lang.Void> updatePgxConfigAsync(PgxConfig config)

Replaces the current PGX config with the given configuration. This only affects static permissions (i.e. non-graph) and redaction rules for pre-loaded graphs. Existing permissions on graphs and frames will not be changed.

Parameters:

config - PGX config containing the new authorization config

updatePgxConfigAsync

public PgxFuture<java.lang.Void> updatePgxConfigAsync(java.lang.String path)

Replaces the current PGX config with the given configuration. This only affects static permissions (i.e. non-graph) and redaction rules for pre-loaded graphs. Existing permissions on graphs and frames will not be changed.

Parameters:

path - path pointing to a PGX config file