io.helidon.security.SecurityRequest Maven / Gradle / Ivy

Go to download

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

There is a newer version: 4.1.4

/*
 * Copyright (c) 2018, 2021 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.security;

import java.util.Map;
import java.util.Optional;
import java.util.function.Supplier;

import io.opentracing.SpanContext;

/**
 * Common methods for all security requests (authentication, authorization, and identity propagation).
 */
public interface SecurityRequest {
    /**
     * If true and security provider does not find required information in request/response/message, or headers, it should
     * return {@link SecurityResponse.SecurityStatus#FAILURE} without doing any side effects (e.g. should not redirect, call third
     * parties etc.).
     *
     * @return true if security is optional
     */
    default boolean isOptional() {
        return false;
    }

    /**
     * Parent span for tracing. There may be no parent defined (such as when tracing is disabled).
     *
     * @return tracing span context if available
     */
    Optional tracingSpanContext();

    /**
     * Return a map of keys to resource instances.
     * By default the mapping is under "object".
     *
     * @return a map of object keys to object instances
     */
    Map> resources();

}