com.arsdigita.acs.acsAdmin
Class ApmUtilities

java.lang.Object
  |
  +--com.arsdigita.acs.acsAdmin.ApmUtilities

public class ApmUtilities

extends java.lang.Object

Misc. APM utilities ported from apm-procs.tcl on an as-needed basis. TODO: Cleanup, refactor, coordinate with rhs and bquinn.

Since:

ACS 4.0

Field Summary

protected static java.util.Map	apmLibraryTimeMap
static java.lang.String	cvsId

Constructor Summary

ApmUtilities()

Method Summary

static void	apmLog(java.lang.String message)
static void	apmLog(java.lang.String message, java.lang.String severity)
static java.math.BigDecimal	dependencyAdd(java.math.BigDecimal dependency_id, java.math.BigDecimal version_id, java.lang.String dependency_uri, java.lang.String dependency_version) Add a dependency to a version.
static void	dependencyRemove(java.math.BigDecimal dependency_id) Removes a dependency from the system.
static java.lang.String	getVersionLoadStatus(java.math.BigDecimal versionId) If a version needs to be reloaded (i.e., a -procs.tcl has changed or been added since the version was loaded), returns "needs_reload".
static java.math.BigDecimal	interfaceAdd(java.math.BigDecimal interface_id, java.math.BigDecimal version_id, java.lang.String interface_uri, java.lang.String interface_version) Add a interface to a version.
static void	interfaceRemove(java.math.BigDecimal interface_id) Removes a interface from the system.
static boolean	isPackageRegistered(java.lang.String package_key) Returns true if there is a registered package with the indicated package_key.
static boolean	isPackageVersionEnabled(java.math.BigDecimal versionId) Indicates if the particular version specified is enabled.
static java.math.BigDecimal	parameterRegister(java.math.BigDecimal parameter_id, java.lang.String package_key, java.lang.String parameter_name, java.lang.String description, java.lang.String default_value, java.lang.String datatype, java.lang.String section_name, java.math.BigDecimal min_n_values, java.math.BigDecimal max_n_values) Register a parameter in the system.
static java.math.BigDecimal	parameterRegister(java.lang.String package_key, java.lang.String parameter_name, java.lang.String description, java.lang.String default_value, java.lang.String datatype, java.lang.String section_name, java.math.BigDecimal min_n_values, java.math.BigDecimal max_n_values)
static void	parameterUnregister(java.math.BigDecimal parameterId) Unregisters a parameter from the system.
static java.math.BigDecimal	parameterUpdate(java.math.BigDecimal package_id, java.lang.String package_key, java.lang.String parameter_name, java.lang.String description, java.lang.String default_value, java.lang.String datatype)
static java.math.BigDecimal	parameterUpdate(java.math.BigDecimal package_id, java.lang.String package_key, java.lang.String parameter_name, java.lang.String description, java.lang.String default_value, java.lang.String datatype, java.lang.String section_name)
static java.math.BigDecimal	parameterUpdate(java.math.BigDecimal package_id, java.lang.String package_key, java.lang.String parameter_name, java.lang.String description, java.lang.String default_value, java.lang.String datatype, java.lang.String section_name, java.math.BigDecimal min_n_values, java.math.BigDecimal max_n_values)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cvsId

public static final java.lang.String cvsId

apmLibraryTimeMap

protected static java.util.Map apmLibraryTimeMap

Constructor Detail

ApmUtilities

public ApmUtilities()

Method Detail

getVersionLoadStatus

public static java.lang.String getVersionLoadStatus(java.math.BigDecimal versionId)
                                             throws java.sql.SQLException

If a version needs to be reloaded (i.e., a -procs.tcl has changed or been added since the version was loaded), returns "needs_reload". If the version has never been loaded, returns "never_loaded". If the version is up-to-date, returns "up_to_date".

isPackageVersionEnabled

public static boolean isPackageVersionEnabled(java.math.BigDecimal versionId)
                                       throws java.sql.SQLException

