software.amazon.awssdk.http.auth.scheme.NoAuthAuthScheme Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of http-auth Show documentation

The AWS SDK for Java - HTTP Auth module contains interfaces and implementations for generic HTTP authentication

The newest version!

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file 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 software.amazon.awssdk.http.auth.scheme;

import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.http.auth.internal.scheme.DefaultNoAuthAuthScheme;
import software.amazon.awssdk.http.auth.spi.scheme.AuthScheme;
import software.amazon.awssdk.http.auth.spi.signer.HttpSigner;
import software.amazon.awssdk.identity.spi.Identity;
import software.amazon.awssdk.identity.spi.IdentityProvider;
import software.amazon.awssdk.identity.spi.IdentityProviders;

/**
 * An auth scheme that represents no authentication.
 */
@SdkPublicApi
public interface NoAuthAuthScheme extends AuthScheme {
    /**
     * The scheme ID for the no-auth auth scheme.
     */
    String SCHEME_ID = "smithy.api#noAuth";

    static NoAuthAuthScheme create() {
        return DefaultNoAuthAuthScheme.create();
    }

    /**
     * Retrieve the {@link AnonymousIdentity} based {@link IdentityProvider} associated with this authentication scheme.
     */
    @Override
    IdentityProvider identityProvider(IdentityProviders providers);

    /**
     * Retrieve the {@link HttpSigner} associated with this authentication scheme.
     */
    @Override
    HttpSigner signer();

    /**
     * An anonymous identity used by the no-auth auth scheme.
     */
    interface AnonymousIdentity extends Identity {
    }
}