com.orbitz.consul

Class CatalogClient

java.lang.Object

com.orbitz.consul.CatalogClient

public class CatalogClient
extends Object

HTTP Client for /v1/catalog/ endpoints.

Field Summary

Fields

Modifier and Type	Field and Description
protected Http	http

Method Summary

Modifier and Type	Method and Description
void	deregister(CatalogDeregistration deregistration) Deregisters a service or node.
void	deregister(CatalogDeregistration deregistration, QueryOptions options) Deregisters a service or node.
ClientConfig	getConfig()
List<String>	getDatacenters() Retrieves all datacenters.
ClientEventHandler	getEventHandler()
ConsulResponse<CatalogNode>	getNode(String node) Retrieves a single node.
ConsulResponse<CatalogNode>	getNode(String node, QueryOptions queryOptions) Retrieves a single node for a given datacenter with QueryOptions.
void	getNode(String node, QueryOptions queryOptions, ConsulResponseCallback<CatalogNode> callback) Asynchronously retrieves the single node for a given datacenter with QueryOptions.
ConsulResponse<List<Node>>	getNodes() Retrieves all nodes.
ConsulResponse<List<Node>>	getNodes(QueryOptions queryOptions) Retrieves all nodes for a given datacenter with QueryOptions.
void	getNodes(QueryOptions queryOptions, ConsulResponseCallback<List<Node>> callback) Asynchronously retrieves the nodes for a given datacenter with QueryOptions.
ConsulResponse<List<CatalogService>>	getService(String service) Retrieves the single service.
ConsulResponse<List<CatalogService>>	getService(String service, QueryOptions queryOptions) Retrieves a single service for a given datacenter with QueryOptions.
void	getService(String service, QueryOptions queryOptions, ConsulResponseCallback<List<CatalogService>> callback) Asynchronously retrieves the single service for a given datacenter with QueryOptions.
ConsulResponse<Map<String,List<String>>>	getServices() Retrieves all services for a given datacenter.
void	getServices(ConsulResponseCallback<Map<String,List<String>>> callback) Asynchronously retrieves the services for a given datacenter.
ConsulResponse<Map<String,List<String>>>	getServices(QueryOptions queryOptions) Retrieves all services for a given datacenter.
void	getServices(QueryOptions queryOptions, ConsulResponseCallback<Map<String,List<String>>> callback) Asynchronously retrieves the services for a given datacenter.
void	register(CatalogRegistration registration) Registers a service or node.
void	register(CatalogRegistration registration, QueryOptions options) Registers a service or node.

Methods inherited from class java.lang.Object

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

Field Detail

http

protected final Http http

Method Detail

getDatacenters

public List<String> getDatacenters()

Retrieves all datacenters.

GET /v1/catalog/datacenters

Returns:

A list of datacenter names.

getNodes

public ConsulResponse<List<Node>> getNodes()

Retrieves all nodes.

GET /v1/catalog/nodes

Returns:

A ConsulResponse containing a list of Node objects.

getNodes

public ConsulResponse<List<Node>> getNodes(QueryOptions queryOptions)

Retrieves all nodes for a given datacenter with QueryOptions.

GET /v1/catalog/nodes?dc={datacenter}

Parameters:

queryOptions - The Query Options to use.

Returns:

A ConsulResponse containing a list of Node objects.

getNodes

public void getNodes(QueryOptions queryOptions,
                     ConsulResponseCallback<List<Node>> callback)

Asynchronously retrieves the nodes for a given datacenter with QueryOptions.

GET /v1/catalog/nodes?dc={datacenter}

Parameters:

queryOptions - The Query Options to use.

callback - Callback implemented by callee to handle results. Node objects.

getServices

public ConsulResponse<Map<String,List<String>>> getServices()

Retrieves all services for a given datacenter.

GET /v1/catalog/services?dc={datacenter}

Returns:

A ConsulResponse containing a map of service name to list of tags.

getServices

public void getServices(ConsulResponseCallback<Map<String,List<String>>> callback)

Asynchronously retrieves the services for a given datacenter.

GET /v1/catalog/services?dc={datacenter}

Parameters:

callback - Callback implemented by callee to handle results.

getServices

public ConsulResponse<Map<String,List<String>>> getServices(QueryOptions queryOptions)

Retrieves all services for a given datacenter.

GET /v1/catalog/services?dc={datacenter}

Parameters:

queryOptions - The Query Options to use.

Returns:

A ConsulResponse containing a map of service name to list of tags.

getServices

public void getServices(QueryOptions queryOptions,
                        ConsulResponseCallback<Map<String,List<String>>> callback)

Asynchronously retrieves the services for a given datacenter.

GET /v1/catalog/services?dc={datacenter}

Parameters:

queryOptions - The Query Options to use.

callback - Callback implemented by callee to handle results.

getService

public ConsulResponse<List<CatalogService>> getService(String service)

Retrieves the single service.

GET /v1/catalog/service/{service}

Returns:

A ConsulResponse containing CatalogService objects.

getService

public ConsulResponse<List<CatalogService>> getService(String service,
                                                       QueryOptions queryOptions)

Retrieves a single service for a given datacenter with QueryOptions.

GET /v1/catalog/service/{service}?dc={datacenter}

Parameters:

queryOptions - The Query Options to use.

Returns:

A ConsulResponse containing CatalogService objects.

getService

public void getService(String service,
                       QueryOptions queryOptions,
                       ConsulResponseCallback<List<CatalogService>> callback)

Asynchronously retrieves the single service for a given datacenter with QueryOptions.

GET /v1/catalog/service/{service}?dc={datacenter}

Parameters:

queryOptions - The Query Options to use.

callback - Callback implemented by callee to handle results.

getNode

public ConsulResponse<CatalogNode> getNode(String node)

Retrieves a single node.

GET /v1/catalog/node/{node}

Returns:

A list of matching CatalogService objects.

getNode

public ConsulResponse<CatalogNode> getNode(String node,
                                           QueryOptions queryOptions)

Retrieves a single node for a given datacenter with QueryOptions.

GET /v1/catalog/node/{node}?dc={datacenter}

Parameters:

queryOptions - The Query Options to use.

Returns:

A list of matching CatalogService objects.

getNode

public void getNode(String node,
                    QueryOptions queryOptions,
                    ConsulResponseCallback<CatalogNode> callback)

Asynchronously retrieves the single node for a given datacenter with QueryOptions.

GET /v1/catalog/node/{node}?dc={datacenter}

Parameters:

queryOptions - The Query Options to use.

callback - Callback implemented by callee to handle results.

register

public void register(CatalogRegistration registration)

Registers a service or node.

PUT /v1/catalog/register

Parameters:

registration - A CatalogRegistration

register

public void register(CatalogRegistration registration,
                     QueryOptions options)

Registers a service or node.

PUT /v1/catalog/register

Parameters:

registration - A CatalogRegistration

deregister

public void deregister(CatalogDeregistration deregistration)

Deregisters a service or node.

PUT /v1/catalog/deregister

Parameters:

deregistration - A CatalogDeregistration

deregister

public void deregister(CatalogDeregistration deregistration,
                       QueryOptions options)

Deregisters a service or node.

PUT /v1/catalog/deregister

Parameters:

deregistration - A CatalogDeregistration

getConfig

public ClientConfig getConfig()

getEventHandler

public ClientEventHandler getEventHandler()