org.apache.knox.gateway.topology.discovery

Interface ServiceDiscovery

public interface ServiceDiscovery

Implementations provide the means by which Hadoop service endpoint URLs are discovered from a source with knowledge about the service topology of one or more clusters.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ServiceDiscovery.Cluster A handle to the service discovery result.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_DIR_PROPERTY

Method Summary

Modifier and Type	Method and Description
Map<String,ServiceDiscovery.Cluster>	discover(GatewayConfig gwConfig, ServiceDiscoveryConfig config) Discover details of all the clusters known to the target registry.
ServiceDiscovery.Cluster	discover(GatewayConfig gwConfig, ServiceDiscoveryConfig config, String clusterName) Discover details for a single cluster.
String	getType() This is the type specified in a simple descriptor to indicate which ServiceDiscovery implementation to employ.

Field Detail

CONFIG_DIR_PROPERTY

static final String CONFIG_DIR_PROPERTY

See Also:

Constant Field Values

Method Detail

getType

String getType()

This is the type specified in a simple descriptor to indicate which ServiceDiscovery implementation to employ.

Returns:

The identifier for the service discovery type.

discover

Map<String,ServiceDiscovery.Cluster> discover(GatewayConfig gwConfig,
                                              ServiceDiscoveryConfig config)

Discover details of all the clusters known to the target registry.

Parameters:

gwConfig - The gateway configuration

config - The configuration for the discovery invocation

Returns:

A Map of the discovered service data, keyed by the cluster name.

discover

ServiceDiscovery.Cluster discover(GatewayConfig gwConfig,
                                  ServiceDiscoveryConfig config,
                                  String clusterName)

Discover details for a single cluster.

Parameters:

gwConfig - The gateway configuration

config - The configuration for the discovery invocation

clusterName - The name of a particular cluster

Returns:

The discovered service data for the specified cluster