org.rhq.enterprise.server.system

Interface SystemManagerLocal

All Superinterfaces:

SystemManagerRemote

All Known Implementing Classes:

SystemManagerBean

public interface SystemManagerLocal
extends SystemManagerRemote

Provides access to the server cloud's system configuration as well as some methods to perform configuration on the server in which this bean is running.

Method Summary

Methods

Modifier and Type	Method and Description
long	analyze(org.rhq.core.domain.auth.Subject whoami) Run analyze command on PostgreSQL databases.
void	deobfuscate(org.rhq.core.domain.common.composite.SystemSettings systemSettings)
void	dumpSystemInfo(org.rhq.core.domain.auth.Subject subject)
void	enableHibernateStatistics() Creates and registers the Hibernate Statistics MBean.
org.rhq.core.domain.common.composite.SystemSettings	getObfuscatedSystemSettings(boolean includePrivateSettings) The getUnmaskedSystemSettings(boolean) returns the system settings with all the passwords in clear text.
org.rhq.core.domain.common.composite.SystemSettings	getUnmaskedSystemSettings(boolean includePrivateSettings) The SystemManagerRemote.getSystemSettings(org.rhq.core.domain.auth.Subject) returns the system settings with all the password fields masked so that remote clients cannot get hold of the passwords in it.
boolean	isDebugModeEnabled()
boolean	isExperimentalFeaturesEnabled()
boolean	isLdapAuthorizationEnabled()
boolean	isLoginWithoutRolesEnabled()
void	loadSystemConfigurationCache() Grabs the current system configuration from the database and reloads the cache with it.
void	loadSystemConfigurationCacheInNewTx() Grabs the current system configuration from the database and reloads the cache with it.
void	reconfigureSystem(org.rhq.core.domain.auth.Subject whoami) Performs some reconfiguration things on the server where we are running.
long	reindex(org.rhq.core.domain.auth.Subject whoami) Reindexes all tables that need to be periodically reindexed.
void	scheduleConfigCacheReloader() Schedules the internal timer job that periodically refreshes the configuration cache.
void	setAnySystemSetting(org.rhq.core.domain.common.composite.SystemSetting setting, String value) Internal use only.
void	setAnySystemSettings(org.rhq.core.domain.common.composite.SystemSettings settings, boolean skipValidation, boolean ignoreReadOnly) Internal use only.
void	setStorageClusterSettings(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.common.composite.SystemSettings settings) The storage cluster settings are stored as read-only system settings.
void	undeployInstaller() Deprecated.
long	vacuum(org.rhq.core.domain.auth.Subject whoami) Run database-specific cleanup routines.
long	vacuum(org.rhq.core.domain.auth.Subject whoami, String[] tableNames) Run database-specific cleanup routines for the given tables.
long	vacuumAppdef(org.rhq.core.domain.auth.Subject whoami) Run database-specific cleanup routines on appdef tables.
void	validateSystemConfiguration(org.rhq.core.domain.auth.Subject subject, Properties properties)

Methods inherited from interface org.rhq.enterprise.server.system.SystemManagerRemote

getProductInfo, getServerDetails, getSystemConfiguration, getSystemSettings, setSystemConfiguration, setSystemSettings

Method Detail

scheduleConfigCacheReloader

void scheduleConfigCacheReloader()

Schedules the internal timer job that periodically refreshes the configuration cache. This is needed in case a user changed the system configuration on another server in the HA cloud - this config cache reloader will load in that new configuration.

enableHibernateStatistics

void enableHibernateStatistics()

Creates and registers the Hibernate Statistics MBean. This allows us to monitor our own Hibernate usage.

reconfigureSystem

void reconfigureSystem(org.rhq.core.domain.auth.Subject whoami)

Performs some reconfiguration things on the server where we are running. This includes redeploying the configured JAAS modules.

analyze

long analyze(org.rhq.core.domain.auth.Subject whoami)

Run analyze command on PostgreSQL databases. On non-PostgreSQL, this returns -1.

Parameters:

whoami - the user requesting the operation

Returns:

The time it took to analyze, in milliseconds, or -1 if the database is not PostgreSQL.

reindex

long reindex(org.rhq.core.domain.auth.Subject whoami)

Reindexes all tables that need to be periodically reindexed. For Oracle, this "rebuilds" the indexes, for PostgreSQL, its a "reindex".

Parameters:

whoami - the user requesting the operation

Returns:

The time it took to reindex, in milliseconds

vacuum

long vacuum(org.rhq.core.domain.auth.Subject whoami)

Run database-specific cleanup routines. On PostgreSQL we do a VACUUM ANALYZE on all tables. On other databases we just return -1.

Parameters:

whoami - the user requesting the operation

Returns:

The time it took to vaccum, in milliseconds, or -1 if the database is not PostgreSQL.

vacuum

long vacuum(org.rhq.core.domain.auth.Subject whoami,
          String[] tableNames)

Run database-specific cleanup routines for the given tables. On PostgreSQL we do a VACUUM ANALYZE on the given tables. On other databases we just return -1.

