storm-client/src/jvm/org/apache/storm/messaging/netty/SaslMessageToken.java

/**
 * 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
 *
 * 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 org.apache.storm.messaging.netty;

import org.apache.storm.shade.io.netty.buffer.ByteBuf;
import org.apache.storm.shade.io.netty.buffer.Unpooled;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Send and receive SASL tokens.
 */
public class SaslMessageToken implements INettySerializable {
    public static final short IDENTIFIER = -500;
    private static final Logger LOG = LoggerFactory.getLogger(SaslMessageToken.class);

    /**
     * Used for client or server's token to send or receive from each other.
     */
    private byte[] token;

    /**
     * Constructor used for reflection only.
     */
    public SaslMessageToken() {
    }

    /**
     * Constructor used to send request.
     *
     * @param token the SASL token, generated by a SaslClient or SaslServer.
     */
    public SaslMessageToken(byte[] token) {
        this.token = token;
    }

    public static SaslMessageToken read(byte[] serial) {
        ByteBuf smBuffer = Unpooled.wrappedBuffer(serial);
        try {
            short identifier = smBuffer.readShort();
            int payloadLen = smBuffer.readInt();
            if (identifier != IDENTIFIER) {
                return null;
            }
            byte[] token = new byte[payloadLen];
            smBuffer.readBytes(token, 0, payloadLen);
            return new SaslMessageToken(token);
        } finally {
            smBuffer.release();
        }
    }

    /**
     * Read accessor for SASL token.
     *
     * @return saslToken SASL token
     */
    public byte[] getSaslToken() {
        return token;
    }

    /**
     * Write accessor for SASL token.
     *
     * @param token SASL token
     */
    public void setSaslToken(byte[] token) {
        this.token = token;
    }

    @Override
    public int encodeLength() {
        return 2 + 4 + token.length;
    }

    /**
     * encode the current SaslToken Message into a ByteBuf.
     * 
     * <p>SaslTokenMessageRequest is encoded as: identifier .... short(2) payload
     * length .... int payload .... byte[]
     */
    @Override
    public void write(ByteBuf dest) {
        int payloadLen = 0;
        if (token != null) {
            payloadLen = token.length;
        }

        dest.writeShort(IDENTIFIER);
        dest.writeInt(payloadLen);

        if (payloadLen > 0) {
            dest.writeBytes(token);
        }
    }
}