org.jgroups.protocols

Class S3_PING

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.Discovery

org.jgroups.protocols.FILE_PING

org.jgroups.protocols.S3_PING

Direct Known Subclasses:

GOOGLE_PING

public class S3_PING
extends FILE_PING

Discovery protocol using Amazon's S3 storage. The S3 access code reuses the example shipped by Amazon.

Author:

Bela Ban

Nested Class Summary

Nested classes/interfaces inherited from class org.jgroups.protocols.FILE_PING

FILE_PING.InfoWriter

Nested classes/interfaces inherited from class org.jgroups.protocols.Discovery

Discovery.DiscoveryCacheDisseminationTask

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	access_key
protected org.jgroups.protocols.S3_PING.AWSAuthConnection	conn
protected java.lang.String	host
protected int	port
protected java.lang.String	pre_signed_delete_url
protected java.lang.String	pre_signed_put_url
protected java.lang.String	prefix
protected java.lang.String	secret_access_key
protected boolean	skip_bucket_existence_check
protected boolean	use_ssl

Fields inherited from class org.jgroups.protocols.FILE_PING

filter, info_writer, info_writer_max_writes_after_view, info_writer_sleep_time, interval, location, reads, regexp, remove_all_files_on_view_change, remove_old_coords_on_view_change, root_dir, SUFFIX, write_data_on_find, writes

Fields inherited from class org.jgroups.protocols.Discovery

always_send_physical_addr_with_discovery_request, async_discovery, async_discovery_use_separate_thread_per_request, break_on_coord_rsp, cluster_name, current_coord, discovery_rsp_expiry_time, force_sending_discovery_rsps, is_coord, is_leaving, is_server, local_addr, max_members_in_discovery_request, members, num_discovery_requests, num_initial_members, num_initial_srv_members, ping_responses, return_entire_cache, send_cache_on_join, stagger_timeout, timeout, timer, transport_supports_multicasting, use_disk_cache, view, WHITESPACE

Fields inherited from class org.jgroups.stack.Protocol

after_creation_hook, down_prot, ergonomics, id, log, name, stack, stats, up_prot

Constructor Summary

Constructors

Constructor and Description
S3_PING()

Method Summary

Modifier and Type	Method and Description
protected org.jgroups.protocols.S3_PING.AWSAuthConnection	createConnection()
protected void	createRootDir()
static java.lang.String	generatePreSignedUrl(java.lang.String awsAccessKey, java.lang.String awsSecretAccessKey, java.lang.String method, java.lang.String bucket, java.lang.String key, long expirationDate) Use this helper method to generate pre-signed S3 urls for use with S3_PING.
void	init() Called after instance has been created (null constructor) and before protocol is started.
protected void	readAll(java.util.List<Address> members, java.lang.String clustername, Responses responses)
protected void	readResponse(org.jgroups.protocols.S3_PING.GetResponse rsp, java.util.List<Address> mbrs, Responses responses)
protected void	remove(java.lang.String clustername, Address addr)
protected void	removeAll(java.lang.String clustername) Removes all files for the given cluster name
protected static java.lang.String	sanitize(java.lang.String name) Sanitizes bucket and folder names according to AWS guidelines
protected boolean	usingPreSignedUrls()
protected void	validateProperties()
protected void	write(java.util.List<PingData> list, java.lang.String clustername)

Methods inherited from class org.jgroups.protocols.FILE_PING

addDiscoveryResponseToCaches, addressToFilename, deleteFile, down, findMembers, getLocation, getRemoveAllDataOnViewChange, handleView, isDynamic, isInfoWriterRunning, read, read, resetStats, setLocation, setRemoveAllDataOnViewChange, startInfoWriter, stopInfoWriter, write, writeAll, writeInfo

Methods inherited from class org.jgroups.protocols.Discovery

addResponse, addressAsString, addToCache, breakOnCoordResponse, breakOnCoordResponse, deserialize, discoveryRequestReceived, discoveryRspExpiryTime, disseminateDiscoveryInformation, dumpCache, findInitialMembersAsString, findMembers, forceDiscoveryResponses, forceDiscoveryResponses, getCurrentCoord, getNumberOfDiscoveryRequestsSent, getNumInitialMembers, getTimeout, getView, getViewId, handleConnect, handleDisconnect, handleDiscoveryResponse, isCoord, isMergeRunning, marshal, numInitialMembers, numInitialMembers, providedUpServices, readPingData, returnEntireCache, returnEntireCache, sendCacheInformation, sendDiscoveryResponse, serializeWithoutView, setForceSendingDiscoveryRsps, setNumInitialMembers, setTimeout, staggerTimeout, staggerTimeout, start, startCacheDissemination, stop, timeout, timeout, up, useDiskCache, useDiskCache, weedOutCompletedDiscoveryResponses

