org.rhq.enterprise.server.system

Class SystemManagerBean

java.lang.Object

org.rhq.enterprise.server.system.SystemManagerBean

All Implemented Interfaces:

SystemManagerLocal, SystemManagerRemote

public class SystemManagerBean
extends Object
implements SystemManagerLocal, SystemManagerRemote

Constructor Summary

Constructors

Constructor and Description
SystemManagerBean()

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 SystemManagerLocal.getUnmaskedSystemSettings(boolean) returns the system settings with all the passwords in clear text.
org.rhq.core.domain.common.ProductInfo	getProductInfo(org.rhq.core.domain.auth.Subject subject) Provides product information suitable for "About" details.
org.rhq.core.domain.common.ServerDetails	getServerDetails(org.rhq.core.domain.auth.Subject subject) Provides details (such as product version) of the server processing the request.
Properties	getSystemConfiguration(org.rhq.core.domain.auth.Subject subject) Deprecated.
org.rhq.core.domain.common.composite.SystemSettings	getSystemSettings(org.rhq.core.domain.auth.Subject subject) Get the server cloud configuration.
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	reloadConfigCache(javax.ejb.Timer timer)
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	setSystemConfiguration(org.rhq.core.domain.auth.Subject subject, Properties properties, boolean skipValidation) Deprecated.
void	setSystemSettings(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.common.composite.SystemSettings settings) Set the server cloud configuration.
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 class java.lang.Object

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

Constructor Detail

SystemManagerBean

public SystemManagerBean()

Method Detail

scheduleConfigCacheReloader

public void scheduleConfigCacheReloader()

Description copied from interface: SystemManagerLocal

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.

Specified by:

scheduleConfigCacheReloader in interface SystemManagerLocal

reloadConfigCache

public void reloadConfigCache(javax.ejb.Timer timer)

getSystemConfiguration

@Deprecated
public Properties getSystemConfiguration(org.rhq.core.domain.auth.Subject subject)

Deprecated.

Specified by:

getSystemConfiguration in interface SystemManagerRemote

Returns:

system config

getSystemSettings

public org.rhq.core.domain.common.composite.SystemSettings getSystemSettings(org.rhq.core.domain.auth.Subject subject)

Description copied from interface: SystemManagerRemote

Get the server cloud configuration. These are the server configurations that will be the same for all servers in the HA server cloud.

Note that any password fields in the returned settings will be masked (i.e. will not correspond to the actual value stored in the database), see PropertySimple.MASKED_VALUE.

Specified by:

getSystemSettings in interface SystemManagerRemote

Parameters:

subject - user making the request

Returns:

the settings

getUnmaskedSystemSettings

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

Description copied from interface: SystemManagerLocal

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.

Specified by:

getUnmaskedSystemSettings in interface SystemManagerLocal

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.

deobfuscate

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

Specified by:

deobfuscate in interface SystemManagerLocal

getObfuscatedSystemSettings

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

Description copied from interface: SystemManagerLocal

The SystemManagerLocal.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.

Specified by:

getObfuscatedSystemSettings in interface SystemManagerLocal

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.

setSystemSettings

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

Description copied from interface: SystemManagerRemote

Set the server cloud configuration. The given properties will be the new settings for all servers in the HA server cloud.

Specified by:

setSystemSettings in interface SystemManagerRemote

Parameters:

subject - the user who wants to change the settings

settings - the new system configuration settings

setAnySystemSetting

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

Description copied from interface: SystemManagerLocal

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.

Specified by:

setAnySystemSetting in interface SystemManagerLocal

setStorageClusterSettings

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

Description copied from interface: SystemManagerLocal

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.

Specified by:

setStorageClusterSettings in interface SystemManagerLocal

Parameters:

subject - The user who wants to change the settings

settings - The new storage cluster settings

setAnySystemSettings

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

Description copied from interface: SystemManagerLocal

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

Specified by:

setAnySystemSettings in interface SystemManagerLocal

skipValidation - if true, skip validation

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

loadSystemConfigurationCacheInNewTx

public void loadSystemConfigurationCacheInNewTx()

Description copied from interface: SystemManagerLocal

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.

Specified by:

loadSystemConfigurationCacheInNewTx in interface SystemManagerLocal

loadSystemConfigurationCache

public void loadSystemConfigurationCache()

Description copied from interface: SystemManagerLocal

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.

Specified by:

loadSystemConfigurationCache in interface SystemManagerLocal

setSystemConfiguration

@Deprecated
public void setSystemConfiguration(org.rhq.core.domain.auth.Subject subject,
                                     Properties properties,
                                     boolean skipValidation)
                            throws Exception

Deprecated.

Specified by:

setSystemConfiguration in interface SystemManagerRemote

Throws:

Exception

validateSystemConfiguration

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

Specified by:

validateSystemConfiguration in interface SystemManagerLocal

Throws:

InvalidSystemConfigurationException

enableHibernateStatistics

public void enableHibernateStatistics()

Description copied from interface: SystemManagerLocal

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

Specified by:

enableHibernateStatistics in interface SystemManagerLocal

reconfigureSystem

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

Description copied from interface: SystemManagerLocal

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

Specified by:

reconfigureSystem in interface SystemManagerLocal

analyze

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

Description copied from interface: SystemManagerLocal

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

Specified by:

analyze in interface SystemManagerLocal

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

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

Description copied from interface: SystemManagerLocal

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

Specified by:

reindex in interface SystemManagerLocal

Parameters:

whoami - the user requesting the operation

Returns:

The time it took to reindex, in milliseconds

vacuum

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

Description copied from interface: SystemManagerLocal

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

Specified by:

vacuum in interface SystemManagerLocal

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

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

Description copied from interface: SystemManagerLocal

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.

Specified by:

vacuum in interface SystemManagerLocal

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

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

Description copied from interface: SystemManagerLocal

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.

Specified by:

vacuumAppdef in interface SystemManagerLocal

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
public void undeployInstaller()

Deprecated.

Ensures the installer is no longer deployed.

Specified by:

undeployInstaller in interface SystemManagerLocal

isDebugModeEnabled

public boolean isDebugModeEnabled()

Specified by:

isDebugModeEnabled in interface SystemManagerLocal

isLoginWithoutRolesEnabled

public boolean isLoginWithoutRolesEnabled()

Specified by:

isLoginWithoutRolesEnabled in interface SystemManagerLocal

isExperimentalFeaturesEnabled

public boolean isExperimentalFeaturesEnabled()

Specified by:

isExperimentalFeaturesEnabled in interface SystemManagerLocal

isLdapAuthorizationEnabled

public boolean isLdapAuthorizationEnabled()

Specified by:

isLdapAuthorizationEnabled in interface SystemManagerLocal

getServerDetails

public org.rhq.core.domain.common.ServerDetails getServerDetails(org.rhq.core.domain.auth.Subject subject)

Description copied from interface: SystemManagerRemote

Provides details (such as product version) of the server processing the request. Requires MANAGE_SETTINGS.

Specified by:

getServerDetails in interface SystemManagerRemote

Parameters:

subject - user making the request

Returns:

server details

getProductInfo

public org.rhq.core.domain.common.ProductInfo getProductInfo(org.rhq.core.domain.auth.Subject subject)

Description copied from interface: SystemManagerRemote

Provides product information suitable for "About" details.

Specified by:

getProductInfo in interface SystemManagerRemote

Parameters:

subject - user making the request

Returns:

the product info

dumpSystemInfo

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

Specified by:

dumpSystemInfo in interface SystemManagerLocal