Parameters:

whoami - the user requesting the operation

tableNames - names of specific tables that will be vacuumed.

Returns:

The time it took to vaccum, in milliseconds, or -1 if the database is not PostgreSQL.

vacuumAppdef

long vacuumAppdef(org.rhq.core.domain.auth.Subject whoami)

Run database-specific cleanup routines on appdef tables. On PostgreSQL we do a VACUUM ANALYZE against the relevant tables. On other databases we just return -1.

Parameters:

whoami - the user requesting the operation

Returns:

The time it took to vaccum, in milliseconds, or -1 if the database is not PostgreSQL.

undeployInstaller

@Deprecated
void undeployInstaller()

Deprecated.

Ensures the installer has been undeployed. Installer must be undeployed to ensure the server deployment is secure.

loadSystemConfigurationCacheInNewTx

void loadSystemConfigurationCacheInNewTx()

Grabs the current system configuration from the database and reloads the cache with it. This is meant for internal use only! You probably want to use #getSystemConfiguration() instead.

loadSystemConfigurationCache

void loadSystemConfigurationCache()

Grabs the current system configuration from the database and reloads the cache with it. This is meant for internal use only! You probably want to use #getSystemConfiguration() instead.

isDebugModeEnabled

boolean isDebugModeEnabled()

isLoginWithoutRolesEnabled

boolean isLoginWithoutRolesEnabled()

isExperimentalFeaturesEnabled

boolean isExperimentalFeaturesEnabled()

isLdapAuthorizationEnabled

boolean isLdapAuthorizationEnabled()

validateSystemConfiguration

void validateSystemConfiguration(org.rhq.core.domain.auth.Subject subject,
                               Properties properties)
                                 throws InvalidSystemConfigurationException

Throws:

InvalidSystemConfigurationException

dumpSystemInfo

void dumpSystemInfo(org.rhq.core.domain.auth.Subject subject)

setStorageClusterSettings

void setStorageClusterSettings(org.rhq.core.domain.auth.Subject subject,
                             org.rhq.core.domain.common.composite.SystemSettings settings)

The storage cluster settings are stored as read-only system settings. They should be updated through the storage subsystem. This API is provided for use ONLY by the storage subsystem.

Parameters:

subject - The user who wants to change the settings

settings - The new storage cluster settings

Throws:

IllegalArgumentException - If the settings contain anything other than storage cluster settings.

getUnmaskedSystemSettings

org.rhq.core.domain.common.composite.SystemSettings getUnmaskedSystemSettings(boolean includePrivateSettings)

The SystemManagerRemote.getSystemSettings(org.rhq.core.domain.auth.Subject) returns the system settings with all the password fields masked so that remote clients cannot get hold of the passwords in it. It also excludes non-public system settings from the results.

If the password or a non-public setting is needed inside some SLSB, use this method to obtain the system settings with all the fields and the passwords in clear text.

Note that the returned instance MUST NOT leak out of the RHQ server.

Parameters:

includePrivateSettings - whether or not to include the private system settings (i.e. SystemSetting.isPublic() returns false)

Returns:

the system settings with the password fields in clear.

getObfuscatedSystemSettings

org.rhq.core.domain.common.composite.SystemSettings getObfuscatedSystemSettings(boolean includePrivateSettings)

The getUnmaskedSystemSettings(boolean) returns the system settings with all the passwords in clear text. If you want to obtain an instance where the passwords would neither be clear text, nor would they be masked away, you can use this method, that will return the system settings with the passwords obfuscated.

Note that such instance CANNOT be passed to SystemManagerRemote.setSystemSettings(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.common.composite.SystemSettings)!!! Storing the obfuscated passwords would obfuscate them again!!! To be able to persist an instance, you first need to deobfuscate it.

Note that the returned instance MUST NOT leak out of the RHQ server. It contains the passwords in a decodable form and also non-public system settings.

Parameters:

includePrivateSettings - whether or not to include the private system settings (i.e. SystemSetting.isPublic() returns false)

Returns:

an instance of system settings with all the passwords obfuscated.

deobfuscate

void deobfuscate(org.rhq.core.domain.common.composite.SystemSettings systemSettings)

setAnySystemSetting

void setAnySystemSetting(org.rhq.core.domain.common.composite.SystemSetting setting,
                       String value)

Internal use only. Sets any setting (other than LAST_SYSTEM_CONFIG_UPDATE_TIME) regardless of whether it is private or read-only. Guarantees proper cache update. Performs no validation or un/masking.

Parameters:

setting -

value -

setAnySystemSettings

void setAnySystemSettings(org.rhq.core.domain.common.composite.SystemSettings settings,
                        boolean skipValidation,
                        boolean ignoreReadOnly)

Internal use only. Like SystemManagerRemote.setSystemSettings(Subject, SystemSettings) but can bypass validation and also ignore the readOnly constraint.

Parameters:

settings -

skipValidation - if true, skip validation

ignoreReadOnly - if true, ignore the readOnly constraint and set new values if supplied

value -