com.northconcepts.datapipeline.amazons3

Class AmazonS3FileSource

java.lang.Object

com.northconcepts.datapipeline.foundations.core.Bean

com.northconcepts.datapipeline.amazons3.AmazonS3File

com.northconcepts.datapipeline.amazons3.AmazonS3FileSource

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, FileSource, Serializable

public class AmazonS3FileSource
extends AmazonS3File
implements FileSource

See Also:

Serialized Form

Field Summary

Fields inherited from class com.northconcepts.datapipeline.amazons3.AmazonS3File

amazonS3FileSystem, bucketName, path

Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

SERIALIZED_CLASS_NAME, TYPE

Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

XML_SERIALIZED_CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
AmazonS3FileSource()

Method Summary

Modifier and Type	Method and Description
AmazonS3FileSource	fromRecord(Record source) Loads this instance's state from a record and returns this (for fluid API call chaining).
AmazonS3FileSource	fromXmlElement(Element element)
InputStream	getInputStream()
AmazonS3FileSource	setAmazonS3FileSystem(AmazonS3FileSystem amazonS3FileSystem)
AmazonS3FileSource	setBasicAWSCredentials(String accessKey, String secretKey)
AmazonS3FileSource	setBucketName(String bucketName)
AmazonS3FileSource	setCredentialsProvider(AwsCredentialsProvider credentialsProvider)
AmazonS3FileSource	setCredentialsResolver(CredentialsResolver credentialsResolver) Sets the backend-neutral resolver supplying this file's credentials — resolved on each connection, so rotated secrets are picked up automatically.
AmazonS3FileSource	setName(String name)
AmazonS3FileSource	setPath(String path)
Element	toXmlElement(Document document)
AmazonS3FileSource	useProfileCredentialsProvider(String profileName)

Methods inherited from class com.northconcepts.datapipeline.amazons3.AmazonS3File

assertValid, getAmazonS3FileSystem, getBucketName, getContentType, getCredentialsProvider, getCredentialsResolver, getFileSize, getFileType, getName, getPath, getUrlPath, isDebug, isLocal, setDebug, toRecord

Methods inherited from class com.northconcepts.datapipeline.foundations.core.Bean

addExceptionProperties, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.northconcepts.datapipeline.foundations.file.FileSource

getContentType, getFileSize, getFileType, getName, getPath, getUrlPath, isLocal

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

fromArrayValue, fromArrayValue, fromArrayValue, fromJson, fromJson, newInstanceFromRecord, newInstanceFromRecord, toArrayValue, toJson, toJson, toJson, toRecord, toRecord

Methods inherited from interface com.northconcepts.datapipeline.core.JsonSerializable

newInstanceFromJson

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

forEachGrandChildElement, fromXml, fromXml, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getChildElement, getChildElements, newInstanceFromXml, newInstanceFromXml, setAttribute, toXml, toXml, toXml, toXml, toXml, writeXml, writeXml

Methods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor

addExceptionProperties, contributeExceptionProperties, contributeExceptionProperties, exception, exception, exception

Constructor Detail

AmazonS3FileSource

public AmazonS3FileSource()

Method Detail

getInputStream

public InputStream getInputStream()

Specified by:

getInputStream in interface FileSource

setName

public AmazonS3FileSource setName(String name)

Overrides:

setName in class AmazonS3File

setPath

public AmazonS3FileSource setPath(String path)

Overrides:

setPath in class AmazonS3File

setBucketName

public AmazonS3FileSource setBucketName(String bucketName)

Overrides:

setBucketName in class AmazonS3File

setAmazonS3FileSystem

public AmazonS3FileSource setAmazonS3FileSystem(AmazonS3FileSystem amazonS3FileSystem)

Overrides:

setAmazonS3FileSystem in class AmazonS3File

setCredentialsProvider

public AmazonS3FileSource setCredentialsProvider(AwsCredentialsProvider credentialsProvider)

Overrides:

setCredentialsProvider in class AmazonS3File

setCredentialsResolver

public AmazonS3FileSource setCredentialsResolver(CredentialsResolver credentialsResolver)

Description copied from class: AmazonS3File

Sets the backend-neutral resolver supplying this file's credentials — resolved on each connection, so rotated secrets are picked up automatically. Takes precedence over AmazonS3File.setCredentialsProvider(AwsCredentialsProvider) and the default provider chain.

Overrides:

setCredentialsResolver in class AmazonS3File

useProfileCredentialsProvider

public AmazonS3FileSource useProfileCredentialsProvider(String profileName)

Overrides:

useProfileCredentialsProvider in class AmazonS3File

setBasicAWSCredentials

public AmazonS3FileSource setBasicAWSCredentials(String accessKey,
                                                 String secretKey)

Overrides:

setBasicAWSCredentials in class AmazonS3File

fromRecord

public AmazonS3FileSource fromRecord(Record source)

Description copied from interface: RecordSerializable

Loads this instance's state from a record and returns this (for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.

Specified by:

fromRecord in interface RecordSerializable

Specified by:

fromRecord in interface FileSource

Overrides:

fromRecord in class AmazonS3File

Returns:

this instance.

toXmlElement

public Element toXmlElement(Document document)

Specified by:

toXmlElement in interface XmlSerializable

Overrides:

toXmlElement in class AmazonS3File

fromXmlElement

public AmazonS3FileSource fromXmlElement(Element element)

Specified by:

fromXmlElement in interface XmlSerializable

Overrides:

fromXmlElement in class AmazonS3File