org.waarp.common.file

Class Restart

java.lang.Object

org.waarp.common.file.Restart

Direct Known Subclasses:

FilesystemBasedRestartImpl

public abstract class Restart
extends Object

Restart object that implements the REST command.
Note that if necessary, according to the implementation of DirInterface and FileInterface, one could want to implement a way to store or retrieve Marker from/to the client specification.

Author:

Frederic Bregier

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Restart(SessionInterface session) Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
abstract int	getMaxSize(int nextBlock)
abstract long	getPosition()
protected SessionInterface	getSession()
protected boolean	isSet()
abstract boolean	restartMarker(String marker) Restart from a Marker for the next FileInterface
void	setSet(boolean isSet)

Methods inherited from class java.lang.Object

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

Constructor Detail

Restart

protected Restart(SessionInterface session)

Default constructor

Parameters:

session -

Method Detail

isSet

protected boolean isSet()

Returns:

the isSet

setSet

public void setSet(boolean isSet)

Parameters:

isSet - the isSet to set

getSession

protected SessionInterface getSession()

Returns:

the session

restartMarker

public abstract boolean restartMarker(String marker)
                               throws CommandAbstractException

Restart from a Marker for the next FileInterface

Parameters:

marker -

Returns:

True if the Marker is OK

Throws:

CommandAbstractException

getPosition

public abstract long getPosition()
                          throws NoRestartException

Returns:

the position from a previous REST command

Throws:

NoRestartException - if no REST command was issued before

getMaxSize

public abstract int getMaxSize(int nextBlock)

Parameters:

nextBlock -

Returns:

the max between the available size and the nextblock size