Index (Curator Service Discovery 5.6.0 API)

A B C D E F G H I J L N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

add(UriSpec.Part) - Method in class org.apache.curator.x.discovery.UriSpec: Add a part to the end of the list
additionalFilter(InstanceFilter<T>) - Method in interface org.apache.curator.x.discovery.ServiceProviderBuilder: Add an instance filter.
addListener(ServiceCacheListener) - Method in class org.apache.curator.x.discovery.details.ServiceCacheImpl
addListener(ServiceCacheListener, Executor) - Method in class org.apache.curator.x.discovery.details.ServiceCacheImpl
address(String) - Method in class org.apache.curator.x.discovery.ServiceInstanceBuilder

B

basePath(String) - Method in class org.apache.curator.x.discovery.ServiceDiscoveryBuilder: Required - set the base path to store in ZK, see ServiceDiscoveryBuilder.pathConstructor(DiscoveryPathConstructor) for alternative
build() - Method in interface org.apache.curator.x.discovery.ServiceCacheBuilder: Return a new service cache with the current settings
build() - Method in class org.apache.curator.x.discovery.ServiceDiscoveryBuilder: Build a new service discovery with the currently set values.
build() - Method in class org.apache.curator.x.discovery.ServiceInstanceBuilder: Return a new instance with the currently set values
build() - Method in interface org.apache.curator.x.discovery.ServiceProviderBuilder: Allocate a new service provider based on the current builder settings
build() - Method in class org.apache.curator.x.discovery.UriSpec: Build into a UriSpec string
build(Map<String, Object>) - Method in class org.apache.curator.x.discovery.UriSpec: Build into a UriSpec string
build(ServiceInstance<?>) - Method in class org.apache.curator.x.discovery.UriSpec: Build into a UriSpec string
build(ServiceInstance<?>, Map<String, Object>) - Method in class org.apache.curator.x.discovery.UriSpec: Build into a UriSpec string
builder() - Static method in class org.apache.curator.x.discovery.ServiceInstance: Return a new builder.
builder(Class<T>) - Static method in class org.apache.curator.x.discovery.ServiceDiscoveryBuilder: Return a new builder.
buildUriSpec() - Method in class org.apache.curator.x.discovery.ServiceInstance
buildUriSpec(Map<String, Object>) - Method in class org.apache.curator.x.discovery.ServiceInstance

C

cacheChanged() - Method in interface org.apache.curator.x.discovery.details.ServiceCacheListener: Called when the cache has changed (instances added/deleted, etc.)
childEvent(CuratorFramework, PathChildrenCacheEvent) - Method in class org.apache.curator.x.discovery.details.ServiceCacheImpl
client(CuratorFramework) - Method in class org.apache.curator.x.discovery.ServiceDiscoveryBuilder: Required - set the client to use
close() - Method in class org.apache.curator.x.discovery.details.ServiceCacheImpl
close() - Method in class org.apache.curator.x.discovery.details.ServiceDiscoveryImpl
close() - Method in class org.apache.curator.x.discovery.details.ServiceProviderImpl: Close the provider.
close() - Method in interface org.apache.curator.x.discovery.ServiceProvider: Close the provider.

D

deserialize(byte[]) - Method in interface org.apache.curator.x.discovery.details.InstanceSerializer: Deserialize a byte array into an instance
deserialize(byte[]) - Method in class org.apache.curator.x.discovery.details.JsonInstanceSerializer
DiscoveryPathConstructor - Interface in org.apache.curator.x.discovery: Constructs ZooKeeper paths to services for service discovering.
DiscoveryPathConstructorImpl - Class in org.apache.curator.x.discovery.details: A standard constructor, it uses standard path constructing strategy by applying name to the base path.
DiscoveryPathConstructorImpl(String) - Constructor for class org.apache.curator.x.discovery.details.DiscoveryPathConstructorImpl
downInstancePolicy(DownInstancePolicy) - Method in interface org.apache.curator.x.discovery.ServiceProviderBuilder: Set the down instance policy
DownInstancePolicy - Class in org.apache.curator.x.discovery: Abstraction for values that determine when an instance is down
DownInstancePolicy() - Constructor for class org.apache.curator.x.discovery.DownInstancePolicy: Policy with default values
DownInstancePolicy(long, TimeUnit, int) - Constructor for class org.apache.curator.x.discovery.DownInstancePolicy
DYNAMIC - Enum constant in enum org.apache.curator.x.discovery.ServiceType
DYNAMIC_SEQUENTIAL - Enum constant in enum org.apache.curator.x.discovery.ServiceType