Methods inherited from class org.jgroups.stack.Protocol

accept, afterCreationHook, destroy, dumpStats, enableStats, getConfigurableObjects, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, printStats, providedDownServices, requiredDownServices, requiredUpServices, resetStatistics, setDownProtocol, setErgonomics, setId, setLevel, setProtocolStack, setSocketFactory, setUpProtocol, setValue, setValues, statsEnabled, up

Methods inherited from class java.lang.Object

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

Field Detail

host

protected java.lang.String host

port

protected int port

use_ssl

protected boolean use_ssl

access_key

protected java.lang.String access_key

secret_access_key

protected java.lang.String secret_access_key

prefix

protected java.lang.String prefix

pre_signed_put_url

protected java.lang.String pre_signed_put_url

pre_signed_delete_url

protected java.lang.String pre_signed_delete_url

skip_bucket_existence_check

protected boolean skip_bucket_existence_check

conn

protected org.jgroups.protocols.S3_PING.AWSAuthConnection conn

Constructor Detail

S3_PING

public S3_PING()

Method Detail

init

public void init()
          throws java.lang.Exception

Description copied from class: Protocol

Called after instance has been created (null constructor) and before protocol is started. Properties are already set. Other protocols are not yet connected and events cannot yet be sent.

Overrides:

init in class FILE_PING

Throws:

java.lang.Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the channel constructor will throw an exception

createConnection

protected org.jgroups.protocols.S3_PING.AWSAuthConnection createConnection()

createRootDir

protected void createRootDir()

Overrides:

createRootDir in class FILE_PING

readAll

protected void readAll(java.util.List<Address> members,
                       java.lang.String clustername,
                       Responses responses)

Overrides:

readAll in class FILE_PING

readResponse

protected void readResponse(org.jgroups.protocols.S3_PING.GetResponse rsp,
                            java.util.List<Address> mbrs,
                            Responses responses)

write

protected void write(java.util.List<PingData> list,
                     java.lang.String clustername)

Overrides:

write in class FILE_PING

remove

protected void remove(java.lang.String clustername,
                      Address addr)

Overrides:

remove in class FILE_PING

removeAll

protected void removeAll(java.lang.String clustername)

Description copied from class: FILE_PING

Removes all files for the given cluster name

Overrides:

removeAll in class FILE_PING

validateProperties

protected void validateProperties()

usingPreSignedUrls

protected boolean usingPreSignedUrls()

sanitize

protected static java.lang.String sanitize(java.lang.String name)

Sanitizes bucket and folder names according to AWS guidelines

generatePreSignedUrl

public static java.lang.String generatePreSignedUrl(java.lang.String awsAccessKey,
                                                    java.lang.String awsSecretAccessKey,
                                                    java.lang.String method,
                                                    java.lang.String bucket,
                                                    java.lang.String key,
                                                    long expirationDate)

Use this helper method to generate pre-signed S3 urls for use with S3_PING. You'll need to generate urls for both the put and delete http methods. Example: Your AWS Access Key is "abcd". Your AWS Secret Access Key is "efgh". You want this node to write its information to "/S3_PING/DemoCluster/node1". So, your bucket is "S3_PING" and your key is "DemoCluster/node1". You want this to expire one year from now, or (System.currentTimeMillis / 1000) + (60 * 60 * 24 * 365) Let's assume that this equals 1316286684 Here's how to generate the value for the pre_signed_put_url property: String putUrl = S3_PING.generatePreSignedUrl("abcd", "efgh", "put", "S3_Ping", "DemoCluster/node1", 1316286684); Here's how to generate the value for the pre_signed_delete_url property: String deleteUrl = S3_PING.generatePreSignedUrl("abcd", "efgh", "delete", "S3_Ping", "DemoCluster/node1", 1316286684);

Parameters:

awsAccessKey - Your AWS Access Key

awsSecretAccessKey - Your AWS Secret Access Key

method - The HTTP method - use "put" or "delete" for use with S3_PING

bucket - The S3 bucket you want to write to

key - The key within the bucket to write to

expirationDate - The date this pre-signed url should expire, in seconds since epoch

Returns:

The pre-signed url to be used in pre_signed_put_url or pre_signed_delete_url properties