org.rvpf.jmx

Class Agent

Object

Agent

public final class Agent
extends Object

JMX agent.

Used to register a ServiceActivator with a MBeanServer.

Also used to export an AgentSessionFactory bound to the RMI registry under the name of a ServiceActivator.

Implemented as a singleton, it will be shared by ServiceActivators running together.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JMX_PROPERTIES JMX properties.
static String	PASSWORD_PROPERTY Login password property.
static String	PLATFORM_PROPERTY Platform property.
static String	REGISTRATION_ENABLED_PROPERTY Enables automatic registration of standalone services.
static String	REGISTRY_PREFIX The prefix used for registry names.
static String	ROLE_CONNECT_PROPERTY The role needed for connection to the agent.
static String	USER_PROPERTY Login user property.

Method Summary

Modifier and Type	Method and Description
boolean	exportService(ServiceActivator serviceActivator) Exports the AgentSessionFactory under the name of a service.
static Agent	getInstance() Gets the singleton instance.
static LoginInfo	getLoginInfo(Config config) Gets login informations.
static boolean	isRegistrationEnabled(Config config) Asks if automatic registration of standalone services is enabled.
boolean	registerService(ServiceActivator serviceActivator) Registers a service.
boolean	registerStatsHolder(StatsHolder statsHolder) Registers a stats holder.
boolean	setUp(Config config) Sets up the agent.
void	tearDown(Config config) Tears down what has been set up.
void	unexportService(ServiceActivator serviceActivator) Unexports a service.
void	unregisterService(ServiceActivator serviceActivator) Unregisters a service.
void	unregisterStatsHolder(StatsHolder statsHolder) Unregisters a stats holder.

Methods inherited from class Object

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

Field Detail

JMX_PROPERTIES

public static final String JMX_PROPERTIES

JMX properties.

See Also:

Constant Field Values

PASSWORD_PROPERTY

public static final String PASSWORD_PROPERTY

Login password property.

See Also:

Constant Field Values

PLATFORM_PROPERTY

public static final String PLATFORM_PROPERTY

Platform property.

See Also:

Constant Field Values

REGISTRATION_ENABLED_PROPERTY

public static final String REGISTRATION_ENABLED_PROPERTY

Enables automatic registration of standalone services.

See Also:

Constant Field Values

REGISTRY_PREFIX

public static final String REGISTRY_PREFIX

The prefix used for registry names.

See Also:

Constant Field Values

ROLE_CONNECT_PROPERTY

public static final String ROLE_CONNECT_PROPERTY

The role needed for connection to the agent.

See Also:

Constant Field Values

USER_PROPERTY

public static final String USER_PROPERTY

Login user property.

See Also:

Constant Field Values

Method Detail

getInstance

@Nonnull
 @CheckReturnValue
public static Agent getInstance()

Gets the singleton instance.

Returns:

The singleton instance.

getLoginInfo

@Nonnull
 @CheckReturnValue
public static LoginInfo getLoginInfo(@Nonnull
                                                                   Config config)

Gets login informations.

Parameters:

config - The configuration.

Returns:

The login informations.

isRegistrationEnabled

@CheckReturnValue
public static boolean isRegistrationEnabled(@Nonnull
                                                               Config config)

Asks if automatic registration of standalone services is enabled.

Parameters:

config - The config.

Returns:

True if registration is enabled.

exportService

@CheckReturnValue
public boolean exportService(@Nonnull
                                                ServiceActivator serviceActivator)

Exports the AgentSessionFactory under the name of a service.

Parameters:

serviceActivator - The service activator.

Returns:

A true value on success.

registerService

@CheckReturnValue
public boolean registerService(@Nonnull
                                                  ServiceActivator serviceActivator)

Registers a service.

Parameters:

serviceActivator - The service activator.

Returns:

A true value on success.

registerStatsHolder

@CheckReturnValue
public boolean registerStatsHolder(@Nonnull
                                                      StatsHolder statsHolder)

Registers a stats holder.

Parameters:

statsHolder - The stats holder.

Returns:

A true value on success.

setUp

@CheckReturnValue
public boolean setUp(@Nonnull
                                        Config config)

Sets up the agent.

The first call will perform the initializations. Further calls will be ignored.

Parameters:

config - The config.

Returns:

A true value on success or when ignored.

tearDown

public void tearDown(@Nonnull
                     Config config)

Tears down what has been set up.

Calls with a config other than the one used on the first call to setUp(org.rvpf.config.Config) will be ignored.

Parameters:

config - The config that was passed to setUp(org.rvpf.config.Config).

unexportService

public void unexportService(@Nonnull
                            ServiceActivator serviceActivator)

Unexports a service.

Parameters:

serviceActivator - The service activator.

unregisterService

public void unregisterService(@Nonnull
                              ServiceActivator serviceActivator)

Unregisters a service.

Parameters:

serviceActivator - The service activator.

unregisterStatsHolder

public void unregisterStatsHolder(@Nonnull
                                  StatsHolder statsHolder)

Unregisters a stats holder.

Parameters:

statsHolder - The stats holder.