com.amazonaws.mobileconnectors.s3.transferutility.S3ClientReference Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-s3 Show documentation

The AWS Java Mobile SDK for Amazon S3 module holds the client classes that are used for communicating with Amazon Simple Storage Service

The newest version!

/**
 * Copyright 2015-2018 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 com.amazonaws.mobileconnectors.s3.transferutility;

import com.amazonaws.services.s3.AmazonS3;

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

/**
 * A holder of S3 clients for {@link TransferUtility} to pass a reference of
 * {@link AmazonS3} to {@link TransferService}. Usually objects are passed to a service
 * via intent in a parcelable form. A S3 client has too many elements to
 * capture. Instead, this serves as an alternative approach, not ideal though.
 */
class S3ClientReference {

    private static Map map = new ConcurrentHashMap();

    /**
     * Insert the transferId and the corresponding {@link AmazonS3Client}
     * into the map. {@link TransferService} retrieves the
     * {@link AmazonS3Client} based on the transferId.
     * 
     * @param transferId the id for the transfer record
     * @param s3 an AmazonS3 instance
     */
    public static void put(final Integer transferId, AmazonS3 s3) {
        map.put(transferId, s3);
    }

    /**
     * Retrieves the AmazonS3 client on the given key.
     *
     * @param transferId the id for the transfer record
     * @return an AmazonS3 instance, or null if the key doesn't exist
     */
    public static AmazonS3 get(final Integer transferId) {
        return map.get(transferId);
    }
    
    /**
     * Remove the S3 Client for the given transferId.
     * 
     * @param transferId the id for the transfer record
     */
    public static void remove(final Integer transferId) {
        map.remove(transferId);
    }

    /**
     * Clears all references.
     */
    public static void clear() {
        map.clear();
    }
}