E

enabled(boolean) - Method in class org.apache.curator.x.discovery.ServiceInstanceBuilder
equals(Object) - Method in class org.apache.curator.x.discovery.ServiceInstance
equals(Object) - Method in class org.apache.curator.x.discovery.UriSpec
equals(Object) - Method in class org.apache.curator.x.discovery.UriSpec.Part
executorService(ExecutorService) - Method in interface org.apache.curator.x.discovery.ServiceCacheBuilder: Optional ExecutorService to use for the cache's background thread.
executorService(ExecutorService) - Method in interface org.apache.curator.x.discovery.ServiceProviderBuilder: Optional ExecutorService to use for the cache's background thread.

F

FIELD_ADDRESS - Static variable in class org.apache.curator.x.discovery.UriSpec: If a ServiceInstance is passed when building, the replacement is ServiceInstance.getAddress()
FIELD_CLOSE_BRACE - Static variable in class org.apache.curator.x.discovery.UriSpec: Always replaced with '}' - i.e.
FIELD_ID - Static variable in class org.apache.curator.x.discovery.UriSpec: If a ServiceInstance is passed when building, the replacement is ServiceInstance.getId()
FIELD_NAME - Static variable in class org.apache.curator.x.discovery.UriSpec: If a ServiceInstance is passed when building, the replacement is ServiceInstance.getName()
FIELD_OPEN_BRACE - Static variable in class org.apache.curator.x.discovery.UriSpec: Always replaced with '{' - i.e.
FIELD_PORT - Static variable in class org.apache.curator.x.discovery.UriSpec: If a ServiceInstance is passed when building, the replacement is ServiceInstance.getPort()
FIELD_REGISTRATION_TIME_UTC - Static variable in class org.apache.curator.x.discovery.UriSpec: If a ServiceInstance is passed when building, the replacement is ServiceInstance.getRegistrationTimeUTC()
FIELD_SCHEME - Static variable in class org.apache.curator.x.discovery.UriSpec: This defaults to "http".
FIELD_SERVICE_TYPE - Static variable in class org.apache.curator.x.discovery.UriSpec: If a ServiceInstance is passed when building, the replacement is ServiceInstance.getServiceType()
FIELD_SSL_PORT - Static variable in class org.apache.curator.x.discovery.UriSpec: If a ServiceInstance is passed when building, the replacement is ServiceInstance.getSslPort()

G

