org.apache.ignite.spi.checkpoint.s3

Class S3CheckpointSpi

java.lang.Object

org.apache.ignite.spi.IgniteSpiAdapter

org.apache.ignite.spi.checkpoint.s3.S3CheckpointSpi

All Implemented Interfaces:

CheckpointSpi, S3CheckpointSpiMBean, IgniteSpi, IgniteSpiManagementMBean

@IgniteSpiMultipleInstancesSupport(value=true)
public class S3CheckpointSpi
extends IgniteSpiAdapter
implements CheckpointSpi, S3CheckpointSpiMBean

This class defines Amazon S3-based implementation for checkpoint SPI.

For information about Amazon S3 visit aws.amazon.com.

Configuration

Mandatory

This SPI has one mandatory configuration parameter:

• setAwsCredentials(AWSCredentials)

Optional

This SPI has following optional configuration parameters:

• setBucketNameSuffix(String)
• setClientConfiguration(ClientConfiguration)

Java Example

S3CheckpointSpi can be configured as follows:

 IgniteConfiguration cfg = new IgniteConfiguration();

 S3CheckpointSpi spi = new S3CheckpointSpi();

 AWSCredentials cred = new BasicAWSCredentials(YOUR_ACCESS_KEY_ID, YOUR_SECRET_ACCESS_KEY);

 spi.setAwsCredentials(cred);

 spi.setBucketNameSuffix("checkpoints");

 // Override default checkpoint SPI.
 cfg.setCheckpointSpi(cpSpi);

 // Start grid.
 G.start(cfg);
 

Spring Example

S3CheckpointSpi can be configured from Spring XML configuration file:

 <bean id="grid.custom.cfg" class="org.apache.ignite.configuration.IgniteConfiguration" singleton="true">
     ...
        <property name="checkpointSpi">
            <bean class="org.apache.ignite.spi.checkpoint.s3.S3CheckpointSpi">
                <property name="awsCredentials">
                    <bean class="com.amazonaws.auth.BasicAWSCredentials">
                        <constructor-arg value="YOUR_ACCESS_KEY_ID" />
                        <constructor-arg value="YOUR_SECRET_ACCESS_KEY" />
                    </bean>
                </property>
            </bean>
        </property>
     ...
 </bean>
 

Note that storing data in AWS S3 service will result in charges to your AWS account. Choose another implementation of CheckpointSpi for local or home network tests.

For information about Spring framework visit www.springframework.org

See Also:

CheckpointSpi

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUCKET_NAME_PREFIX Prefix to use in bucket name generation.
static String	DFLT_BUCKET_NAME_SUFFIX Suffix to use in bucket name generation.

Fields inherited from class org.apache.ignite.spi.IgniteSpiAdapter

gridName

Constructor Summary

Constructors

Constructor and Description
S3CheckpointSpi()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAccessKey() Gets S3 access key.
String	getBucketName() Gets S3 bucket name to use.
String	getProxyHost() Gets HTTP proxy host.
String	getProxyPassword() Gets HTTP proxy password.
int	getProxyPort() Gets HTTP proxy port.
String	getProxyUsername() Gets HTTP proxy user name.
String	getSecretAccessKey() Gets S3 secret key.
byte[]	loadCheckpoint(String key)
boolean	removeCheckpoint(String key)
boolean	saveCheckpoint(String key, byte[] state, long timeout, boolean overwrite)
void	setAwsCredentials(com.amazonaws.auth.AWSCredentials cred) Sets AWS credentials.
void	setBucketNameSuffix(String bucketNameSuffix) Sets bucket name suffix.
void	setCheckpointListener(CheckpointListener lsnr)
void	setClientConfiguration(com.amazonaws.ClientConfiguration cfg) Sets Amazon client configuration.
void	spiStart(String gridName)
void	spiStop()
String	toString()

Methods inherited from class org.apache.ignite.spi.IgniteSpiAdapter

