org.rhq.bindings.client

Interface RhqFacade

All Known Implementing Classes:

AbstractRhqFacade

public interface RhqFacade

This is an interface through which the script can communicate with RHQ server.

Author:

Lukas Krejci

Method Summary

Methods

Modifier and Type	Method and Description
org.rhq.enterprise.server.alert.AlertDefinitionManagerRemote	getAlertDefinitionManager() Deprecated.
org.rhq.enterprise.server.alert.AlertManagerRemote	getAlertManager() Deprecated.
org.rhq.enterprise.server.measurement.AvailabilityManagerRemote	getAvailabilityManager() Deprecated.
org.rhq.enterprise.server.bundle.BundleManagerRemote	getBundleManager() Deprecated.
org.rhq.enterprise.server.measurement.CallTimeDataManagerRemote	getCallTimeDataManager() Deprecated.
org.rhq.enterprise.server.configuration.ConfigurationManagerRemote	getConfigurationManager() Deprecated.
org.rhq.enterprise.server.content.ContentManagerRemote	getContentManager() Deprecated.
org.rhq.enterprise.server.report.DataAccessManagerRemote	getDataAccessManager() Deprecated.
org.rhq.enterprise.server.discovery.DiscoveryBossRemote	getDiscoveryBoss() Deprecated.
org.rhq.enterprise.server.drift.DriftManagerRemote	getDriftManager() Deprecated.
org.rhq.enterprise.server.event.EventManagerRemote	getEventManager() Deprecated.
Map<RhqManagers,Object>	getManagers() Deprecated.
org.rhq.enterprise.server.measurement.MeasurementBaselineManagerRemote	getMeasurementBaselineManager() Deprecated.
org.rhq.enterprise.server.measurement.MeasurementDataManagerRemote	getMeasurementDataManager() Deprecated.
org.rhq.enterprise.server.measurement.MeasurementDefinitionManagerRemote	getMeasurementDefinitionManager() Deprecated.
org.rhq.enterprise.server.measurement.MeasurementScheduleManagerRemote	getMeasurementScheduleManager() Deprecated.
org.rhq.enterprise.server.operation.OperationManagerRemote	getOperationManager() Deprecated.
<T> T	getProxy(Class<T> remoteApiIface) Unlike the getScriptingAPI() method that returns objects with modified signatures meant to be used by the scripting environment, this method provides the access to the "raw" remote API interface implementation backed by this RHQ facade implementation.
org.rhq.enterprise.server.install.remote.RemoteInstallManagerRemote	getRemoteInstallManager() Deprecated.
org.rhq.enterprise.server.content.RepoManagerRemote	getRepoManager() Deprecated.
org.rhq.enterprise.server.resource.ResourceFactoryManagerRemote	getResourceFactoryManager() Deprecated.
org.rhq.enterprise.server.resource.group.ResourceGroupManagerRemote	getResourceGroupManager() Deprecated.
org.rhq.enterprise.server.resource.ResourceManagerRemote	getResourceManager() Deprecated.
org.rhq.enterprise.server.resource.ResourceTypeManagerRemote	getResourceTypeManager() Deprecated.
org.rhq.enterprise.server.authz.RoleManagerRemote	getRoleManager() Deprecated.
org.rhq.enterprise.server.search.SavedSearchManagerRemote	getSavedSearchManager() Deprecated.
Map<RhqManager,Object>	getScriptingAPI() This map is constructed using all the elements in the RhqManager enum which are then proxied using this instance.
org.rhq.core.domain.auth.Subject	getSubject()
org.rhq.enterprise.server.auth.SubjectManagerRemote	getSubjectManager() Deprecated.
org.rhq.enterprise.server.support.SupportManagerRemote	getSupportManager() Deprecated.
org.rhq.enterprise.server.sync.SynchronizationManagerRemote	getSynchronizationManager() Deprecated.
org.rhq.enterprise.server.system.SystemManagerRemote	getSystemManager() Deprecated.
org.rhq.enterprise.server.tagging.TagManagerRemote	getTagManager() Deprecated.
boolean	isLoggedIn()
org.rhq.core.domain.auth.Subject	login(String user, String password)
void	logout()

Method Detail

getSubject

org.rhq.core.domain.auth.Subject getSubject()

Returns:

the user the facade is authenticated as

login

org.rhq.core.domain.auth.Subject login(String user,
                                     String password)
                                       throws Exception

Throws:

Exception

logout

void logout()

isLoggedIn

boolean isLoggedIn()

getScriptingAPI

Map<RhqManager,Object> getScriptingAPI()

This map is constructed using all the elements in the RhqManager enum which are then proxied using this instance.

Returns:

a map of all available proxied managers keyed by their names.

getProxy

<T> T getProxy(Class<T> remoteApiIface)

