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)
java.lang.String	getBaseUrl() Gets the base url this instance object is pointing to.
oracle.pgx.common.pojo.admin.GraphInfo	getGraphInfo(java.lang.String graphName) Blocking version of getGraphInfoAsync(String).
oracle.pgx.common.pojo.admin.GraphInfo	getGraphInfo(java.lang.String sessionId, java.lang.String graphName) Blocking version of getGraphInfoAsync(String, String).
PgxFuture<oracle.pgx.common.pojo.admin.GraphInfo>	getGraphInfoAsync(java.lang.String graphName) Get details of a (shared) persistent graph
PgxFuture<oracle.pgx.common.pojo.admin.GraphInfo>	getGraphInfoAsync(java.lang.String sessionId, java.lang.String graphName) Get details of a session-bound, private graph
java.util.Collection<oracle.pgx.common.pojo.admin.GraphInfo>	getGraphInfos() Blocking version of getGraphInfosAsync().
PgxFuture<java.util.Collection<oracle.pgx.common.pojo.admin.GraphInfo>>	getGraphInfosAsync() Get a list of currently active graphs.
oracle.pgx.common.pojo.admin.MemoryInfo	getMemoryInfo() Blocking version of getMemoryInfoAsync().
PgxFuture<oracle.pgx.common.pojo.admin.MemoryInfo>	getMemoryInfoAsync() Gets the memory info.
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.String	getPgxVersion() Blocking version of getPgxVersionAsync().
PgxFuture<java.lang.String>	getPgxVersionAsync() Gets the PGX version of this instance.
java.lang.Integer	getPrefetchSize() Gets the prefetchSize of this instance.
java.lang.Integer	getRemoteFuturePendingRetryInterval() Gets the remoteFuturePendingRetryInterval of this instance.
java.lang.Integer	getRemoteFutureTimeout() Gets the remoteFutureTimeout of this instance.
PgxSession	getSession(java.lang.String id) Blocking version of getSessionAsync(String).
PgxFuture<PgxSession>	getSessionAsync(java.lang.String id) Gets a session by ID.
oracle.pgx.common.pojo.admin.SessionInfo	getSessionInfo(java.lang.String sessionId) Blocking version of getSessionInfoAsync(String).
PgxFuture<oracle.pgx.common.pojo.admin.SessionInfo>	getSessionInfoAsync(java.lang.String sessionId) Gets the session info.
java.util.Collection<oracle.pgx.common.pojo.admin.SessionInfo>	getSessionInfos() Blocking version of getSessionInfosAsync().
PgxFuture<java.util.Collection<oracle.pgx.common.pojo.admin.SessionInfo>>	getSessionInfosAsync() Gets the session infos.
oracle.pgx.common.pojo.admin.PoolInfo	getThreadPoolInfo(PoolType type) Blocking version of getThreadPoolInfoAsync(PoolType).
PgxFuture<oracle.pgx.common.pojo.admin.PoolInfo>	getThreadPoolInfoAsync(PoolType type) Gets the thread pool info.
java.lang.Integer	getUploadBatchSize() Gets the uploadBatchSize of this instance.
java.lang.String	getUsername() Gets the user name this instance is using
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.
GraphConfig	lookupPreloadedGraph(java.lang.String name) Blocking version of lookupPreloadedGraphAsync(String).
PgxFuture<GraphConfig>	lookupPreloadedGraphAsync(java.lang.String name) Looks up the config of a pre-loaded graph by name.
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
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()

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

getBaseUrl

public java.lang.String getBaseUrl()

Gets the base url this instance object is pointing to.

Returns:

base url

getGraphInfo

public oracle.pgx.common.pojo.admin.GraphInfo getGraphInfo(java.lang.String graphName)
                                                    throws java.util.concurrent.ExecutionException,
                                                           java.lang.InterruptedException

Blocking version of getGraphInfoAsync(String). Calls getGraphInfoAsync(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.

getGraphInfo

public oracle.pgx.common.pojo.admin.GraphInfo getGraphInfo(java.lang.String sessionId,
                                                           java.lang.String graphName)
                                                    throws java.util.concurrent.ExecutionException,
                                                           java.lang.InterruptedException

Blocking version of getGraphInfoAsync(String, String). Calls getGraphInfoAsync(String, * 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.

getGraphInfoAsync

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

Get details of a (shared) persistent graph

Parameters:

graphName - internal name of persistent graph

Returns:

details of one specific graph

getGraphInfoAsync

public PgxFuture<oracle.pgx.common.pojo.admin.GraphInfo> getGraphInfoAsync(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

public java.util.Collection<oracle.pgx.common.pojo.admin.GraphInfo> getGraphInfos()
                                                                           throws java.util.concurrent.ExecutionException,
                                                                                  java.lang.InterruptedException

Blocking version of getGraphInfosAsync(). Calls getGraphInfosAsync() 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.

getGraphInfosAsync

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

Get a list of currently active graphs.

Returns:

a list of currently active graphs

getMemoryInfo

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

Blocking version of getMemoryInfoAsync(). Calls getMemoryInfoAsync() 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.

getMemoryInfoAsync

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

Gets the memory info.

Returns:

current memory usage statistics

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

getPgxVersion

public java.lang.String getPgxVersion()
                               throws java.util.concurrent.ExecutionException,
                                      java.lang.InterruptedException

Blocking version of getPgxVersionAsync(). Calls getPgxVersionAsync() 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.

getPgxVersionAsync

public PgxFuture<java.lang.String> getPgxVersionAsync()

Gets the PGX version of this instance.

Returns:

string identifying this PGX version

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.

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.

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.

getSessionInfo

public oracle.pgx.common.pojo.admin.SessionInfo getSessionInfo(java.lang.String sessionId)
                                                        throws java.util.concurrent.ExecutionException,
                                                               java.lang.InterruptedException

Blocking version of getSessionInfoAsync(String). Calls getSessionInfoAsync(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.

getSessionInfoAsync

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

Gets the session info.

Parameters:

sessionId - the session id

Returns:

details of one specific session

getSessionInfos

public java.util.Collection<oracle.pgx.common.pojo.admin.SessionInfo> getSessionInfos()
                                                                               throws java.util.concurrent.ExecutionException,
                                                                                      java.lang.InterruptedException

Blocking version of getSessionInfosAsync(). Calls getSessionInfosAsync() 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.

getSessionInfosAsync

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

Gets the session infos.

Returns:

a list of currently active sessions

getThreadPoolInfo

public oracle.pgx.common.pojo.admin.PoolInfo getThreadPoolInfo(PoolType type)
                                                        throws java.util.concurrent.ExecutionException,
                                                               java.lang.InterruptedException

Blocking version of getThreadPoolInfoAsync(PoolType). Calls getThreadPoolInfoAsync(PoolType) 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.

getThreadPoolInfoAsync

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

Gets the thread pool info.

Parameters:

type - which thread pool

Returns:

thread pool statistics

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

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

lookupPreloadedGraph

public GraphConfig lookupPreloadedGraph(java.lang.String name)
                                 throws java.util.concurrent.ExecutionException,
                                        java.lang.InterruptedException

Blocking version of lookupPreloadedGraphAsync(String). Calls (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.

lookupPreloadedGraphAsync

public PgxFuture<GraphConfig> lookupPreloadedGraphAsync(java.lang.String name)

Looks 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

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

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