Indicates if the particular version specified is enabled. Equivalent to apm_package_version_enabled_p

isPackageRegistered

public static boolean isPackageRegistered(java.lang.String package_key)
                                   throws java.sql.SQLException

Returns true if there is a registered package with the indicated package_key. Returns false otherwise. Equivalent to apm_package_registered_p

apmLog

public static void apmLog(java.lang.String message)

apmLog

public static void apmLog(java.lang.String message,
                          java.lang.String severity)

parameterUpdate

public static java.math.BigDecimal parameterUpdate(java.math.BigDecimal package_id,
                                                   java.lang.String package_key,
                                                   java.lang.String parameter_name,
                                                   java.lang.String description,
                                                   java.lang.String default_value,
                                                   java.lang.String datatype)
                                            throws java.sql.SQLException

parameterUpdate

public static java.math.BigDecimal parameterUpdate(java.math.BigDecimal package_id,
                                                   java.lang.String package_key,
                                                   java.lang.String parameter_name,
                                                   java.lang.String description,
                                                   java.lang.String default_value,
                                                   java.lang.String datatype,
                                                   java.lang.String section_name)
                                            throws java.sql.SQLException

parameterUpdate

public static java.math.BigDecimal parameterUpdate(java.math.BigDecimal package_id,
                                                   java.lang.String package_key,
                                                   java.lang.String parameter_name,
                                                   java.lang.String description,
                                                   java.lang.String default_value,
                                                   java.lang.String datatype,
                                                   java.lang.String section_name,
                                                   java.math.BigDecimal min_n_values,
                                                   java.math.BigDecimal max_n_values)
                                            throws java.sql.SQLException

Returns:

The parameter id that has been updated.

parameterRegister

public static java.math.BigDecimal parameterRegister(java.lang.String package_key,
                                                     java.lang.String parameter_name,
                                                     java.lang.String description,
                                                     java.lang.String default_value,
                                                     java.lang.String datatype,
                                                     java.lang.String section_name,
                                                     java.math.BigDecimal min_n_values,
                                                     java.math.BigDecimal max_n_values)
                                              throws java.sql.SQLException,
                                                     ACSException

parameterRegister

public static java.math.BigDecimal parameterRegister(java.math.BigDecimal parameter_id,
                                                     java.lang.String package_key,
                                                     java.lang.String parameter_name,
                                                     java.lang.String description,
                                                     java.lang.String default_value,
                                                     java.lang.String datatype,
                                                     java.lang.String section_name,
                                                     java.math.BigDecimal min_n_values,
                                                     java.math.BigDecimal max_n_values)
                                              throws java.sql.SQLException,
                                                     ACSException

Register a parameter in the system.

Returns:

The parameter id of the new parameter.

parameterUnregister

public static void parameterUnregister(java.math.BigDecimal parameterId)
                                throws java.sql.SQLException

Unregisters a parameter from the system.

dependencyRemove

public static void dependencyRemove(java.math.BigDecimal dependency_id)
                             throws java.sql.SQLException

Removes a dependency from the system.

interfaceRemove

public static void interfaceRemove(java.math.BigDecimal interface_id)
                            throws java.sql.SQLException

Removes a interface from the system.

dependencyAdd

public static java.math.BigDecimal dependencyAdd(java.math.BigDecimal dependency_id,
                                                 java.math.BigDecimal version_id,
                                                 java.lang.String dependency_uri,
                                                 java.lang.String dependency_version)
                                          throws java.sql.SQLException

Add a dependency to a version.

Returns:

The id of the new dependency.

interfaceAdd

public static java.math.BigDecimal interfaceAdd(java.math.BigDecimal interface_id,
                                                java.math.BigDecimal version_id,
                                                java.lang.String interface_uri,
                                                java.lang.String interface_version)
                                         throws java.sql.SQLException

Add a interface to a version.

Returns:

The id of the new interface.