Unlike the getScriptingAPI() method that returns objects with modified signatures meant to be used by the scripting environment, this method provides the access to the "raw" remote API interface implementation backed by this RHQ facade implementation.

Parameters:

remoteApiIface - one of the RHQ's remote API interfaces of which the proxied instance should be returned

Returns:

the proxy of the remote API interface backed by this facade

getAlertDefinitionManager

@Deprecated
org.rhq.enterprise.server.alert.AlertDefinitionManagerRemote getAlertDefinitionManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getAlertManager

@Deprecated
org.rhq.enterprise.server.alert.AlertManagerRemote getAlertManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getAvailabilityManager

@Deprecated
org.rhq.enterprise.server.measurement.AvailabilityManagerRemote getAvailabilityManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getBundleManager

@Deprecated
org.rhq.enterprise.server.bundle.BundleManagerRemote getBundleManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getCallTimeDataManager

@Deprecated
org.rhq.enterprise.server.measurement.CallTimeDataManagerRemote getCallTimeDataManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getConfigurationManager

@Deprecated
org.rhq.enterprise.server.configuration.ConfigurationManagerRemote getConfigurationManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getContentManager

@Deprecated
org.rhq.enterprise.server.content.ContentManagerRemote getContentManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getDataAccessManager

@Deprecated
org.rhq.enterprise.server.report.DataAccessManagerRemote getDataAccessManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getDiscoveryBoss

@Deprecated
org.rhq.enterprise.server.discovery.DiscoveryBossRemote getDiscoveryBoss()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getDriftManager

@Deprecated
org.rhq.enterprise.server.drift.DriftManagerRemote getDriftManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getEventManager

@Deprecated
org.rhq.enterprise.server.event.EventManagerRemote getEventManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getManagers

@Deprecated
Map<RhqManagers,Object> getManagers()

Deprecated.

Kept for backwards compatibility but otherwise unused. In RHQ prior to 4.5.0, the values in the map, i.e. the manager objects themselves both implemented the various *Remote interfaces and contained methods with the modified signatures with the Subject parameter removed.

Since RHQ 4.5.0 the returned objects no longer contain the modified method. If you want to obtain objects with such methods (intended for use in scripted environments), use getScriptingAPI() method instead.

getMeasurementBaselineManager

@Deprecated
org.rhq.enterprise.server.measurement.MeasurementBaselineManagerRemote getMeasurementBaselineManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getMeasurementDataManager

@Deprecated
org.rhq.enterprise.server.measurement.MeasurementDataManagerRemote getMeasurementDataManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getMeasurementDefinitionManager

@Deprecated
org.rhq.enterprise.server.measurement.MeasurementDefinitionManagerRemote getMeasurementDefinitionManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getMeasurementScheduleManager

@Deprecated
org.rhq.enterprise.server.measurement.MeasurementScheduleManagerRemote getMeasurementScheduleManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getOperationManager

@Deprecated
org.rhq.enterprise.server.operation.OperationManagerRemote getOperationManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getRemoteInstallManager

@Deprecated
org.rhq.enterprise.server.install.remote.RemoteInstallManagerRemote getRemoteInstallManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getRepoManager

@Deprecated
org.rhq.enterprise.server.content.RepoManagerRemote getRepoManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getResourceFactoryManager

@Deprecated
org.rhq.enterprise.server.resource.ResourceFactoryManagerRemote getResourceFactoryManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getResourceGroupManager

@Deprecated
org.rhq.enterprise.server.resource.group.ResourceGroupManagerRemote getResourceGroupManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getResourceManager

@Deprecated
org.rhq.enterprise.server.resource.ResourceManagerRemote getResourceManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getResourceTypeManager

@Deprecated
org.rhq.enterprise.server.resource.ResourceTypeManagerRemote getResourceTypeManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getRoleManager

@Deprecated
org.rhq.enterprise.server.authz.RoleManagerRemote getRoleManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getSavedSearchManager

@Deprecated
org.rhq.enterprise.server.search.SavedSearchManagerRemote getSavedSearchManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getSubjectManager

@Deprecated
org.rhq.enterprise.server.auth.SubjectManagerRemote getSubjectManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getSupportManager

@Deprecated
org.rhq.enterprise.server.support.SupportManagerRemote getSupportManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getSynchronizationManager

@Deprecated
org.rhq.enterprise.server.sync.SynchronizationManagerRemote getSynchronizationManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getSystemManager

@Deprecated
org.rhq.enterprise.server.system.SystemManagerRemote getSystemManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead

getTagManager

@Deprecated
org.rhq.enterprise.server.tagging.TagManagerRemote getTagManager()

Deprecated.

deprecated use RhqFacade.getProxy(RhqManager.XXX.remote()) instead