rocks.xmpp.extensions.filetransfer

Class FileTransferOfferEvent

java.lang.Object

java.util.EventObject

rocks.xmpp.extensions.filetransfer.FileTransferOfferEvent

All Implemented Interfaces:

java.io.Serializable, FileTransferOffer

public final class FileTransferOfferEvent
extends java.util.EventObject
implements FileTransferOffer

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
AsyncResult<FileTransfer>	accept(java.io.File target) Accepts the inbound file transfer request.
AsyncResult<FileTransfer>	accept(java.io.OutputStream outputStream) Accepts the inbound file transfer request.
AsyncResult<FileTransfer>	accept(java.nio.file.Path destination) Accepts the inbound file transfer request.
java.time.Instant	getDate() Gets the last modification time of the file.
java.lang.String	getDescription() Gets a sender-generated description of the file.
java.util.List<Hash>	getHashes() Gets the hashes of the file contents.
Jid	getInitiator() Gets the initiator.
java.lang.String	getMimeType() Gets the mime type of the file.
java.lang.String	getName() Gets the name of the file that the Sender wishes to send.
Range	getRange() Gets the range.
java.lang.String	getSessionId()
long	getSize() Gets the size, in bytes, of the data to be sent.
void	reject() Rejects the inbound file transfer request.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getMimeType

public java.lang.String getMimeType()

Gets the mime type of the file.

Returns:

The mime type.

getInitiator

public Jid getInitiator()

Gets the initiator.

Returns:

The initiator.

accept

public AsyncResult<FileTransfer> accept(java.io.OutputStream outputStream)

Accepts the inbound file transfer request. After accepting the file transfer you should call FileTransfer.transfer() in order to start the transfer.

Parameters:

outputStream - The output stream, to which the file will be written.

Returns:

The file transfer object.

accept

public final AsyncResult<FileTransfer> accept(java.nio.file.Path destination)
                                       throws java.io.IOException

Accepts the inbound file transfer request. After accepting the file transfer you should call FileTransfer.transfer() in order to start the transfer.

Parameters:

destination - The path of the file to be written.

Returns:

The file transfer object.

Throws:

java.io.IOException - If the byte stream session could not be established.

accept

public final AsyncResult<FileTransfer> accept(java.io.File target)
                                       throws java.io.IOException

Accepts the inbound file transfer request. After accepting the file transfer you should call FileTransfer.transfer() in order to start the transfer.

Parameters:

target - The file to be written.

Returns:

The file transfer object.

Throws:

java.io.IOException - If the byte stream session could not be established.

reject

public void reject()

Rejects the inbound file transfer request.

getSize

public long getSize()

Description copied from interface: FileTransferOffer

Gets the size, in bytes, of the data to be sent.

Specified by:

getSize in interface FileTransferOffer

Returns:

The size.

getName

public java.lang.String getName()

Description copied from interface: FileTransferOffer

Gets the name of the file that the Sender wishes to send.

Specified by:

getName in interface FileTransferOffer

Returns:

The file name.

getDate

public java.time.Instant getDate()

Description copied from interface: FileTransferOffer

Gets the last modification time of the file.

Specified by:

getDate in interface FileTransferOffer

Returns:

The date.

getHashes

public java.util.List<Hash> getHashes()

Description copied from interface: FileTransferOffer

Gets the hashes of the file contents.

Specified by:

getHashes in interface FileTransferOffer

Returns:

The hashes.

getDescription

public java.lang.String getDescription()

Description copied from interface: FileTransferOffer

Gets a sender-generated description of the file.

Specified by:

getDescription in interface FileTransferOffer

Returns:

The description.

getRange

public Range getRange()

Description copied from interface: FileTransferOffer

Gets the range.

Specified by:

getRange in interface FileTransferOffer

Returns:

The range.

getSessionId

public java.lang.String getSessionId()