@Stability.Volatile public class Core extends Object
This class has been around behind a facade in the 1.x days, but here it is just a plain simple class that can be instantiated and is used across the upper language bindings.
Modifier | Constructor and Description |
---|---|
protected |
Core(CoreEnvironment environment,
Authenticator authenticator,
Set<SeedNode> seedNodes)
Creates a new Core.
|
Modifier and Type | Method and Description |
---|---|
ClusterConfig |
clusterConfig()
This API provides access to the current config that is published throughout the core.
|
ConfigurationProvider |
configurationProvider()
Returns the attached configuration provider.
|
CoreContext |
context()
Returns the
CoreContext of this core instance. |
static Core |
create(CoreEnvironment environment,
Authenticator authenticator,
Set<SeedNode> seedNodes)
Creates a new
Core with the given environment. |
protected Node |
createNode(NodeIdentifier identifier,
Optional<String> alternateAddress)
Create a
Node from 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.
|
void |
initGlobalConfig()
Instructs the client to, if possible, load and initialize the global config.
|
void |
openBucket(String name)
Attempts to open a bucket and fails the
Mono if there is a persistent error
as the reason. |
<R extends Response> |
send(Request<R> request)
Sends a command into the core layer and registers the request with the timeout timer.
|
<R extends Response> |
send(Request<R> request,
boolean registerForTimeout)
Sends a command into the core layer and allows to avoid timeout registration.
|
Mono<Void> |
shutdown() |
Mono<Void> |
shutdown(Duration timeout)
Shuts down this core and all associated, owned resources.
|
protected Core(CoreEnvironment environment, Authenticator authenticator, Set<SeedNode> seedNodes)
environment
- the environment for this core.public static Core create(CoreEnvironment environment, Authenticator authenticator, Set<SeedNode> seedNodes)
Core
with the given environment.environment
- the environment for this core.Core
.@Stability.Internal public ConfigurationProvider configurationProvider()
Internal API, use with care!
public <R extends Response> void send(Request<R> request)
request
- the request to dispatch.@Stability.Internal public <R extends Response> void send(Request<R> request, boolean registerForTimeout)
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.
request
- the request to dispatch.registerForTimeout
- if the request should be registered with a timeout.public CoreContext context()
CoreContext
of this core instance.@Stability.Internal public Stream<EndpointDiagnostics> diagnostics()
@Stability.Internal public void initGlobalConfig()
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.
@Stability.Internal public void openBucket(String name)
Mono
if there is a persistent error
as the reason.@Stability.Internal public ClusterConfig clusterConfig()
Note that this is internal API and might change at any time.
@Stability.Internal public Mono<Void> ensureServiceAt(NodeIdentifier identifier, ServiceType serviceType, int port, Optional<String> bucket, Optional<String> alternateAddress)
This is advanced, internal functionality and should only be used if the caller knows what they are doing.
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.Mono
which completes once initiated.protected Node createNode(NodeIdentifier identifier, Optional<String> alternateAddress)
Node
from the given identifier.
This method is here so it can be overridden in tests.
identifier
- the identifier for the node.alternateAddress
- the alternate address if present.@Stability.Internal public Mono<Void> shutdown()
@Stability.Internal public Mono<Void> shutdown(Duration timeout)
Copyright © 2020 Couchbase, Inc.. All rights reserved.