com.jcabi.dynamo.Region Maven / Gradle / Ivy
Show all versions of jcabi-dynamo Show documentation
/**
* Copyright (c) 2012-2017, jcabi.com
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met: 1) Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following
* disclaimer. 2) Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution. 3) Neither the name of the jcabi.com nor
* the names of its contributors may be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.jcabi.dynamo;
import com.amazonaws.services.dynamodbv2.AmazonDynamoDB;
import com.jcabi.aspects.Immutable;
import com.jcabi.aspects.Loggable;
import lombok.EqualsAndHashCode;
import lombok.ToString;
/**
* Amazon DynamoDB region.
*
* It is recommended to use {@link Region.Simple} in most cases.
*
*
You can use {@link #aws()} method to get access to Amazon DynamoDB
* client directly.
*
*
Since version 0.9 it is strongly recommended to wrap your region
* in {@link com.jcabi.dynamo.retry.ReRegion} before use, for example:
*
*
Region region = new ReRegion(new Region.Simple(credentials));
*
* After all operations with the region are finished, it can be optionally
* shutdown invoking {@link AmazonDynamoDB#shutdown()}. Callers are not expected
* to call it, but can if they want to explicitly release any open resources and
* forcibly terminate all pending asynchronous service calls. Once a client has
* been shutdown, it should not be used to make any more requests.
*
* @author Yegor Bugayenko ([email protected])
* @version $Id: e832a29d7444253e94710deb02a9fa782acee157 $
* @since 0.1
*/
@Immutable
public interface Region {
/**
* Get DynamoDB client.
* @return The client
*/
AmazonDynamoDB aws();
/**
* Get one table.
* @param name Table name
* @return Table
*/
Table table(String name);
/**
* Simple region, basic implementation.
*/
@Immutable
@Loggable(Loggable.DEBUG)
@ToString
@EqualsAndHashCode(of = "credentials")
final class Simple implements Region {
/**
* Credentials.
*/
private final transient Credentials credentials;
/**
* Public ctor.
* @param creds Credentials
*/
public Simple(final Credentials creds) {
this.credentials = creds;
}
@Override
public AmazonDynamoDB aws() {
return this.credentials.aws();
}
@Override
public Table table(final String name) {
return new AwsTable(this.credentials, this, name);
}
}
/**
* All tables have a prefix in front of their names.
*
*
The region has to be used in combination with another region,
* for example {@link Region.Simple}:
*
*
Region region = new Region.Prefixed(
* new Region.Simple(creds),
* "foo-"
* );
*
* Now, {@code region.table("test")} will return a {@link Table}
* instance pointing to the Dynamo DB table named {@code "foo-test"}. Could
* be a convenient mechanism when you have many tables for different
* projects in the same region.
*/
@Immutable
@Loggable(Loggable.DEBUG)
@ToString
@EqualsAndHashCode(of = { "origin", "prefix" })
final class Prefixed implements Region {
/**
* Original region.
*/
private final transient Region origin;
/**
* Prefix to add.
*/
private final transient String prefix;
/**
* Public ctor.
* @param region Original region
* @param pfx Prefix to add to all tables
*/
public Prefixed(final Region region, final String pfx) {
this.origin = region;
this.prefix = pfx;
}
@Override
public AmazonDynamoDB aws() {
return this.origin.aws();
}
@Override
public Table table(final String name) {
return this.origin.table(
new StringBuilder(this.prefix).append(name).toString()
);
}
}
}