• Home
• it.bz.opendatahub.alpinebits
• alpinebits-common-api
• 3.0.0
• source code
• RequestContextKey.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

it.bz.opendatahub.alpinebits.common.context.RequestContextKey Maven / Gradle / Ivy

// SPDX-FileCopyrightText: NOI Techpark 
//
// SPDX-License-Identifier: MPL-2.0

/*
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

package it.bz.opendatahub.alpinebits.common.context;

import it.bz.opendatahub.alpinebits.middleware.Key;

import java.io.InputStream;
import java.util.function.Supplier;

/**
 * This class contains key definitions, that may be used e.g. in a middleware context.
 */
public final class RequestContextKey {

    /**
     * Context key for request ID.
     */
    public static final Key REQUEST_ID = Key.key(
            "request.id", String.class
    );

    /**
     * Context key for username.
     */
    public static final Key REQUEST_USERNAME = Key.key(
            "request.username", String.class
    );

    /**
     * Context key for password. The {@link Supplier} type of this key represents
     * the intent to not store the password as String in the context, since this
     * could have security implications, e.g. if the context is logged somewhere.
     * Instead, the password is wrapped with a {@link Supplier}.
     */
    public static final Key REQUEST_PASSWORD_SUPPLIER = Key.key(
            "request.password.supplier", Supplier.class
    );

    /**
     * Context key for AlpineBits version.
     */
    public static final Key REQUEST_VERSION = Key.key(
            "request.version", String.class
    );

    /**
     * Context key for AlpineBits action.
     */
    public static final Key REQUEST_ACTION = Key.key(
            "request.action", String.class
    );

    /**
     * Context key for AlpineBits request content as an InputStream, i.e. the XML as stream.
     */
    public static final Key REQUEST_CONTENT_STREAM = Key.key(
            "request.content.stream", InputStream.class
    );

    private RequestContextKey() {
        // Empty
    }

}