com.mongodb.AwsCredential Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mongodb-driver-core Show documentation

The Java operations layer for the MongoDB Java Driver. Third parties can wrap this layer to provide custom higher-level APIs

There is a newer version: 5.3.0-beta0

Show newest version

/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * 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 com.mongodb;

import com.mongodb.annotations.Beta;
import com.mongodb.lang.Nullable;

import static com.mongodb.assertions.Assertions.notNull;

/**
 * A representation of Amazon Web Services credentials for API authentication.
 *
 * @see MongoCredential#createAwsCredential(String, char[])
 * @see MongoCredential#AWS_CREDENTIAL_PROVIDER_KEY
 * @since 4.4
 */
@Beta(Beta.Reason.CLIENT)
public final class AwsCredential {
    private final String accessKeyId;
    private final String secretAccessKey;
    private final String sessionToken;

    /**
     * Construct a new instance.
     *
     * @param accessKeyId the non-null access key ID that identifies the temporary security credentials.
     * @param secretAccessKey the non-null secret access key that can be used to sign requests
     * @param sessionToken the session token, which may be null
     */
    public AwsCredential(final String accessKeyId, final String secretAccessKey, @Nullable final String sessionToken) {
        this.accessKeyId = notNull("accessKeyId", accessKeyId);
        this.secretAccessKey = notNull("secretAccessKey", secretAccessKey);
        this.sessionToken = sessionToken;
    }

    /**
     * Gets the access key ID that identifies the temporary security credentials.
     *
     * @return the accessKeyId, which may not be null
     */
    public String getAccessKeyId() {
        return accessKeyId;
    }

    /**
     * Gets the secret access key that can be used to sign requests.
     *
     * @return the secretAccessKey, which may not be null
     */
    public String getSecretAccessKey() {
        return secretAccessKey;
    }

    /**
     * Gets the session token.
     *
     * @return the sessionToken, which may not be null
     */
    @Nullable
    public String getSessionToken() {
        return sessionToken;
    }
}