DomGarguilo commented on code in PR #5691: URL: https://github.com/apache/accumulo/pull/5691#discussion_r2177850964
########## core/src/main/java/org/apache/accumulo/core/rpc/AccumuloProtocolFactory.java: ########## @@ -0,0 +1,221 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 + * + * https://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 org.apache.accumulo.core.rpc; + +import org.apache.accumulo.core.Constants; +import org.apache.accumulo.core.data.InstanceId; +import org.apache.thrift.TException; +import org.apache.thrift.protocol.TCompactProtocol; +import org.apache.thrift.protocol.TMessage; +import org.apache.thrift.protocol.TProtocol; +import org.apache.thrift.transport.TTransport; + +/** + * Factory for creating instances of the AccumuloProtocol. + * <p> + * This protocol includes a custom header to ensure compatibility between different versions of the + * protocol. + */ +public class AccumuloProtocolFactory extends TCompactProtocol.Factory { + + private static final long serialVersionUID = 1L; + + private final boolean isClient; + private final InstanceId instanceId; + + public static class AccumuloProtocol extends TCompactProtocol { + + static final int MAGIC_NUMBER = 0x41434355; // "ACCU" in ASCII + static final byte PROTOCOL_VERSION = 1; + + private final boolean isClient; + private final InstanceId instanceId; + + public AccumuloProtocol(TTransport transport, InstanceId instanceId, boolean isClient) { + super(transport); + this.instanceId = instanceId; + this.isClient = isClient; + } + + /** + * For client calls, write the Accumulo protocol header before writing the message + */ + @Override + public void writeMessageBegin(TMessage message) throws TException { + if (this.isClient) { + this.writeClientHeader(); + } + super.writeMessageBegin(message); + } + + /** + * For server calls, validate the header before reading the message + */ + @Override + public TMessage readMessageBegin() throws TException { + if (!this.isClient) { + this.validateHeader(); + } + + return super.readMessageBegin(); + } + + /** + * Writes the Accumulo protocol header containing version and identification info + */ + private void writeClientHeader() throws TException { + super.writeI32(MAGIC_NUMBER); + super.writeByte(PROTOCOL_VERSION); + super.writeString(Constants.VERSION); + super.writeString(this.instanceId.canonical()); + } + + /** + * Reads and validates the Accumulo protocol header + * + * @throws TException if the header is invalid or incompatible + */ + void validateHeader() throws TException { + + final int magic; + try { + magic = super.readI32(); + } catch (TException e) { + throw new TException("Failed to read magic number from header", e); + } + if (magic != MAGIC_NUMBER) { + throw new TException("Invalid Accumulo protocol: magic number mismatch. Expected: 0x" + + Integer.toHexString(MAGIC_NUMBER) + ", got: 0x" + Integer.toHexString(magic)); + } + + final byte clientProtocolVersion; + try { + clientProtocolVersion = super.readByte(); + } catch (TException e) { + throw new TException("Failed to read protocol version from header", e); + } + validateProtocolVersion(clientProtocolVersion); + + final String clientAccumuloVersion; + try { + clientAccumuloVersion = super.readString(); + } catch (TException e) { + throw new TException("Failed to read accumulo version from header", e); + } + validateAccumuloVersion(clientAccumuloVersion); + + final String clientInstanceId; + try { + clientInstanceId = super.readString(); + } catch (TException e) { + throw new TException("Failed to read instance id from header", e); + } + validateInstanceId(clientInstanceId); + } + + /** + * @throws TException if the given protocol version is incompatible with the current version + */ + private void validateProtocolVersion(byte protocolVersion) throws TException { + if (protocolVersion != PROTOCOL_VERSION) { + throw new TException("Incompatible protocol version. Version seen: " + protocolVersion + + ", expected version: " + PROTOCOL_VERSION); + } + } + + /** + * @throws TException if the given Accumulo version (client) is incompatible with the current + * version (server) + */ + private void validateAccumuloVersion(String clientAccumuloVersion) throws TException { + final String serverAccumuloVersion = Constants.VERSION; + + // Extract major.minor version components + final String serverMajorMinor = extractMajorMinorVersion(serverAccumuloVersion); + final String clientMajorMinor = extractMajorMinorVersion(clientAccumuloVersion); + + if (!serverMajorMinor.equals(clientMajorMinor)) { Review Comment: See https://github.com/apache/accumulo/pull/5398#discussion_r2029431139 for one explanation. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@accumulo.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