getAddress() - Method in class org.apache.curator.x.discovery.ServiceInstance
getAllInstances() - Method in class org.apache.curator.x.discovery.details.ServiceProviderImpl: Return the current available set of instances IMPORTANT: users should not hold on to the instance returned.
getAllInstances() - Method in interface org.apache.curator.x.discovery.ServiceProvider: Return the current available set of instances IMPORTANT: users should not hold on to the instance returned.
getAllLocalIPs() - Static method in class org.apache.curator.x.discovery.ServiceInstanceBuilder: based on http://pastebin.com/5X073pUc
getBasePath() - Method in class org.apache.curator.x.discovery.details.DiscoveryPathConstructorImpl
getBasePath() - Method in interface org.apache.curator.x.discovery.DiscoveryPathConstructor: Return the parent path where all service names registered.
getErrorThreshold() - Method in class org.apache.curator.x.discovery.DownInstancePolicy
getId() - Method in class org.apache.curator.x.discovery.ServiceInstance
getInstance() - Method in class org.apache.curator.x.discovery.details.ServiceProviderImpl: Return an instance for a single use.
getInstance() - Method in interface org.apache.curator.x.discovery.ServiceProvider: Return an instance for a single use.
getInstance(InstanceProvider<T>) - Method in interface org.apache.curator.x.discovery.ProviderStrategy: Given a source of instances, return one of them for a single use.
getInstance(InstanceProvider<T>) - Method in class org.apache.curator.x.discovery.strategies.RandomStrategy
getInstance(InstanceProvider<T>) - Method in class org.apache.curator.x.discovery.strategies.RoundRobinStrategy
getInstance(InstanceProvider<T>) - Method in class org.apache.curator.x.discovery.strategies.StickyStrategy
getInstanceNumber() - Method in class org.apache.curator.x.discovery.strategies.StickyStrategy: Each time a new instance is picked, an internal counter is incremented.
getInstances() - Method in interface org.apache.curator.x.discovery.details.InstanceProvider: Return the current available set of instances
getInstances() - Method in class org.apache.curator.x.discovery.details.ServiceCacheImpl
getInstances() - Method in interface org.apache.curator.x.discovery.ServiceCache: Return the current list of instances.
getLocalIpFilter() - Static method in class org.apache.curator.x.discovery.ServiceInstanceBuilder: Return the current local ip filter used by ServiceInstanceBuilder.getAllLocalIPs()
getName() - Method in class org.apache.curator.x.discovery.ServiceInstance
getParts() - Method in class org.apache.curator.x.discovery.UriSpec
getPathForInstances(String) - Method in class org.apache.curator.x.discovery.details.DiscoveryPathConstructorImpl
getPathForInstances(String) - Method in interface org.apache.curator.x.discovery.DiscoveryPathConstructor: Return the parent path where all instances of the service registered.
getPayload() - Method in class org.apache.curator.x.discovery.ServiceInstance
getPort() - Method in class org.apache.curator.x.discovery.ServiceInstance
getRegistrationTimeUTC() - Method in class org.apache.curator.x.discovery.ServiceInstance
getServiceType() - Method in class org.apache.curator.x.discovery.ServiceInstance
getSslPort() - Method in class org.apache.curator.x.discovery.ServiceInstance
getTimeoutMs() - Method in class org.apache.curator.x.discovery.DownInstancePolicy
getUriSpec() - Method in class org.apache.curator.x.discovery.ServiceInstance
getValue() - Method in class org.apache.curator.x.discovery.UriSpec.Part

H

hashCode() - Method in class org.apache.curator.x.discovery.ServiceInstance
hashCode() - Method in class org.apache.curator.x.discovery.UriSpec
hashCode() - Method in class org.apache.curator.x.discovery.UriSpec.Part

I

id(String) - Method in class org.apache.curator.x.discovery.ServiceInstanceBuilder
InstanceFilter<T> - Interface in org.apache.curator.x.discovery: Typedef for an Instance predicate
InstanceProvider<T> - Interface in org.apache.curator.x.discovery.details: Provides a set of available instances for a service so that a strategy can pick one of them
InstanceSerializer<T> - Interface in org.apache.curator.x.discovery.details: Injectable serializer for service instances
internalRegisterService(ServiceInstance<T>) - Method in class org.apache.curator.x.discovery.details.ServiceDiscoveryImpl
isDynamic() - Method in enum org.apache.curator.x.discovery.ServiceType
isEnabled() - Method in class org.apache.curator.x.discovery.ServiceInstance: IMPORTANT: Due to CURATOR-275 the enabled field is NOT supported by default.
isVariable() - Method in class org.apache.curator.x.discovery.UriSpec.Part
iterator() - Method in class org.apache.curator.x.discovery.UriSpec

J

