org.rhq.bindings.client

Interface RhqFacade

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
<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.
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()
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