org.wso2.testgrid.common.plugins

Class AWSArtifactReader

java.lang.Object

org.wso2.testgrid.common.plugins.AWSArtifactReader

All Implemented Interfaces:

ArtifactReadable

public class AWSArtifactReader
extends Object
implements ArtifactReadable

This class is responsible for downloading artifacts from AWS.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
AWSArtifactReader(String region, String bucket) Creates an instance of AWSArtifactReader for the given region and bucket name.

Method Summary

Modifier and Type	Method and Description
InputStream	getArtifactStream(String key) Read the artifacts for the given key and return an input stream without truncating.
Boolean	isArtifactExist(String key) Verify the existence of the artifact for the given key.
TruncatedInputStreamData	readArtifact(String key) Read the artifacts for the given key and return an input stream.
TruncatedInputStreamData	readArtifact(String key, int kiloByteLimit) Read the artifacts for the given key and return an input stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

AWSArtifactReader

public AWSArtifactReader(String region,
                         String bucket)
                  throws ArtifactReaderException,
                         IOException

Creates an instance of AWSArtifactReader for the given region and bucket name.

Please do note that accessKey and secretKey values should be set in a properties file in order to authenticate to the AWS.

Parameters:

region - region where the S3 bucket is located

bucket - name of the bucket

Throws:

ArtifactReaderException - thrown if the given parameters are null or empty

IOException

Method Detail

readArtifact

public TruncatedInputStreamData readArtifact(String key)
                                      throws ArtifactReaderException

Description copied from interface: ArtifactReadable

Read the artifacts for the given key and return an input stream.

Specified by:

readArtifact in interface ArtifactReadable

Parameters:

key - key of the artifact to download

Returns:

TruncatedInputStreamData containing input stream of the artifact and whether the input stream is truncated or not

Throws:

ArtifactReaderException - thrown when error on downloading artifacts

readArtifact

public TruncatedInputStreamData readArtifact(String key,
                                             int kiloByteLimit)
                                      throws ArtifactReaderException

Description copied from interface: ArtifactReadable

Read the artifacts for the given key and return an input stream.

Specified by:

readArtifact in interface ArtifactReadable

Parameters:

key - key of the artifact to download

kiloByteLimit - maximum number of kilo bytes to read

Returns:

TruncatedInputStreamData containing input stream of the artifact and whether the input stream is truncated or not

Throws:

ArtifactReaderException - thrown when error on downloading artifacts

getArtifactStream

public InputStream getArtifactStream(String key)

Description copied from interface: ArtifactReadable

Read the artifacts for the given key and return an input stream without truncating.

Specified by:

getArtifactStream in interface ArtifactReadable

Parameters:

key - key of the artifact to download

Returns:

InputStream containing input stream of the artifact

isArtifactExist

public Boolean isArtifactExist(String key)

Description copied from interface: ArtifactReadable

Verify the existence of the artifact for the given key.

Specified by:

isArtifactExist in interface ArtifactReadable

Parameters:

key - key of the artifact to download

Returns:

Boolean If artifact exist in the remote storage return True otherwise return False