JsonInstanceSerializer<T> - Class in org.apache.curator.x.discovery.details: A serializer that uses Jackson to serialize/deserialize as JSON.
JsonInstanceSerializer(Class<T>) - Constructor for class org.apache.curator.x.discovery.details.JsonInstanceSerializer: CURATOR-275 introduced a new field into ServiceInstance.
JsonInstanceSerializer(Class<T>, boolean) - Constructor for class org.apache.curator.x.discovery.details.JsonInstanceSerializer: CURATOR-275 introduced a new field into ServiceInstance.

L

LocalIpFilter - Interface in org.apache.curator.x.discovery

N

name(String) - Method in interface org.apache.curator.x.discovery.ServiceCacheBuilder: The name of the service to cache (required)
name(String) - Method in class org.apache.curator.x.discovery.ServiceInstanceBuilder
noteError(ServiceInstance<T>) - Method in class org.apache.curator.x.discovery.details.ServiceProviderImpl
noteError(ServiceInstance<T>) - Method in interface org.apache.curator.x.discovery.ServiceProvider: Take note of an error connecting to the given instance.

O

org.apache.curator.x.discovery - package org.apache.curator.x.discovery
org.apache.curator.x.discovery.details - package org.apache.curator.x.discovery.details
org.apache.curator.x.discovery.strategies - package org.apache.curator.x.discovery.strategies

P

Part() - Constructor for class org.apache.curator.x.discovery.UriSpec.Part
Part(String, boolean) - Constructor for class org.apache.curator.x.discovery.UriSpec.Part
pathConstructor(DiscoveryPathConstructor) - Method in class org.apache.curator.x.discovery.ServiceDiscoveryBuilder: Required - shape the service tree in ZK, see ServiceDiscoveryBuilder.basePath(String) for alternative
payload(T) - Method in class org.apache.curator.x.discovery.ServiceInstanceBuilder
PERMANENT - Enum constant in enum org.apache.curator.x.discovery.ServiceType
port(int) - Method in class org.apache.curator.x.discovery.ServiceInstanceBuilder
providerStrategy(ProviderStrategy<T>) - Method in interface org.apache.curator.x.discovery.ServiceProviderBuilder: optional - set the provider strategy.
ProviderStrategy<T> - Interface in org.apache.curator.x.discovery: A strategy for picking one from a set of instances

Q

queryForInstance(String, String) - Method in class org.apache.curator.x.discovery.details.ServiceDiscoveryImpl: Return a service instance POJO
queryForInstance(String, String) - Method in interface org.apache.curator.x.discovery.ServiceDiscovery: Return a service instance POJO
queryForInstances(String) - Method in class org.apache.curator.x.discovery.details.ServiceDiscoveryImpl: Return all known instances for the given service
queryForInstances(String) - Method in interface org.apache.curator.x.discovery.ServiceDiscovery: Return all known instances for the given service
queryForNames() - Method in class org.apache.curator.x.discovery.details.ServiceDiscoveryImpl: Return the names of all known services
queryForNames() - Method in interface org.apache.curator.x.discovery.ServiceDiscovery: Return the names of all known services

R

RandomStrategy<T> - Class in org.apache.curator.x.discovery.strategies: This strategy always picks a random instance from the list
RandomStrategy() - Constructor for class org.apache.curator.x.discovery.strategies.RandomStrategy
registerService(ServiceInstance<T>) - Method in class org.apache.curator.x.discovery.details.ServiceDiscoveryImpl: Register/re-register/update a service instance
registerService(ServiceInstance<T>) - Method in interface org.apache.curator.x.discovery.ServiceDiscovery: Register/re-register a service
registrationTimeUTC(long) - Method in class org.apache.curator.x.discovery.ServiceInstanceBuilder
remove(UriSpec.Part) - Method in class org.apache.curator.x.discovery.UriSpec: Remove the given part
removeListener(ServiceCacheListener) - Method in class org.apache.curator.x.discovery.details.ServiceCacheImpl
RoundRobinStrategy<T> - Class in org.apache.curator.x.discovery.strategies: This strategy rotates sequentially through the list of instances
RoundRobinStrategy() - Constructor for class org.apache.curator.x.discovery.strategies.RoundRobinStrategy

