org.waarp.openr66.context

Class R66Session

java.lang.Object

org.waarp.openr66.context.R66Session

All Implemented Interfaces:

SessionInterface

public class R66Session
extends Object
implements SessionInterface

The global object session in OpenR66, a session by local channel

Constructor Summary

Constructors

Constructor and Description
R66Session() Create the session
R66Session(boolean noBuffer) Create the session without Buffers

Method Summary

Modifier and Type	Method and Description
boolean	addError()
void	clear() Clean the session
R66Auth	getAuth()
int	getBlockSize()
R66BusinessInterface	getBusinessObject()
static ZstdCompressionCodecDataPacket	getCodec()
int	getCompressionMaxSize()
FilesystemBasedDigest	getDigestBlock()
R66Dir	getDir()
HashMap<String,R66Dir>	getDirsFromSession()
boolean	getExtendedProtocol()
R66File	getFile()
FilesystemBasedFileParameterImpl	getFileParameter()
SocketAddress	getLocalAddress()
LocalChannelReference	getLocalChannelReference()
SocketAddress	getRemoteAddress()
R66Restart	getRestart()
byte[]	getReusableBuffer(int length)
byte[]	getReusableDataPacketBuffer(int length)
DbTaskRunner	getRunner()
byte[]	getSessionReusableCompressionBuffer(int length)
R66FiniteDualStates	getState()
String	getUniqueExtension()
void	initializeDigest() Initialize per block digest
boolean	isAuthenticated()
boolean	isCompressionEnabled()
boolean	isReady()
boolean	isSender()
void	newState(R66FiniteDualStates desiredstate) Propose a new State
void	partialClear()
void	renameReceiverFile(String newFilename) Rename the current receive file from the very beginning since the sender has a post action that changes its name
void	setBadRunner(DbTaskRunner runner, ErrorCode code) To be used when a request comes with a bad code so it cannot be set normally
void	setBlockSize(int blocksize)
void	setBusinessObject(R66BusinessInterface businessObject)
void	setCompressionEnabled(boolean compressionEnabled)
void	setErrorState()
void	setFileAfterPreRunner(boolean createFile) Set the File from the runner once PRE operation are done
void	setFileAfterPreRunnerReceiver(boolean createFile) Set the File from the runner once PRE operation are done, only for Receiver
void	setFileBeforePreRunner() Set the File from the runner before PRE operation are done
void	setFinalizeTransfer(boolean status, R66Result finalValue) Finalize the transfer step by running the error or post operation according to the status.
void	setLocalChannelReference(LocalChannelReference localChannelReference)
void	setNoSessionRunner(DbTaskRunner runner, LocalChannelReference localChannelReference) To be called in case of No Session not from a valid LocalChannelHandler
void	setReady(boolean isReady)
void	setRunner(DbTaskRunner runner) Set the runner, and setup the directory first.
void	setStatus(int stat) Debugging purpose (trace)
void	startup(boolean checkNotExternal) START from the PreTask if necessary, and prepare the file
String	toString()
void	tryFinalizeRequest(R66Result errorValue) Try to finalize the request if possible

Methods inherited from class java.lang.Object

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

Constructor Detail

R66Session

public R66Session()

Create the session

R66Session

public R66Session(boolean noBuffer)

Create the session without Buffers

Method Detail

getCodec

public static ZstdCompressionCodecDataPacket getCodec()

Returns:

the compression codec

getExtendedProtocol

public final boolean getExtendedProtocol()

Returns:

extendedProtocol

getBusinessObject

public final R66BusinessInterface getBusinessObject()

Returns:

the businessObject

setBusinessObject

public final void setBusinessObject(R66BusinessInterface businessObject)

Parameters:

businessObject - the businessObject to set

newState

public final void newState(R66FiniteDualStates desiredstate)

Propose a new State

Parameters:

desiredstate -

Throws:

IllegalFiniteStateException - if the new status if not ok

setErrorState

public final void setErrorState()

getState

public final R66FiniteDualStates getState()

Returns:

the current state in the finite state machine

setStatus

public final void setStatus(int stat)

Debugging purpose (trace)

Parameters:

stat -

clear

public final void clear()

Description copied from interface: SessionInterface

Clean the session

Specified by:

clear in interface SessionInterface

partialClear

public final void partialClear()

getAuth

public final R66Auth getAuth()

Specified by:

getAuth in interface SessionInterface

Returns:

the AuthInterface

getBlockSize

public final int getBlockSize()

Specified by:

getBlockSize in interface SessionInterface

Returns:

the BlockSize to use in FileInterface operations

setBlockSize

public final void setBlockSize(int blocksize)

Parameters:

blocksize - the blocksize to set

getReusableBuffer

public final byte[] getReusableBuffer(int length)

Parameters:

length - the target size

Returns:

the reusable buffer for sending per Session

getReusableDataPacketBuffer

public final byte[] getReusableDataPacketBuffer(int length)

Parameters:

length - the target size

Returns:

the reusable buffer for received DataPacket per Session

getSessionReusableCompressionBuffer

public final byte[] getSessionReusableCompressionBuffer(int length)

Parameters:

length - the original size

Returns:

the possible reusable compression buffer per Session

isCompressionEnabled

public final boolean isCompressionEnabled()

Returns:

True if compression is enabled in this session

