com.couchbase.client.core.endpoint.KeyValueEndpoint Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of core-io Show documentation
Show all versions of core-io Show documentation
The official Couchbase JVM Core IO Library
/*
* Copyright (c) 2018 Couchbase, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.couchbase.client.core.endpoint;
import com.couchbase.client.core.deps.io.netty.channel.ChannelPipeline;
import com.couchbase.client.core.deps.io.netty.handler.flush.FlushConsolidationHandler;
import com.couchbase.client.core.env.Authenticator;
import com.couchbase.client.core.io.netty.TrafficCaptureHandler;
import com.couchbase.client.core.io.netty.kv.ErrorMapLoadingHandler;
import com.couchbase.client.core.io.netty.kv.FeatureNegotiatingHandler;
import com.couchbase.client.core.io.netty.kv.KeyValueMessageHandler;
import com.couchbase.client.core.io.netty.kv.MemcacheProtocolDecodeHandler;
import com.couchbase.client.core.io.netty.kv.MemcacheProtocolVerificationHandler;
import com.couchbase.client.core.io.netty.kv.SelectBucketHandler;
import com.couchbase.client.core.io.netty.kv.ServerFeature;
import com.couchbase.client.core.io.netty.kv.ServerPushHandler;
import com.couchbase.client.core.service.ServiceContext;
import com.couchbase.client.core.service.ServiceType;
import java.util.EnumSet;
import java.util.Optional;
import java.util.Set;
public class KeyValueEndpoint extends BaseEndpoint {
private final Optional bucketname;
private final Authenticator authenticator;
private static final int FLUSH_CONSOLIDATION_LIMIT = Integer.parseInt(System.getProperty(
"com.couchbase.experimental.flushConsolidationLimit",
Integer.toString(FlushConsolidationHandler.DEFAULT_EXPLICIT_FLUSH_AFTER_FLUSHES)
));
public KeyValueEndpoint(final ServiceContext ctx, final String hostname,
final int port, final Optional bucketname, final Authenticator authenticator) {
super(hostname, port, ctx.environment().ioEnvironment().kvEventLoopGroup().get(),
ctx, ctx.environment().ioConfig().kvCircuitBreakerConfig(), ServiceType.KV, true);
this.authenticator = authenticator;
this.bucketname = bucketname;
}
@Override
protected PipelineInitializer pipelineInitializer() {
return new KeyValuePipelineInitializer(context(), bucketname, authenticator);
}
public static class KeyValuePipelineInitializer implements PipelineInitializer {
private final EndpointContext ctx;
private final Optional bucketname;
private final Authenticator authenticator;
public KeyValuePipelineInitializer(EndpointContext ctx, Optional bucketname, Authenticator authenticator) {
this.ctx = ctx;
this.authenticator = authenticator;
this.bucketname = bucketname;
}
@Override
public void init(BaseEndpoint endpoint, ChannelPipeline pipeline) {
if (FLUSH_CONSOLIDATION_LIMIT > 0) {
pipeline.addLast(new FlushConsolidationHandler(FLUSH_CONSOLIDATION_LIMIT, true));
}
if (pipeline.get(TrafficCaptureHandler.class) != null) {
pipeline.addBefore(
TrafficCaptureHandler.class.getName(),
MemcacheProtocolDecodeHandler.class.getName(),
new MemcacheProtocolDecodeHandler()
);
} else {
pipeline.addLast(
MemcacheProtocolDecodeHandler.class.getName(),
new MemcacheProtocolDecodeHandler()
);
}
pipeline.addAfter(
MemcacheProtocolDecodeHandler.class.getName(),
MemcacheProtocolVerificationHandler.class.getName(),
new MemcacheProtocolVerificationHandler(ctx)
);
// Server push handler must come before handshake handlers, because handshake handlers
// can't tolerate being interrupted by a server push request (such as a clustermap change notification).
pipeline.addLast(new ServerPushHandler(ctx));
pipeline.addLast(new FeatureNegotiatingHandler(ctx, serverFeatures()));
pipeline.addLast(new ErrorMapLoadingHandler(ctx));
authenticator.authKeyValueConnection(ctx, pipeline);
bucketname.ifPresent(s -> pipeline.addLast(new SelectBucketHandler(ctx, s)));
pipeline.addLast(new KeyValueMessageHandler(endpoint, ctx, bucketname));
}
/**
* Returns the server features that should be negotiated.
*
* @return the server features to negotiate.
*/
private Set serverFeatures() {
Set features = EnumSet.of(
ServerFeature.SELECT_BUCKET,
ServerFeature.XATTR,
ServerFeature.XERROR,
ServerFeature.ALT_REQUEST,
ServerFeature.SYNC_REPLICATION,
ServerFeature.COLLECTIONS,
ServerFeature.TRACING,
ServerFeature.PRESERVE_TTL,
ServerFeature.JSON,
ServerFeature.SUBDOC_READ_REPLICA,
ServerFeature.GET_CLUSTER_CONFIG_WITH_KNOWN_VERSION,
ServerFeature.DUPLEX,
ServerFeature.CLUSTERMAP_CHANGE_NOTIFICATION_BRIEF
);
if (ctx.environment().ioConfig().mutationTokensEnabled()) {
features.add(ServerFeature.MUTATION_SEQNO);
}
if (ctx.environment().compressionConfig().enabled()) {
features.add(ServerFeature.SNAPPY);
features.add(ServerFeature.SNAPPY_EVERYWHERE);
}
boolean unorderedExecutionEnabled = Boolean.parseBoolean(
System.getProperty("com.couchbase.unorderedExecutionEnabled", "true")
);
if (unorderedExecutionEnabled) {
features.add(ServerFeature.UNORDERED_EXECUTION);
}
boolean vattrEnabled = Boolean.parseBoolean(
System.getProperty("com.couchbase.vattrEnabled", "true")
);
if (vattrEnabled) {
features.add(ServerFeature.VATTR);
}
boolean createAsDeletedEnabled = Boolean.parseBoolean(
System.getProperty("com.couchbase.createAsDeletedEnabled", "true")
);
if (createAsDeletedEnabled) {
features.add(ServerFeature.CREATE_AS_DELETED);
}
boolean reportUnitUsageEnabled = Boolean.parseBoolean(
System.getProperty("com.couchbase.reportUnitUsageEnabled", "true")
);
if (reportUnitUsageEnabled) {
features.add(ServerFeature.REPORT_UNIT_USAGE);
}
return features;
}
}
}