Control (Oracle Graph Java API Reference for Property Graph Release 21.2 (F41344-01))

```
public interface Control
```
Encapsulates all administrative functions of PGX

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ALL_PATHS_PROXY_MAP_KEY`
`static java.lang.String`	`COLLECTION_PROXY_MAP_KEY`
`static java.lang.String`	`COMPONENTS_PROXY_MAP_KEY`
`static java.lang.String`	`FUTURE_MAP_KEY`
`static java.lang.String`	`KEYSTORE_PATH_SYSTEM_PROPERTY`
`static java.lang.String`	`KEYSTORE_SECRET_SYSTEM_PROPERTY`
`static java.lang.String`	`MAP_PROXY_MAP_KEY`
`static java.lang.String`	`PGQL_RESULTS_KEY`
`static java.lang.String`	`PGX_CONFIG_FILE_SYSTEM_PROPERTY`
`static java.lang.String`	`PROPERTY_PROXY_MAP_KEY`
`static java.lang.String`	`SERVER_CONFIG_FILE_NAME`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addUserData(java.lang.String sessionId, java.lang.String key, java.lang.Object data)` add session-private user data to a session.
`PgxFuture<oracle.pgx.common.pojo.admin.CacheStatistics>`	`freeCachedMemory()` Trigger memory cleanup to free unused graphs if RELEASE_MEMORY_THRESHOLD is reached
`PgxFuture<oracle.pgx.common.pojo.admin.CacheStatistics>`	`freeCachedMemory(double threshold)` Trigger memory cleanup to free unused graphs if threshold is reached
`PgxFuture<oracle.pgx.common.VersionInfo>`	`getExtendedVersion()` Gets an extended version.
`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<com.fasterxml.jackson.databind.JsonNode>`	`getServerState()` Gets the server state.
`java.lang.Object`	`getUserData(SessionContext sessionContext, java.lang.String key)` get session-private user data by key.
`PgxFuture<java.lang.String>`	`getVersion()`
`PgxFuture<java.lang.Boolean>`	`isGraphPreloadingDone()` Check if the preloading of the graphs is finished
`PgxFuture<java.lang.Boolean>`	`isRunning()` Check if the engine is currently up
`PgxFuture<com.fasterxml.jackson.databind.JsonNode>`	`joinMachine(java.lang.String hostname, long raftId)` Join a machine to an existing PGX.D cluster.
`PgxFuture<java.lang.Void>`	`killSession(java.lang.String sessionId)` Kill session.
`PgxFuture<java.lang.Void>`	`setSessionMaxMemorySize(java.lang.String sessionId, int size, oracle.pgx.common.MemoryUnit unit)` Set the maximum memory limit for the given session.
`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)`
`PgxFuture<java.lang.Void>`	`start(java.lang.String json, java.lang.String keystorePath, char[] keystorePassword)`
`PgxFuture<java.lang.Void>`	`unpinGraph(java.lang.String graphName)` Unpins the specified published graph so that if no session uses any of its snapshot, it can be removed.
`PgxFuture<java.lang.Void>`	`updatePgxConfig(java.io.InputStream config)` Replaces the current PGX config with the given configuration.
`PgxFuture<java.lang.Void>`	`updatePgxConfig(java.util.Map<PgxConfig.Field,java.lang.Object> config)` Replaces the current PGX config with the given configuration.
`default PgxFuture<java.lang.Void>`	`updatePgxConfig(PgxConfig config)` Replaces the current PGX config with the given configuration.
`PgxFuture<java.lang.Void>`	`updatePgxConfig(java.lang.String json)` Replaces the current PGX config with the given configuration.

- Field Detail
  - ALL_PATHS_PROXY_MAP_KEY
```
static final java.lang.String ALL_PATHS_PROXY_MAP_KEY
```
    See Also:
    
    Constant Field Values
  - COLLECTION_PROXY_MAP_KEY
```
static final java.lang.String COLLECTION_PROXY_MAP_KEY
```
    See Also:
    
    Constant Field Values
  - COMPONENTS_PROXY_MAP_KEY
```
static final java.lang.String COMPONENTS_PROXY_MAP_KEY
```
    See Also:
    
    Constant Field Values
  - FUTURE_MAP_KEY
```
static final java.lang.String FUTURE_MAP_KEY
```
    See Also:
    
    Constant Field Values
  - KEYSTORE_PATH_SYSTEM_PROPERTY
```
static final java.lang.String KEYSTORE_PATH_SYSTEM_PROPERTY
```
    See Also:
    
    Constant Field Values
  - KEYSTORE_SECRET_SYSTEM_PROPERTY
```
static final java.lang.String KEYSTORE_SECRET_SYSTEM_PROPERTY
```
    See Also:
    
    Constant Field Values
  - MAP_PROXY_MAP_KEY
```
static final java.lang.String MAP_PROXY_MAP_KEY
```
    See Also:
    
    Constant Field Values
  - PGQL_RESULTS_KEY
```
static final java.lang.String PGQL_RESULTS_KEY
```
    See Also:
    
    Constant Field Values
  - PGX_CONFIG_FILE_SYSTEM_PROPERTY
```
static final java.lang.String PGX_CONFIG_FILE_SYSTEM_PROPERTY
```
    See Also:
    
    Constant Field Values
  - PROPERTY_PROXY_MAP_KEY
```
static final java.lang.String PROPERTY_PROXY_MAP_KEY
```
    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
  - addUserData
