sp_jreconfig

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

• add – adds a new argument to an argument array. Use add only with arguments where units_type is array.
• array_arg – is the name of an argument where units_type is array.
• new_string – is the string value for a new array element.
• array_clear – deletes all element in an argument array.
• array_enable – enables all elements in an argument array. Sets each array element to enabled.
• array_disable – disables, but does not delete, all elements in an argument array. Sets each element to disabled.
• delete – removes an existing element from an argument array. Use delete only with arguments where units_type is array.
• disable – disables the specified directive or argument.
• string_value – identifies an array element in the named argument array that is to be deleted, enabled, or disabled.
• directive – is the name of a valid directive.
• argument – is the name of a valid argument.
• enable – enables a directive or an argument.
• list – lists groups of related arguments as, for example, sp_jreconfig list, directives or sp_jreconfig list, enabled. Also, lists all arguments of a specific type as, for example, sp_jreconfig list, units, string. To see all current units_types values, use sp_jreconfig list, units.
• formatted – formats the displayed list for readability; longer values may be truncated.
  Note: In formatted reports, the process of improving readability may truncate wide columns. In addition, column headings may be overridden and may not match the actual table name. Do not format reports if the output is to be parsed or potential data truncation is not acceptable.
• list_type – specifies a type of list. Values are:

  • directives – list of directives

  • enabled – list of enabled arguments

  • disabled – list of disabled arguments

  • argnames – list of argument names, each argument’s units_type, and the directive to which each belongs

• units – when used with list, generates a list of units_type currently in use.
• units_type – is a type of argument. Every argument has a units_type that identifies its type. Values are:

  • switch

  • string

  • number

  • array

• reload_config – reloads the configuration from the sybpcidb tables into memory. See Restoring Default Configuration Values to sybpcidb in Java in Adaptive Server Enterprise.
• report – creates a report based on arguments supplied. Usually used to generate a report for an argument to see its current value and whether or not it is enabled. Can also be used to generate a report for a directive or its arguments.
• directive – is any valid directive.
• args – is a keyword used with report to generate a list of argument names for the named directive. For example:

  sp_jreconfig report, "PCA_JVM", "args"

• update – modifies a string or numeric value for an argument where units_type is string, number, or array. You cannot modify an argument when units_type is switch.
• old_value – is a string or numeric value that identifies the existing argument or array element being updated.
• new_value – is a string or numeric value that defines the new argument or array element.

Examples

• Generating Formatted Report – Generates a formatted report for the PCA_JVM_OPT directive:

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

• Generating Report of Arguments – Generates a report of the arguments of the PCA_JVM_OPT directive:

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

• Generating Report of Argument – Generates a report for the argument pca_jvm_netio.

  sp_jreconfig "report", "pca_jvm_netio"

• Generating Report of All Arguments – 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_"

• Generating Lists – Displays a list of all directives and their state: enabled or disabled.

  sp_jreconfig "list", "directives"

• Generating Lists – Displays a list of all arguments, their units types, and directives.

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

• Generating Lists – Displays a list of all currently enabled arguments.

  sp_jreconfig "list", "enabled"

• Generating Lists – Displays a formatted list of all array arguments.

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

• 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"

• 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"

• Enabling Directives and Arguments – Enables the pca_jvm_netio argument.

  sp_jreconfig "enable", "pca_jvm_netio"

• 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"

  Note: Disabling a directives causes its arguments to behave as disabled, but does not change their base states.
• Disabling Directives and Arguments – Disables the pca_jvm_netio argument.

  sp_jreconfig "disable", "pca_jvm_netio"

• Disabling Directives and Arguments – Disables array elements in PCA_JVM_WORK_DIR. The path, but not the permissions mask, is required. See File and Network Access Using Java in Java in Adaptive Server Enterprise.

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

• Updating String, Number, and Aray Arguments – Updates 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"

  Note: The update option cannot be used with directives or switch argument as these items can not be modified.
• Updating String, Number, and Array Arguments – Updates a number argument. Numeric values must be enclosed in quotes (as strings) for the stored procedure. The SAP ASE server stores them as numeric values.

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

• 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)"

• 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)"

• Deleting Array Elements – Deletes an array element in pca_jvm_work_dir.

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

  Note: To delete a an element in pca_jvm_work_dir in the PCA_JVM_WORK_DIR directive, you can specify a partial string if the string supplied identifies a unique record. The permission mask is not required; you only need to supply the path even if the work_dir element was originally defined with a specific permission mask.
• Enabling or Disabling All Elements in an Array – Disables all elements in the pca_jvm_work_dir array.

  sp_jreconfig "array_enable", "pca_jvm_work_dir"

• 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"

• 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"

• 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 – the SAP ASE server uses the configured value (enabled or disabled) of each argument. This is the value stored in sybpcidb.

  • Disabled – the SAP ASE 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. The types of arguments are:

  • 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 the SAP ASE server uses the configured value. Disabling a string or number argument means that the SAP ASE 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.

pca_jvm_module_path configures the path to the JVM shared-object library. If you use a JRE other than that supplied by SAP, you must configure this argument to point to a location accessible to the PCA/JVM. This can be an absolute path or a relative path that extends $SYBASE. If an absolute path, start the path with “/” on UNIX or “\” on Windows. Otherwise, the SAP ASE server assumes a relative path and looks under $SYBASE.

This table describes pva_jvm_opt.

Do not change default values unless instructed to do so by SAP Technical Support.

pca_jvm_dir_options configures the directory definitions used by the JVM for the ROOT and TEMP directories. Do not change these values unless you are a knowledgeable user or you have been directed to do so by SAP Technical Support.

pca_jvm_work_dir configures the JVM trusted directories. This argument consists of a collection of specific locations in your file system where your Java program classes can perform certain file I/O operations. Each directory can have an optional permission mask that defines which file I/O operations are allowed in each directory.

pca_jvm_min_jni_version configures minimum backward compatible JNI version.

pva_jvm_logging configures JRE/VM logging options.

pca_jvm_ext_class_loader configures global and database extension class loaders.

pva_jvm_java_options configures Java start-up options, both normal and extended.

pva_jvm_java_dbg_agent_port configures the Java VM debug agent port number (used for debugging Java applications with a Java debugger). See Java in Adaptive Server Enterprise for more information.

pca_jvm_sys_device_path configures platform-specific system device directories (required for Solaris).

Permissions

The permission checks for sp_jreconfig differ based on your granular permissions settings.

Auditing

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