setCompressionEnabled

public final void setCompressionEnabled(boolean compressionEnabled)

Parameters:

compressionEnabled - True if compression is enabled in this session

getCompressionMaxSize

public final int getCompressionMaxSize()

Returns:

the current max compression size according to block size

initializeDigest

public final void initializeDigest()

Initialize per block digest

getDigestBlock

public final FilesystemBasedDigest getDigestBlock()

Returns:

the digest used per block

getDir

public final R66Dir getDir()

Specified by:

getDir in interface SessionInterface

Returns:

the DirInterface

getFileParameter

public final FilesystemBasedFileParameterImpl getFileParameter()

Specified by:

getFileParameter in interface SessionInterface

Returns:

the configuration

getRestart

public final R66Restart getRestart()

Specified by:

getRestart in interface SessionInterface

Returns:

the Restart

isAuthenticated

public final boolean isAuthenticated()

Returns:

True if the connection is currently authenticated

isReady

public final boolean isReady()

Returns:

True if the Channel is ready to accept transfer

setReady

public final void setReady(boolean isReady)

Parameters:

isReady - the isReady for transfer to set

getRunner

public final DbTaskRunner getRunner()

Returns:

the runner

setLocalChannelReference

public final void setLocalChannelReference(LocalChannelReference localChannelReference)

Parameters:

localChannelReference - the localChannelReference to set

getRemoteAddress

public final SocketAddress getRemoteAddress()

Returns:

the remote SocketAddress

getLocalAddress

public final SocketAddress getLocalAddress()

Returns:

the local SocketAddress

getLocalChannelReference

public final LocalChannelReference getLocalChannelReference()

Returns:

the localChannelReference

setNoSessionRunner

public final void setNoSessionRunner(DbTaskRunner runner,
                                     LocalChannelReference localChannelReference)

To be called in case of No Session not from a valid LocalChannelHandler

Parameters:

runner -

localChannelReference -

setFileBeforePreRunner

public final void setFileBeforePreRunner()
                                  throws OpenR66RunnerErrorException

Set the File from the runner before PRE operation are done

Throws:

OpenR66RunnerErrorException

setFileAfterPreRunnerReceiver

public final void setFileAfterPreRunnerReceiver(boolean createFile)
                                         throws OpenR66RunnerErrorException,
                                                CommandAbstractException

Set the File from the runner once PRE operation are done, only for Receiver

Parameters:

createFile - When True, the file can be newly created if needed. If False, no new file will be created, thus having an Exception.

Throws:

OpenR66RunnerErrorException

CommandAbstractException - only when new received created file cannot be created

setFileAfterPreRunner

public final void setFileAfterPreRunner(boolean createFile)
                                 throws OpenR66RunnerErrorException,
                                        CommandAbstractException

Set the File from the runner once PRE operation are done

Parameters:

createFile - When True, the file can be newly created if needed. If False, no new file will be created, thus having an Exception.

Throws:

OpenR66RunnerErrorException

CommandAbstractException - only when new received created file cannot be created

setBadRunner

public final void setBadRunner(DbTaskRunner runner,
                               ErrorCode code)

To be used when a request comes with a bad code so it cannot be set normally

Parameters:

runner -

code -

setRunner

public final void setRunner(DbTaskRunner runner)
                     throws OpenR66RunnerErrorException

Set the runner, and setup the directory first.

This call should be followed by a startup() call.

Parameters:

runner - the runner to set

Throws:

OpenR66RunnerErrorException

startup

public final void startup(boolean checkNotExternal)
                   throws OpenR66RunnerErrorException

START from the PreTask if necessary, and prepare the file

Parameters:

checkNotExternal - if True, the file as Sender should not be external to current directory

Throws:

OpenR66RunnerErrorException

renameReceiverFile

public final void renameReceiverFile(String newFilename)
                              throws OpenR66RunnerErrorException

Rename the current receive file from the very beginning since the sender has a post action that changes its name

Parameters:

newFilename -

Throws:

OpenR66RunnerErrorException

setFinalizeTransfer

public final void setFinalizeTransfer(boolean status,
                                      R66Result finalValue)
                               throws OpenR66RunnerErrorException,
                                      OpenR66ProtocolSystemException

Finalize the transfer step by running the error or post operation according to the status.

Parameters:

status -

finalValue -

Throws:

OpenR66RunnerErrorException

OpenR66ProtocolSystemException

tryFinalizeRequest

public final void tryFinalizeRequest(R66Result errorValue)
                              throws OpenR66RunnerErrorException,
                                     OpenR66ProtocolSystemException

Try to finalize the request if possible

Parameters:

errorValue -

Throws:

OpenR66RunnerErrorException

OpenR66ProtocolSystemException

getFile

public final R66File getFile()

Returns:

the file

addError

public final boolean addError()

Returns:

True if the number of Error is still acceptable

toString

public final String toString()

Overrides:

toString in class Object

getUniqueExtension

public final String getUniqueExtension()

Specified by:

getUniqueExtension in interface SessionInterface

Returns:

the extension to give to Unique File (STOU)

getDirsFromSession

public final HashMap<String,R66Dir> getDirsFromSession()

Returns:

the dirsFromSession

isSender

public final boolean isSender()

Returns:

True if according to session, it is the sender side (to byPass send to itself issue)