S

serialize(ServiceInstance<T>) - Method in interface org.apache.curator.x.discovery.details.InstanceSerializer: Serialize an instance into bytes
serialize(ServiceInstance<T>) - Method in class org.apache.curator.x.discovery.details.JsonInstanceSerializer
serializer(InstanceSerializer<T>) - Method in class org.apache.curator.x.discovery.ServiceDiscoveryBuilder: optional - change the serializer used (the default is JsonInstanceSerializer
ServiceCache<T> - Interface in org.apache.curator.x.discovery
serviceCacheBuilder() - Method in class org.apache.curator.x.discovery.details.ServiceDiscoveryImpl: Allocate a new service cache builder.
serviceCacheBuilder() - Method in interface org.apache.curator.x.discovery.ServiceDiscovery: Allocate a new service cache builder.
ServiceCacheBuilder<T> - Interface in org.apache.curator.x.discovery
ServiceCacheImpl<T> - Class in org.apache.curator.x.discovery.details
ServiceCacheListener - Interface in org.apache.curator.x.discovery.details: Listener for changes to a service cache
ServiceDiscovery<T> - Interface in org.apache.curator.x.discovery
ServiceDiscoveryBuilder<T> - Class in org.apache.curator.x.discovery
ServiceDiscoveryImpl<T> - Class in org.apache.curator.x.discovery.details: A mechanism to register and query service instances using ZooKeeper
ServiceDiscoveryImpl(CuratorFramework, String, InstanceSerializer<T>, ServiceInstance<T>, boolean) - Constructor for class org.apache.curator.x.discovery.details.ServiceDiscoveryImpl
ServiceDiscoveryImpl(CuratorFramework, DiscoveryPathConstructor, InstanceSerializer<T>, ServiceInstance<T>, boolean) - Constructor for class org.apache.curator.x.discovery.details.ServiceDiscoveryImpl
ServiceInstance<T> - Class in org.apache.curator.x.discovery: POJO that represents a service instance
ServiceInstance(String, String, String, Integer, Integer, T, long, ServiceType, UriSpec) - Constructor for class org.apache.curator.x.discovery.ServiceInstance
ServiceInstance(String, String, String, Integer, Integer, T, long, ServiceType, UriSpec, boolean) - Constructor for class org.apache.curator.x.discovery.ServiceInstance: IMPORTANT: Due to CURATOR-275 the enabled field is NOT supported by default.
ServiceInstanceBuilder<T> - Class in org.apache.curator.x.discovery: Builder for service instances
serviceName(String) - Method in interface org.apache.curator.x.discovery.ServiceProviderBuilder: required - set the name of the service to be provided
ServiceProvider<T> - Interface in org.apache.curator.x.discovery: The main API for Discovery.
serviceProviderBuilder() - Method in class org.apache.curator.x.discovery.details.ServiceDiscoveryImpl: Allocate a new builder.
serviceProviderBuilder() - Method in interface org.apache.curator.x.discovery.ServiceDiscovery: Allocate a new builder.
ServiceProviderBuilder<T> - Interface in org.apache.curator.x.discovery
ServiceProviderImpl<T> - Class in org.apache.curator.x.discovery.details: The main interface for Service Discovery.
ServiceProviderImpl(ServiceDiscoveryImpl<T>, String, ProviderStrategy<T>, ThreadFactory, ExecutorService, List<InstanceFilter<T>>, DownInstancePolicy) - Constructor for class org.apache.curator.x.discovery.details.ServiceProviderImpl
ServiceProviderImpl(ServiceDiscoveryImpl<T>, String, ProviderStrategy<T>, ThreadFactory, List<InstanceFilter<T>>, DownInstancePolicy) - Constructor for class org.apache.curator.x.discovery.details.ServiceProviderImpl
serviceType(ServiceType) - Method in class org.apache.curator.x.discovery.ServiceInstanceBuilder
ServiceType - Enum in org.apache.curator.x.discovery
setLocalIpFilter(LocalIpFilter) - Static method in class org.apache.curator.x.discovery.ServiceInstanceBuilder: Replace the default local ip filter used by ServiceInstanceBuilder.getAllLocalIPs()
sslPort(int) - Method in class org.apache.curator.x.discovery.ServiceInstanceBuilder
start() - Method in class org.apache.curator.x.discovery.details.ServiceCacheImpl
start() - Method in class org.apache.curator.x.discovery.details.ServiceDiscoveryImpl: The discovery must be started before use
start() - Method in class org.apache.curator.x.discovery.details.ServiceProviderImpl: The provider must be started before use
start() - Method in interface org.apache.curator.x.discovery.ServiceCache: The cache must be started before use
start() - Method in interface org.apache.curator.x.discovery.ServiceDiscovery: The discovery must be started before use
start() - Method in interface org.apache.curator.x.discovery.ServiceProvider: The provider must be started before use
startImmediate() - Method in class org.apache.curator.x.discovery.details.ServiceCacheImpl
startImmediate() - Method in interface org.apache.curator.x.discovery.ServiceCache
STATIC - Enum constant in enum org.apache.curator.x.discovery.ServiceType
StickyStrategy<T> - Class in org.apache.curator.x.discovery.strategies: This strategy uses a master strategy to pick the initial instance.
StickyStrategy(ProviderStrategy<T>) - Constructor for class org.apache.curator.x.discovery.strategies.StickyStrategy

T

thisInstance(ServiceInstance<T>) - Method in class org.apache.curator.x.discovery.ServiceDiscoveryBuilder: Optional - instance that represents the service that is running.
threadFactory(ThreadFactory) - Method in interface org.apache.curator.x.discovery.ServiceCacheBuilder: Deprecated.
use ServiceCacheBuilder.executorService(ExecutorService) instead
threadFactory(ThreadFactory) - Method in interface org.apache.curator.x.discovery.ServiceProviderBuilder: Deprecated.
use ServiceProviderBuilder.executorService(ExecutorService) instead
toString() - Method in class org.apache.curator.x.discovery.ServiceInstance

U

unregisterService(ServiceInstance<T>) - Method in class org.apache.curator.x.discovery.details.ServiceDiscoveryImpl: Unregister/remove a service instance
unregisterService(ServiceInstance<T>) - Method in interface org.apache.curator.x.discovery.ServiceDiscovery: Unregister/remove a service instance
updateService(ServiceInstance<T>) - Method in class org.apache.curator.x.discovery.details.ServiceDiscoveryImpl
updateService(ServiceInstance<T>) - Method in interface org.apache.curator.x.discovery.ServiceDiscovery: Update a service
uriSpec(UriSpec) - Method in class org.apache.curator.x.discovery.ServiceInstanceBuilder
UriSpec - Class in org.apache.curator.x.discovery: An abstraction for specifying a URI for an instance allowing for variable substitutions.
UriSpec() - Constructor for class org.apache.curator.x.discovery.UriSpec
UriSpec(String) - Constructor for class org.apache.curator.x.discovery.UriSpec
UriSpec.Part - Class in org.apache.curator.x.discovery: Represents one token in the Uri spec
use(NetworkInterface, InetAddress) - Method in interface org.apache.curator.x.discovery.LocalIpFilter

V

valueOf(String) - Static method in enum org.apache.curator.x.discovery.ServiceType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.curator.x.discovery.ServiceType: Returns an array containing the constants of this enum type, in the order they are declared.

W

watchInstances(boolean) - Method in class org.apache.curator.x.discovery.ServiceDiscoveryBuilder: Optional - if true, watches for changes to locally registered instances (via ServiceDiscoveryBuilder.thisInstance(ServiceInstance) or ServiceDiscovery.registerService(ServiceInstance)).

A B C D E F G H I J L N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values