com.oracle.bmc.common.RegionalClientBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of oci-java-sdk-shaded-full Show documentation

This project contains the SDK distribution used for Oracle Cloud Infrastructure, and all the dependencies that can be shaded. It also has Maven dependencies that cannot be shaded. Therefore, use this module to depend on the shaded distribution via Maven -- it will shade everything that can be shaded, and automatically pull in the other dependencies.

There is a newer version: 3.55.2

Show newest version

/**
 * Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
 * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
 */
package com.oracle.bmc.common;

import com.oracle.bmc.Region;
import com.oracle.bmc.Service;
import com.oracle.bmc.internal.Alloy;
import org.slf4j.Logger;

import java.util.Locale;
import java.util.Optional;

/**
 * A builder for clients that can be configured to target a certain region
 *
 * @param  actual builder class
 * @param  client class
 */
public abstract class RegionalClientBuilder
        extends ClientBuilderBase {
    private static final Logger LOG =
            org.slf4j.LoggerFactory.getLogger(RegionalClientBuilder.class);

    protected Region region;

    public RegionalClientBuilder(Service service) {
        super(service);
    }

    /**
     * Set the region for the client to be created.
     *
     * @param region region
     * @return this builder
     */
    public B region(com.oracle.bmc.Region region) {
        if (Alloy.shouldUseOnlyAlloyRegions()) {
            try {
                com.oracle.bmc.Region.valueOf(region.getRegionId());
            } catch (IllegalArgumentException e) {
                Alloy.throwUnknownAlloyRegionIfAppropriate(region.getRegionId(), e);
            }
        }
        setRegion(region);
        Optional endpoint = region.getEndpoint(service);
        if (endpoint.isPresent()) {
            endpoint(endpoint.get());
        } else {
            throw new IllegalArgumentException(
                    "Endpoint for " + service + " is not known in region " + region);
        }
        return (B) this;
    }

    /**
     * Set the region for the client to be created.
     *
     * @param regionId region
     * @return this builder
     */
    public B region(String regionId) {
        regionId = regionId.toLowerCase(Locale.ENGLISH);
        try {
            com.oracle.bmc.Region region = com.oracle.bmc.Region.fromRegionId(regionId);
            return region(region);
        } catch (IllegalArgumentException e) {
            Alloy.throwUnknownAlloyRegionIfAppropriate(regionId, e);
            LOG.info("Unknown regionId '{}', falling back to default endpoint format", regionId);
            String endpoint = com.oracle.bmc.Region.formatDefaultRegionEndpoint(service, regionId);
            return endpoint(endpoint);
        }
    }

    private B setRegion(Region region) {
        this.region = region;
        return (B) this;
    }
}