Module kivakit.network.ftp

Package com.telenav.kivakit.network.ftp.secure

Class SecureFtpResource

java.lang.Object

com.telenav.kivakit.core.messaging.broadcasters.Multicaster

com.telenav.kivakit.core.messaging.repeaters.BaseRepeater

com.telenav.kivakit.resource.reading.BaseReadableResource

com.telenav.kivakit.network.core.BaseNetworkResource

com.telenav.kivakit.network.ftp.secure.SecureFtpResource

All Implemented Interfaces:

Broadcaster, Listener, Repeater, Transceiver, CreatedAt, Modifiable, ModifiedAt, ByteSized, Receiver, Transmitter, NamedObject, StringSource, NetworkResource, Deletable, Readable, ReadableResource, Resource, Resourceful, ResourcePathed, UriIdentified

public class SecureFtpResource
extends BaseNetworkResource

A resource accessed by SFTP. A list of files can be retrieved with listFiles().

Author:

jonathanl (shibo)

Nested Class Summary

Nested classes/interfaces inherited from interface com.telenav.kivakit.resource.Resource

Resource.Can, Resource.Converter

Constructor Summary

Constructors

Constructor	Description
SecureFtpResource(NetworkLocation location, NetworkAccessConstraints constraints)

Method Summary

Modifier and Type	Method	Description
void	copyTo(WritableResource destination, CopyMode mode, ProgressReporter reporter)	Copy this resource to the disk
void	disconnect()
ObjectList<com.jcraft.jsch.ChannelSftp.LsEntry>	listFiles()
NetworkLocation	location()
InputStream	onOpenForReading()	Opens the input stream to this readable
Bytes	sizeInBytes()
String	toString()

Methods inherited from class com.telenav.kivakit.network.core.BaseNetworkResource

asUri, asUrl

Methods inherited from class com.telenav.kivakit.resource.reading.BaseReadableResource

charset, charset, codec, codec, delete, dematerialize, equals, exists, hashCode, materialized, openForReading, path

Methods inherited from class com.telenav.kivakit.core.messaging.repeaters.BaseRepeater

onMessage, onReceive

Methods inherited from class com.telenav.kivakit.core.messaging.broadcasters.Multicaster

addListener, clearListeners, debugClassContext, debugCodeContext, debugCodeContext, hasListeners, isDeaf, isTransmitting, listenerChain, listeners, listenerTree, messageSource, messageSource, objectName, removeListener, transmit, withoutTransmitting

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.telenav.kivakit.core.messaging.Broadcaster

addListener, addListener, clearListeners, copyListeners, hasListeners, listeners, messageSource, messageSource, onTransmit, onTransmitted, onTransmitting, removeListener, silence, transmit, transmit, transmitAll

Methods inherited from interface com.telenav.kivakit.core.value.count.ByteSized

isLargerThan, isSmallerThan

Methods inherited from interface com.telenav.kivakit.core.time.CreatedAt

age, createdAt, wasCreatedAfter, wasCreatedBefore

Methods inherited from interface com.telenav.kivakit.resource.Deletable

delete

Methods inherited from interface com.telenav.kivakit.core.messaging.Listener

isDeaf, listenTo, listenTo, onMessage

Methods inherited from interface com.telenav.kivakit.core.time.Modifiable

lastModified

Methods inherited from interface com.telenav.kivakit.core.time.ModifiedAt

modifiedAt, wasChangedAfter, wasChangedBefore

Methods inherited from interface com.telenav.kivakit.interfaces.naming.NamedObject

hasSyntheticName, objectName, objectName

Methods inherited from interface com.telenav.kivakit.resource.reading.Readable

isReadable, openForReading, openForReading

Methods inherited from interface com.telenav.kivakit.resource.reading.ReadableResource

asStringResource, charset, reader, reader, reader

Methods inherited from interface com.telenav.kivakit.interfaces.messaging.Receiver

isReceiving

Methods inherited from interface com.telenav.kivakit.core.messaging.Repeater

isRepeating, onReceive, receive

Methods inherited from interface com.telenav.kivakit.resource.Resource

asString, asWritable, can, can, codec, dematerialize, endsWith, ensureExists, exists, hasParent, isEmpty, isLocal, isMaterializable, isOlderThan, isPackaged, isRemote, isSame, materialized, parent, path, relativeTo, renameTo, resource, safeCopyTo, safeCopyTo, safeCopyTo, safeCopyTo

Methods inherited from interface com.telenav.kivakit.resource.ResourcePathed

asJavaFile, baseName, compoundExtension, extension, fileName, hasExtension, matches, uri, url

Methods inherited from interface com.telenav.kivakit.core.messaging.Transceiver

announce, debug, debugClassContext, debugCodeContext, debugCodeContext, fatal, fatal, glitch, glitch, glitch, glitch, halted, halted, ifDebug, illegalArgument, illegalState, illegalState, information, isDebugOn, narrate, problem, problem, problem, problem, problemIfNull, quibble, quibble, quibble, quibble, trace, trace, trace, trace, warning, warning, warning, warning

Methods inherited from interface com.telenav.kivakit.interfaces.messaging.Transmitter

isTransmitting, withoutTransmitting

Constructor Details

SecureFtpResource

public SecureFtpResource(NetworkLocation location,
 NetworkAccessConstraints constraints)

Method Details

copyTo

public void copyTo(WritableResource destination,
 CopyMode mode,
 ProgressReporter reporter)

Copy this resource to the disk

Specified by:

copyTo in interface ReadableResource

Overrides:

copyTo in class BaseReadableResource

Parameters:

destination - The destination to write to

disconnect

public void disconnect()

listFiles

public ObjectList<com.jcraft.jsch.ChannelSftp.LsEntry> listFiles()

Returns:

The files present in current folder.

location

public NetworkLocation location()

Returns:

The location of this network resource

onOpenForReading

public InputStream onOpenForReading()

Description copied from interface: Readable

Opens the input stream to this readable

sizeInBytes

public Bytes sizeInBytes()

Returns:

The number of bytes in this object

toString

public String toString()

Overrides:

toString in class BaseReadableResource