com.mesosphere.sdk.http

Class EndpointsResource

java.lang.Object

com.mesosphere.sdk.http.EndpointsResource

public class EndpointsResource
extends java.lang.Object

A read-only API for accessing information about how to connect to the service.

Constructor Summary

Constructors

Constructor and Description
EndpointsResource(StateStore stateStore, java.lang.String serviceName) Creates a new instance which retrieves task/pod state from the provided StateStore, using the provided serviceName for endpoint paths.

Method Summary

Modifier and Type	Method and Description
Response	getEndpoint(java.lang.String name) Produces the content of the specified endpoint.
Response	getEndpoints() Produces a listing of all endpoint names.
EndpointsResource	setCustomEndpoint(java.lang.String name, EndpointProducer endpointProducer) Adds the provided custom endpoint key/value entry to this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointsResource

public EndpointsResource(StateStore stateStore,
                         java.lang.String serviceName)

Creates a new instance which retrieves task/pod state from the provided StateStore, using the provided serviceName for endpoint paths.

Method Detail

setCustomEndpoint

public EndpointsResource setCustomEndpoint(java.lang.String name,
                                           EndpointProducer endpointProducer)

Adds the provided custom endpoint key/value entry to this instance. This may be used to expose additional endpoint types independently of what's listed in DiscoveryInfo, such as a Kafka service exposing a Zookeeper path that's separate from the default broker host/port listing. This only supports simple string values in order to ensure that the 'endpoints' endpoint remains relatively consistent across services. For a per-task listing of endpoints, you should provide that information via DiscoveryInfo in your TaskInfo and they will appear automatically.

Parameters:

name - the name of the custom endpoint. custom endpoints take precedence over default endpoints of the same name

endpointProducer - the endpoint producer, which will be invoked whenever a user queries the list of endpoints

getEndpoints

public Response getEndpoints()

Produces a listing of all endpoint names.

getEndpoint

public Response getEndpoint(java.lang.String name)

Produces the content of the specified endpoint.

Parameters:

name - the name of the endpoint whose content should be included