```
void addUserData(java.lang.String sessionId,
                 java.lang.String key,
                 java.lang.Object data)
```
    add session-private user data to a session. The data gets freed once the session dies. The data can later be retrieved by the given key using getUserData(SessionContext, String). If data with the same key already exists, it will be overwritten.
    This method is thread safe.
    
    Parameters:
    
    sessionId - the ID of the target session
    
    key -
    
    data -
    
    Throws:
    
    java.util.concurrent.RejectedExecutionException - if no such session exists
    
    java.lang.IllegalStateException - if engine is not running
  - freeCachedMemory
```
PgxFuture<oracle.pgx.common.pojo.admin.CacheStatistics> freeCachedMemory()
```
    Trigger memory cleanup to free unused graphs if RELEASE_MEMORY_THRESHOLD is reached
  - freeCachedMemory
```
PgxFuture<oracle.pgx.common.pojo.admin.CacheStatistics> freeCachedMemory(double threshold)
```
    Trigger memory cleanup to free unused graphs if threshold is reached
  - getExtendedVersion
```
PgxFuture<oracle.pgx.common.VersionInfo> getExtendedVersion()
```
    Gets an extended version.
    
    Returns:
    
    VersionInfo object
  - 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
  - getServerState
```
PgxFuture<com.fasterxml.jackson.databind.JsonNode> getServerState()
```
    Gets the server state.
    
    Returns:
    
    server inspection information
    
    Since:
    
    2.7.0
  - getUserData
```
java.lang.Object getUserData(SessionContext sessionContext,
                             java.lang.String key)
```
    get session-private user data by key.
    
    Parameters:
    
    sessionContext - context of the session the data was previously added to
    
    key -
    
    Returns:
    
    the user data associated with given key, null if no such data was set.
    
    Throws:
    
    java.util.concurrent.RejectedExecutionException - if no such session exists
    
    java.lang.IllegalStateException - if engine is not running
  - getVersion
```
PgxFuture<java.lang.String> getVersion()
```
  - isGraphPreloadingDone
```
PgxFuture<java.lang.Boolean> isGraphPreloadingDone()
```
    Check if the preloading of the graphs is finished
    
    Returns:
    
    true if the graph preloading is done, false otherwise
  - isRunning
```
PgxFuture<java.lang.Boolean> isRunning()
```
    Check if the engine is currently up
    
    Returns:
    
    true if engine is currently running, false otherwise
  - joinMachine
```
PgxFuture<com.fasterxml.jackson.databind.JsonNode> joinMachine(java.lang.String hostname,
                                                               long raftId)
```
    Join a machine to an existing PGX.D cluster. When this request is received on the server, we need to call into the engine to fetch relevant cluster information that allows the new machine to join the cluster and also prepare existing machines for hand-shaking with the new machine.
    
    Returns:
  - killSession
```
PgxFuture<java.lang.Void> killSession(java.lang.String sessionId)
```
    Kill session.
    
    Parameters:
    
    sessionId - the session to be killed
  - setSessionMaxMemorySize
```
PgxFuture<java.lang.Void> setSessionMaxMemorySize(java.lang.String sessionId,
                                                  int size,
                                                  oracle.pgx.common.MemoryUnit unit)
```
    Set the maximum memory limit for the given session.
    
    Parameters:
    
    sessionId - on which session to apply the memory limit
    
    size - memory limit to be set relative to the provided MemoryUnit
    
    unit - the MemoryUnit to use for the given size Only supports MemoryUnit.MEGABYTE, MemoryUnit.GIGABYTE, and MemoryUnit.TERABYTE Requires SERVER_MANAGE permission
    
    Since:
    
    20.2.1
  - 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)
```
  - start
```
PgxFuture<java.lang.Void> start(java.lang.String json,
                                java.lang.String keystorePath,
                                char[] keystorePassword)
```
  - unpinGraph
```
PgxFuture<java.lang.Void> unpinGraph(java.lang.String graphName)
```
    Unpins the specified published graph so that if no session uses any of its snapshot, it can be removed.
    
    Parameters:
    
    graphName - name of the published graph to unpin
  - updatePgxConfig
```
PgxFuture<java.lang.Void> updatePgxConfig(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 new PGX config
    
    Returns:
    
    Since:
    
    20.1.0
  - updatePgxConfig
```
PgxFuture<java.lang.Void> updatePgxConfig(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 - the new PGX config
    
    Returns:
    
    Since:
    
    20.1.0
  - updatePgxConfig
```
default PgxFuture<java.lang.Void> updatePgxConfig(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 - the new PGX config
    
    Returns:
    
    Since:
    
    20.1.0
  - updatePgxConfig
```
PgxFuture<java.lang.Void> updatePgxConfig(java.lang.String json)
```
    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:
    
    json - JSON string representing the new PGX config
    
    Returns:
    
    Since:
    
    20.1.0

Interface Control

Field Summary

Method Summary

Field Detail

ALL_PATHS_PROXY_MAP_KEY

COLLECTION_PROXY_MAP_KEY

COMPONENTS_PROXY_MAP_KEY

FUTURE_MAP_KEY

KEYSTORE_PATH_SYSTEM_PROPERTY

KEYSTORE_SECRET_SYSTEM_PROPERTY

MAP_PROXY_MAP_KEY

PGQL_RESULTS_KEY

PGX_CONFIG_FILE_SYSTEM_PROPERTY

PROPERTY_PROXY_MAP_KEY

SERVER_CONFIG_FILE_NAME

Method Detail

addUserData

freeCachedMemory

freeCachedMemory

getExtendedVersion

getPgxConfig

getPgxConfigObject

getServerState

getUserData

getVersion

isGraphPreloadingDone

isRunning

joinMachine

killSession

setSessionMaxMemorySize

shutdown

shutdownNow

shutdownNowIfRunning

start

start

start

start

start

start

unpinGraph

updatePgxConfig

updatePgxConfig

updatePgxConfig

updatePgxConfig