Package com.tangosol.coherence.management

Class RestManagement

java.lang.Object

com.tangosol.coherence.management.RestManagement

public final class RestManagement
extends Object

The entry point into Coherence Management over REST that can be used by external applications that want to publish the Coherence Management resources on a different endpoint.

Author:

jk 2019.05.30

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RestManagement.MBeanServerProxyFactory	A provider of instances of MBeanServerProxy.

Method Summary

Modifier and Type	Method	Description
static void	configure(org.glassfish.jersey.server.ResourceConfig resourceConfig)	Initialize the ResourceConfig to provide the management over REST endpoints.
static void	configure(org.glassfish.jersey.server.ResourceConfig resourceConfig, RestManagement.MBeanServerProxyFactory factory)	Initialize the ResourceConfig to provide the management over REST endpoints.
static void	configure(org.glassfish.jersey.server.ResourceConfig resourceConfig, Supplier<MBeanServer> factory)	Initialize the ResourceConfig to provide the management over REST endpoints.
static void	configure(org.glassfish.jersey.server.ResourceConfig resourceConfig, Supplier<MBeanServer> factory, Supplier<Set<String>> supplierClusters)	Initialize the ResourceConfig to provide the management over REST endpoints for a multi-cluster environment.

Methods inherited from class java.lang.Object

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

Method Details

configure

public static void configure(org.glassfish.jersey.server.ResourceConfig resourceConfig)

Initialize the ResourceConfig to provide the management over REST endpoints.

This method will configure standard, single cluster, non-versioned endpoints.

Parameters:

resourceConfig - the ResourceConfig to configure

Throws:

NullPointerException - if the any of the parameters are null

configure

public static void configure(org.glassfish.jersey.server.ResourceConfig resourceConfig,
 RestManagement.MBeanServerProxyFactory factory)

Initialize the ResourceConfig to provide the management over REST endpoints.

This method will configure standard, single cluster, non-versioned endpoints.

Parameters:

resourceConfig - the ResourceConfig to configure

factory - the RestManagement.MBeanServerProxyFactory that will supply instances of MBeanServerProxy

Throws:

NullPointerException - if the any of the parameters are null

configure

public static void configure(org.glassfish.jersey.server.ResourceConfig resourceConfig,
 Supplier<MBeanServer> factory)

Initialize the ResourceConfig to provide the management over REST endpoints.

This method will configure standard, single cluster, non-versioned endpoints.

Parameters:

resourceConfig - the ResourceConfig to configure

factory - the Supplier that will supply instances of MBeanServer

Throws:

NullPointerException - if the any of the parameters are null

configure

public static void configure(org.glassfish.jersey.server.ResourceConfig resourceConfig,
 Supplier<MBeanServer> factory,
 Supplier<Set<String>> supplierClusters)

Initialize the ResourceConfig to provide the management over REST endpoints for a multi-cluster environment.

This method will configure the ResourceConfig to use versioned multi-cluster endpoints.

The supplierClusters parameter is expected to supply the valid cluster names that may be used in the request URLs.

Parameters:

resourceConfig - the ResourceConfig to configure

factory - the Supplier that will supply instances of MBeanServer

supplierClusters - a supplier of available cluster names

Throws:

NullPointerException - if the any of the parameters are null