Package dk.netarkivet.archive.bitarchive.distribute

Class RemoveAndGetFileMessage

java.lang.Object

dk.netarkivet.common.distribute.NetarkivetMessage

dk.netarkivet.archive.distribute.ArchiveMessage

dk.netarkivet.archive.bitarchive.distribute.RemoveAndGetFileMessage

All Implemented Interfaces:

java.io.Serializable

public class RemoveAndGetFileMessage
extends ArchiveMessage

Message requesting a file to be removed and returned from a bitarchive. Messages is forwarded through arcrepository, but reponds directly to sender.

See Also:

Serialized Form

Field Summary

Fields inherited from class dk.netarkivet.common.distribute.NetarkivetMessage

replyOfId

Constructor Summary

Constructors

Constructor	Description
RemoveAndGetFileMessage(ChannelID to, ChannelID replyTo, java.lang.String fileName, java.lang.String replicaId, java.lang.String checksum, java.lang.String credentials)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	accept(ArchiveMessageVisitor v)	Should be implemented as a part of the visitor pattern.
void	clearBuffer()	Clear content buffer.
java.lang.String	getCheckSum()	Get the checksum of the file to remove.
java.lang.String	getCredentials()	Get the credentials for the remove operation.
java.io.File	getData()	Writes the the content of the retrieved file into a local file.
java.lang.String	getFileName()	Get name of the file to retrieve.
RemoteFile	getRemoteFile()	Returns the remote file.
java.lang.String	getReplicaId()	Retrieve the replica id.
void	setFile(java.io.File data)	Set the file this message should remove and return.
java.lang.String	toString()	Retrieval of a string representation of this instance.

Methods inherited from class dk.netarkivet.common.distribute.NetarkivetMessage

getErrMsg, getID, getReplyOfId, getReplyTo, getTo, hasBeenSent, isOk, setNotOk, setNotOk

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoveAndGetFileMessage

public RemoveAndGetFileMessage(ChannelID to,
                               ChannelID replyTo,
                               java.lang.String fileName,
                               java.lang.String replicaId,
                               java.lang.String checksum,
                               java.lang.String credentials)

Constructor.

Parameters:

to - Where to send the message.

replyTo - Where the reply of the message should be sent.

fileName - The name of the file to remove and retrieve.

replicaId - The id of the replica to sent it to.

checksum - The checksum of the bad file to remove and retrieve.

credentials - The right credentials for the operation.

Method Detail

setFile

public void setFile(java.io.File data)
             throws ArgumentNotValid

Set the file this message should remove and return. Note: This will make a remote file handle for the file.

Parameters:

data - Content of the file to retrieve

Throws:

ArgumentNotValid - If the data file is null.

getData

public java.io.File getData()
                     throws IOFailure

Writes the the content of the retrieved file into a local file. Note: This is transferred through a remote file handle, and then the handle is invalidated. This method may only be called once.

Returns:

file content

Throws:

IOFailure - on error reading the file

getRemoteFile

public RemoteFile getRemoteFile()

Returns the remote file.

Returns:

The remote file.

getReplicaId

public java.lang.String getReplicaId()

Retrieve the replica id.

Returns:

replica id

getFileName

public java.lang.String getFileName()

Get name of the file to retrieve.

Returns:

file name

getCheckSum

public java.lang.String getCheckSum()

Get the checksum of the file to remove.

Returns:

the checksum of the file to remove

getCredentials

public java.lang.String getCredentials()

Get the credentials for the remove operation.

Returns:

the credentials for the remove operation

clearBuffer

public void clearBuffer()

Clear content buffer.

accept

public void accept(ArchiveMessageVisitor v)

Should be implemented as a part of the visitor pattern. fx.: public void accept(ArchiveMessageVisitor v) { v.visit(this); }

Specified by:

accept in class ArchiveMessage

Parameters:

v - A message visitor

See Also:

ArchiveMessageVisitor

toString

public java.lang.String toString()

Retrieval of a string representation of this instance.

Overrides:

toString in class NetarkivetMessage

Returns:

The string representation of this instance.

See Also:

NetarkivetMessage.toString()