sp_jreconfig

Description

Manages the Java PCA/JVM. Enables or disables arguments and directives, changes configuration values, and reports configuration values.

Syntax

sp_jreconfig {
	add array_arg, new_string |
	array_clear array_arg |
	array_enable array_arg |
	array_disable array_arg |
	delete array_arg, string_value |
	disable { directive | argument | array_arg, string_value } | 
	enable { directive | argument | array_arg, string_value } |
	list { list_type [, formatted ] | units | units, units_type[, formatted ] } |
	reload_config |
	report { directive[, formatted ] | directive, args[, formatted ]
		|argument[, formatted ] } |
	update { argument, old_value, new_value } }

Parameters

Examples

Example 1

Generates a formatted report for the PCA_JVM_OPT directive:

sp_jreconfig "report", "PCA_JVM_OPT", "formatted"

Example 2

Generates a report of the arguments of the PCA_JVM_OPT directive:

sp_jreconfig "report", "PCA_JVM_OPT", "args"

Example 3

Generates a report for the argument pca_jvm_netio.

sp_jreconfig "report", "pca_jvm_netio"

Example 4

Generates a report for all arguments that match "pca_jvm". A partial argument name generates a report for all matching arguments.

sp_jreconfig "report", "pca_jvm_"

Example 5

Generating lists – displays a list of all directives and their state: enabled or disabled.

sp_jreconfig "list", "directives"

Example 6

Generating lists – displays a list of all arguments, their units types, and directives.

sp_jreconfig "list", "argnames", "formatted"

Example 7

Generating lists – displays a list of all currently enabled arguments.

sp_jreconfig "list", "enabled"

Example 8

Generating lists – displays a formatted list of all array arguments.

sp_jreconfig "list", "units", "array", "formatted"

Example 9

Generating lists – display a list of argument unit types. The report for this command is formatted by default. Using the “-formatted” option generates an error.

sp_jreconfig "list", "units"

Example 10

Enabling directives and arguments – enables the PCA_JVM_WORK_DIR directive. You can use a partial directive name as long as it includes sufficient information to uniquely identify the directive.

sp_jreconfig "enable", "PCA_JVM_WORK_DIR"

sp_jreconfig "enable", "WORK_DIR"

Example 11

Enabling directives and arguments – enables the pca_jvm_netio argument.

sp_jreconfig "enable", "pca_jvm_netio"

Example 12

Disabling directives and arguments – disables the WORK_DIR directive. This example uses a partial directive name, which must include sufficient information to uniquely identify the directive.

sp_jreconfig "disable", "WORK_DIR"

Example 13

Disabling directives and arguments – disables the pca_jvm_netio argument.

sp_jreconfig "disable", "pca_jvm_netio"

Example 14

Disabling directives and arguments – disables array elements in PCA_JVM_WORK_DIR. The path, but not the permissions mask, is required. See Chapter 8, “File and Network Access Using Java,” in Java in Adaptive Server Enterprise.

sp_jreconfig "disable", "pca_jvm_work_dir",
    "/some/path"

Example 15

Updating string, number, and array arguments – pdates a string argument. This example updates the file location of the pca_jvm_log_filename argument.

sp_jreconfig "update", "pca_jvm_log_filename", "/old/path/filename.log",
	"/new/path/filename.log"

Example 16

Updating string, number, and array arguments – updates a number argument. Numeric values must be enclosed in quotes (as strings) for the stored procedure. Adaptive Server stores them as numeric values.

sp_jreconfig "update", "pca_jvm_min_port", "1026", "2056"

Example 17

Updating string, number, and array arguments – for the PCA_JVM_WORK_DIR directive, work_dir values consist of a path and an optional permission mask. Although the permission mask is optional, you must include the original string path to identify the work_dir. A permission mask is optional. If it is not supplied, the system uses a default mask with an octal equivalent of 0666. Example a does not set a permission mask; it uses the default mask. Examples b and c each set a permission mask of 0644.

[a] sp_jreconfig "update", "pca_jvm_work_dir",
"/old/path","/new/working/directory"

[b] sp_jreconfig "update", "pca_jvm_work_dir",
 "/old/path", "/new/working/directory(u=rw,go=r)"

[c] sp_jreconfig "update", "pca_jvm_work_dir",
 "/old/path", "/new/working/directory(u+w,ugo+r)"

Example 18

Adding array elements – adds new elements to the pca_jvm_work_dir argument array in the PCA_JVM_WORK_DIR directive. Example a uses the default mask. Examples b and c each set a permissions mask of 0644. (The mask is evaluated from left to right.)

[a] sp_jreconfig "add", "pca_jvm_work_dir",
 "/new/working/directory"

[b] sp_jreconfig "add", "pca_jvm_work_dir",
 "/new/working/directory(u=rw,go=r)"

[c] sp_jreconfig "add", "pca_jvm_work_dir",
 "/new/working/directory(u+w,ugo+r)"

Example 19

Deleting array elements – Deletes an array element in pca_jvm_work_dir.

sp_jreconfig "delete", "pca_jvm_work_dir", 
		"/new/working/directory"

Example 20

Enabling or disabling all elements in an array – enables all elements in the pca_jvm_work_dir array.

sp_jreconfig "array_enable", "pca_jvm_work_dir"

Example 21

Enabling or disabling all elements in an array – disables all elements in the pca_jvm_work_dir array.

sp_jreconfig "array_disable", "pca_jvm_work_dir"

Example 22

Clearing all records in an array – deletes all records in the pca_jvm_work_dir array and creates an empty array.

sp_jreconfig "array_clear", "pca_jvm_work_dir"

Example 23

Reloading default configuration values – Loads the configuration values stored in sybpcidb into memory.

sp_jreconfig "reload_config"

Usage

Enabling and disabling a directive works like a toggle:

• When a directive is enabled– Adaptive Server uses the configured value (enabled or disabled) of each argument. This is the value stored in sybpcidb.

• When a directive is disabled – Adaptive Server disregards the configured value (enabled or disabled) of each argument and treats all arguments of the directive as disabled, although the base value of each argument is retained in sybpcidb.

Arguments can be individually enabled or disabled. Arguments are of these types:

• switch – these arguments turn a feature on or off. For example, if the argument for logging is enabled, a log file is generated; if the argument for logging is disabled, no log file is generated.

• string – these arguments are for string and number values. Enabling a string or number argument ensures that Adaptive Server uses the configured value. Disabling a string or number argument means that Adaptive Server ignores the configured value and uses the default value. The configured and default values may or may not be the same.

• array – an array argument is a collection of related string arguments, each of which can be individually enabled or disabled. When an individual string argument (or element) is disabled, its value is ignored and the behavior is the same as if the element had been deleted. When enabled, the argument value is included in the collection and is active.

  Array arguments can be enabled or disabled at will; you do not have to delete a value and then re-enter it later on.

Permissions

Only a System Administrator can execute sp_jreconfig to change the settings of the PCA/JVM.

Auditing

Values in event and extrainfo columns from the sysaudits table are:

See also