/*
 * Copyright (c) 2010, 2019 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.ws.rs.core;

import java.security.Principal;

An injectable interface that provides access to security related information.
Author:
Paul Sandoz, Marc Hadley
See Also:
Context
Since:
1.0/**
 * An injectable interface that provides access to security related information.
 *
 * @author Paul Sandoz
 * @author Marc Hadley
 * @see Context
 * @since 1.0
 */
public interface SecurityContext {

    
String identifier for Basic authentication. Value "BASIC"
/**
     * String identifier for Basic authentication. Value "BASIC"
     */
    public static final String BASIC_AUTH = "BASIC";
    
String identifier for Client Certificate authentication. Value "CLIENT_CERT"
/**
     * String identifier for Client Certificate authentication. Value "CLIENT_CERT"
     */
    public static final String CLIENT_CERT_AUTH = "CLIENT_CERT";
    
String identifier for Digest authentication. Value "DIGEST"
/**
     * String identifier for Digest authentication. Value "DIGEST"
     */
    public static final String DIGEST_AUTH = "DIGEST";
    
String identifier for Form authentication. Value "FORM"
/**
     * String identifier for Form authentication. Value "FORM"
     */
    public static final String FORM_AUTH = "FORM";

    
Returns a java.security.Principal object containing the name of the current authenticated user. If the
user has not been authenticated, the method returns null.
Throws:
IllegalStateException – if called outside the scope of a request
Returns:
a java.security.Principal containing the name of the user making this request; null if the user
has not been authenticated/**
     * Returns a <code>java.security.Principal</code> object containing the name of the current authenticated user. If the
     * user has not been authenticated, the method returns null.
     *
     * @return a <code>java.security.Principal</code> containing the name of the user making this request; null if the user
     * has not been authenticated
     * @throws java.lang.IllegalStateException if called outside the scope of a request
     */
    public Principal getUserPrincipal();

    
Returns a boolean indicating whether the authenticated user is included in the specified logical "role". If the user
has not been authenticated, the method returns false.
Params:
role – a String specifying the name of the role
Throws:
IllegalStateException – if called outside the scope of a request
Returns:
a boolean indicating whether the user making the request belongs to a given role;
false if the user has not been authenticated/**
     * Returns a boolean indicating whether the authenticated user is included in the specified logical "role". If the user
     * has not been authenticated, the method returns <code>false</code>.
     *
     * @param role a <code>String</code> specifying the name of the role
     * @return a <code>boolean</code> indicating whether the user making the request belongs to a given role;
     * <code>false</code> if the user has not been authenticated
     * @throws java.lang.IllegalStateException if called outside the scope of a request
     */
    public boolean isUserInRole(String role);

    
Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
Throws:
IllegalStateException – if called outside the scope of a request
Returns:
true if the request was made using a secure channel, false otherwise/**
     * Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
     *
     * @return <code>true</code> if the request was made using a secure channel, <code>false</code> otherwise
     * @throws java.lang.IllegalStateException if called outside the scope of a request
     */
    public boolean isSecure();

    
Returns the string value of the authentication scheme used to protect the resource. If the resource is not
authenticated, null is returned.
Values are the same as the CGI variable AUTH_TYPE
Throws:
IllegalStateException – if called outside the scope of a request
Returns:
one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (suitable for == comparison)
or the container-specific string indicating the authentication scheme, or null if the request was not authenticated./**
     * Returns the string value of the authentication scheme used to protect the resource. If the resource is not
     * authenticated, null is returned.
     *
     * Values are the same as the CGI variable AUTH_TYPE
     *
     * @return one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (suitable for == comparison)
     * or the container-specific string indicating the authentication scheme, or null if the request was not authenticated.
     * @throws java.lang.IllegalStateException if called outside the scope of a request
     */
    public String getAuthenticationScheme();
}