com.generallycloud.baseio.codec.http2.hpack.Http2HeadersEncoder Maven / Gradle / Ivy
/*
* Copyright 2015-2017 GenerallyCloud.com
*
* 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.generallycloud.baseio.codec.http2.hpack;
import com.generallycloud.baseio.buffer.ByteBuf;
/**
* Encodes {@link Http2Headers} into HPACK-encoded headers blocks.
*/
public interface Http2HeadersEncoder {
/**
* Configuration related elements for the {@link Http2HeadersEncoder} interface
*/
interface Configuration {
/**
* Access the Http2HeaderTable for this {@link Http2HeadersEncoder}
*/
Http2HeaderTable headerTable();
}
/**
* Determine if a header name/value pair is treated as
* sensitive.
* If the object can be dynamically modified and shared across multiple connections it may need to be thread safe.
*/
interface SensitivityDetector {
/**
* Determine if a header {@code name}/{@code value} pair should be treated as
* sensitive.
* @param name The name for the header.
* @param value The value of the header.
* @return {@code true} if a header {@code name}/{@code value} pair should be treated as
* sensitive.
* {@code false} otherwise.
*/
boolean isSensitive(CharSequence name, CharSequence value);
}
/**
* Encodes the given headers and writes the output headers block to the given output buffer.
*
* @param headers the headers to be encoded.
* @param buffer the buffer to receive the encoded headers.
*/
void encodeHeaders(Http2Headers headers, ByteBuf buffer) throws Http2Exception;
/**
* Get the {@link Configuration} for this {@link Http2HeadersEncoder}
*/
Configuration configuration();
/**
* Always return {@code false} for {@link SensitivityDetector#isSensitive(CharSequence, CharSequence)}.
*/
SensitivityDetector NEVER_SENSITIVE = new SensitivityDetector() {
@Override
public boolean isSensitive(CharSequence name, CharSequence value) {
return false;
}
};
/**
* Always return {@code true} for {@link SensitivityDetector#isSensitive(CharSequence, CharSequence)}.
*/
SensitivityDetector ALWAYS_SENSITIVE = new SensitivityDetector() {
@Override
public boolean isSensitive(CharSequence name, CharSequence value) {
return true;
}
};
}