io.helidon.grpc.core.ContextKeys Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of helidon-grpc-core Show documentation

The newest version!

/*
 * Copyright (c) 2019, 2024 Oracle and/or its affiliates.
 *
 * 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 io.helidon.grpc.core;

import java.lang.reflect.Method;

import io.grpc.Context;
import io.grpc.Metadata;

/**
 * A collection of common gRPC {@link Context.Key} and
 * {@link Metadata.Key} instances.
 */
public final class ContextKeys {
    /**
     * The {@link Metadata.Key} to use to obtain the authorization data.
     */
    public static final Metadata.Key AUTHORIZATION =
            Metadata.Key.of("Authorization", Metadata.ASCII_STRING_MARSHALLER);

    /**
     * The gRPC context key to use to obtain the Helidon {@link io.helidon.common.context.Context}
     * from the gRPC {@link Context}.
     */
    public static final Context.Key HELIDON_CONTEXT =
            Context.key(io.helidon.common.context.Context.class.getCanonicalName());

    /**
     * The {@link Context.Key} to use to obtain the actual underlying rpc {@link Method}.
     */
    public static final Context.Key SERVICE_METHOD = Context.key(Method.class.getName());

    /**
     * Private constructor for utility class.
     */
    private ContextKeys() {
    }
}