Package com.couchbase.client.core
Class Core
- java.lang.Object
-
- com.couchbase.client.core.Core
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedCore(CoreEnvironment environment, Authenticator authenticator, Set<SeedNode> seedNodes)Creates a new Core.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ClusterConfigclusterConfig()This API provides access to the current config that is published throughout the core.ConfigurationProviderconfigurationProvider()Returns the attached configuration provider.CoreContextcontext()Returns theCoreContextof this core instance.static Corecreate(CoreEnvironment environment, Authenticator authenticator, Set<SeedNode> seedNodes)Creates a newCorewith the given environment.protected NodecreateNode(NodeIdentifier identifier, Optional<String> alternateAddress)Create aNodefrom the given identifier.Stream<EndpointDiagnostics>diagnostics()Mono<Void>ensureServiceAt(NodeIdentifier identifier, ServiceType serviceType, int port, Optional<String> bucket, Optional<String> alternateAddress)This method can be used by a caller to make sure a certain service is enabled at the given target node.CoreHttpClienthttpClient(RequestTarget target)Returns a client for issuing HTTP requests to servers in the cluster.voidinitGlobalConfig()Instructs the client to, if possible, load and initialize the global config.voidopenBucket(String name)Attempts to open a bucket and fails theMonoif there is a persistent error as the reason.ValueRecorderresponseMetric(Request<?> request)<R extends Response>
voidsend(Request<R> request)Sends a command into the core layer and registers the request with the timeout timer.<R extends Response>
voidsend(Request<R> request, boolean registerForTimeout)Sends a command into the core layer and allows to avoid timeout registration.Optional<Flux<ServiceState>>serviceState(NodeIdentifier nodeIdentifier, ServiceType type, Optional<String> bucket)If present, returns a flux that allows to monitor the state changes of a specific service.Mono<Void>shutdown()Mono<Void>shutdown(Duration timeout)Shuts down this core and all associated, owned resources.
-
-
-
Constructor Detail
-
Core
protected Core(CoreEnvironment environment, Authenticator authenticator, Set<SeedNode> seedNodes)
Creates a new Core.- Parameters:
environment- the environment for this core.
-
-
Method Detail
-
create
public static Core create(CoreEnvironment environment, Authenticator authenticator, Set<SeedNode> seedNodes)
Creates a newCorewith the given environment.- Parameters:
environment- the environment for this core.- Returns:
- the created
Core.
-
configurationProvider
@Internal public ConfigurationProvider configurationProvider()
Returns the attached configuration provider.Internal API, use with care!
-
send
public <R extends Response> void send(Request<R> request)
Sends a command into the core layer and registers the request with the timeout timer.- Parameters:
request- the request to dispatch.
-
send
@Internal public <R extends Response> void send(Request<R> request, boolean registerForTimeout)
Sends a command into the core layer and allows to avoid timeout registration.Usually you want to use
send(Request)instead, this method should only be used during retry situations where the request has already been registered with a timeout timer before.- Parameters:
request- the request to dispatch.registerForTimeout- if the request should be registered with a timeout.
-
context
public CoreContext context()
Returns theCoreContextof this core instance.
-
httpClient
@Internal public CoreHttpClient httpClient(RequestTarget target)
Returns a client for issuing HTTP requests to servers in the cluster.
-
diagnostics
@Internal public Stream<EndpointDiagnostics> diagnostics()
-
serviceState
@Internal public Optional<Flux<ServiceState>> serviceState(NodeIdentifier nodeIdentifier, ServiceType type, Optional<String> bucket)
If present, returns a flux that allows to monitor the state changes of a specific service.- Parameters:
nodeIdentifier- the node identifier for the node.type- the type of service.bucket- the bucket, if present.- Returns:
- if found, a flux with the service states.
-
initGlobalConfig
@Internal public void initGlobalConfig()
Instructs the client to, if possible, load and initialize the global config.Since global configs are an "optional" feature depending on the cluster version, if an error happens this method will not fail. Rather it will log the exception (with some logic dependent on the type of error) and will allow the higher level components to move on where possible.
-
openBucket
@Internal public void openBucket(String name)
Attempts to open a bucket and fails theMonoif there is a persistent error as the reason.
-
clusterConfig
@Internal public ClusterConfig clusterConfig()
This API provides access to the current config that is published throughout the core.Note that this is internal API and might change at any time.
-
ensureServiceAt
@Internal public Mono<Void> ensureServiceAt(NodeIdentifier identifier, ServiceType serviceType, int port, Optional<String> bucket, Optional<String> alternateAddress)
This method can be used by a caller to make sure a certain service is enabled at the given target node.This is advanced, internal functionality and should only be used if the caller knows what they are doing.
- Parameters:
identifier- the node to check.serviceType- the service type to enable if not enabled already.port- the port where the service is listening on.bucket- if the service is bound to a bucket, it needs to be provided.alternateAddress- if an alternate address is present, needs to be provided since it is passed down to the node and its services.- Returns:
- a
Monowhich completes once initiated.
-
responseMetric
@Internal public ValueRecorder responseMetric(Request<?> request)
-
createNode
protected Node createNode(NodeIdentifier identifier, Optional<String> alternateAddress)
Create aNodefrom the given identifier.This method is here so it can be overridden in tests.
- Parameters:
identifier- the identifier for the node.alternateAddress- the alternate address if present.- Returns:
- the created node instance.
-
-