addTimeoutObject, assertParameter, checkConfigurationConsistency0, configInfo, createSpiAttributeName, failureDetectionTimeout, failureDetectionTimeoutEnabled, failureDetectionTimeoutEnabled, getConsistentAttributeNames, getExceptionRegistry, getIgniteHome, getLocalNode, getLocalNodeId, getName, getNodeAttributes, getSpiContext, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted, initFailureDetectionTimeout, injectables, injectResources, isNodeStopping, onClientDisconnected, onClientReconnected, onContextDestroyed, onContextDestroyed0, onContextInitialized, onContextInitialized0, registerMBean, removeTimeoutObject, setName, startInfo, startStopwatch, stopInfo, unregisterMBean

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.ignite.spi.IgniteSpi

getName, getNodeAttributes, onClientDisconnected, onClientReconnected, onContextDestroyed, onContextInitialized

Methods inherited from interface org.apache.ignite.spi.IgniteSpiManagementMBean

getIgniteHome, getLocalNodeId, getName, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted

Field Detail

BUCKET_NAME_PREFIX

public static final String BUCKET_NAME_PREFIX

Prefix to use in bucket name generation.

See Also:

Constant Field Values

DFLT_BUCKET_NAME_SUFFIX

public static final String DFLT_BUCKET_NAME_SUFFIX

Suffix to use in bucket name generation.

See Also:

Constant Field Values

Constructor Detail

S3CheckpointSpi

public S3CheckpointSpi()

Method Detail

getBucketName

public String getBucketName()

Gets S3 bucket name to use.

Specified by:

getBucketName in interface S3CheckpointSpiMBean

Returns:

S3 bucket name to use.

getAccessKey

public String getAccessKey()

Gets S3 access key.

Specified by:

getAccessKey in interface S3CheckpointSpiMBean

Returns:

S3 access key.

getSecretAccessKey

public String getSecretAccessKey()

Gets S3 secret key.

Returns:

S3 secret key.

getProxyHost

public String getProxyHost()

Gets HTTP proxy host.

Specified by:

getProxyHost in interface S3CheckpointSpiMBean

Returns:

HTTP proxy host.

getProxyPort

public int getProxyPort()

Gets HTTP proxy port.

Specified by:

getProxyPort in interface S3CheckpointSpiMBean

Returns:

HTTP proxy port.

getProxyUsername

public String getProxyUsername()

Gets HTTP proxy user name.

Specified by:

getProxyUsername in interface S3CheckpointSpiMBean

Returns:

HTTP proxy user name.

getProxyPassword

public String getProxyPassword()

Gets HTTP proxy password.

Returns:

HTTP proxy password.

setBucketNameSuffix

@IgniteSpiConfiguration(optional=true)
public void setBucketNameSuffix(String bucketNameSuffix)

Sets bucket name suffix.

Parameters:

bucketNameSuffix - Bucket name suffix.

setClientConfiguration

@IgniteSpiConfiguration(optional=true)
public void setClientConfiguration(com.amazonaws.ClientConfiguration cfg)

Sets Amazon client configuration.

For details refer to Amazon S3 API reference.

Parameters:

cfg - Amazon client configuration.

setAwsCredentials

@IgniteSpiConfiguration(optional=false)
public void setAwsCredentials(com.amazonaws.auth.AWSCredentials cred)

Sets AWS credentials.

For details refer to Amazon S3 API reference.

Parameters:

cred - AWS credentials.

spiStart

public void spiStart(String gridName)
              throws IgniteSpiException

Specified by:

spiStart in interface IgniteSpi

Throws:

IgniteSpiException

spiStop

public void spiStop()
             throws IgniteSpiException

Specified by:

spiStop in interface IgniteSpi

Throws:

IgniteSpiException

loadCheckpoint

public byte[] loadCheckpoint(String key)
                      throws IgniteSpiException

Specified by:

loadCheckpoint in interface CheckpointSpi

Throws:

IgniteSpiException

saveCheckpoint

public boolean saveCheckpoint(String key,
                     byte[] state,
                     long timeout,
                     boolean overwrite)
                       throws IgniteSpiException

Specified by:

saveCheckpoint in interface CheckpointSpi

Throws:

IgniteSpiException

removeCheckpoint

public boolean removeCheckpoint(String key)

Specified by:

removeCheckpoint in interface CheckpointSpi

setCheckpointListener

public void setCheckpointListener(CheckpointListener lsnr)

Specified by:

setCheckpointListener in interface CheckpointSpi

toString

public String toString()

Overrides:

toString in class Object