org.waarp.openr66.protocol.localhandler

Class LocalChannelReference

java.lang.Object

org.waarp.openr66.protocol.localhandler.LocalChannelReference

public class LocalChannelReference
extends Object

Reference of one object using Local Channel localId and containing local channel and network channel.

Constructor Summary

Constructors

Constructor and Description
LocalChannelReference() Special empty LCR constructor
LocalChannelReference(NetworkChannelReference networkChannelRef, Integer remoteId, R66Future futureRequest)

Method Summary

Modifier and Type	Method and Description
void	close() Close the localChannelReference
long	getChannelLimit(boolean isSender)
io.netty.handler.traffic.ChannelTrafficShapingHandler	getChannelTrafficShapingHandler()
ClientRunner	getClientRunner()
ErrorCode	getCurrentCode()
DbSession	getDbSession()
String	getErrorMessage()
R66Future	getFutureEndTransfer()
R66Future	getFutureRequest()
R66Future	getFutureValidateConnection()
R66Future	getFutureValidateStartup()
R66Future	getFutureValidRequest()
String	getHashComputeDuringTransfer()
Integer	getLocalId()
io.netty.channel.Channel	getNetworkChannel()
NetworkChannelReference	getNetworkChannelObject()
NetworkServerHandler	getNetworkServerHandler()
PartnerConfiguration	getPartner()
RecvThroughHandler	getRecvThroughHandler()
Integer	getRemoteId()
String	getRequestId()
TransferActions	getServerHandler()
R66Session	getSession()
R66FiniteDualStates	getSessionState()
void	invalidateRequest(R66Result finalvalue) Invalidate the current request
boolean	isConnectionValidate()
boolean	isPartialHash()
boolean	isRecvThroughMode()
boolean	isSendThroughMode()
void	sessionNewState(R66FiniteDualStates desiredState) Shortcut to set a new state in Session
void	setChannelLimit(boolean isSender, long limit)
void	setClientRunner(ClientRunner clientRunner)
void	setErrorMessage(String errorMessage, ErrorCode code)
void	setHashComputeDuringTransfer(String hashComputeDuringTransfer)
void	setPartialHash()
void	setPartner(String hostId)
void	setRecvThroughHandler(RecvThroughHandler recvThroughHandler)
void	setRemoteId(Integer remoteId)
void	setRequestId(String requestId)
void	setSendThroughMode(boolean isSendThroughMode)
void	setSession(R66Session session)
String	toString()
void	validateConnection(boolean validate, R66Result result) Validate or Invalidate the connection (authentication)
void	validateEndTransfer(R66Result finalValue) Validate the End of a Transfer
void	validateRequest(R66Result finalValue) Validate the current Request
void	validateStartup(boolean validate) Validate or not the Startup (before connection)
void	waitReadyForSendThrough() Special waiter for Send Through method.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalChannelReference

public LocalChannelReference(NetworkChannelReference networkChannelRef,
                             Integer remoteId,
                             R66Future futureRequest)
                      throws OpenR66ProtocolRemoteShutdownException

Parameters:

networkChannelRef -

remoteId -

futureRequest -

Throws:

OpenR66ProtocolRemoteShutdownException

LocalChannelReference

public LocalChannelReference()

Special empty LCR constructor

Method Detail

close

public final void close()

Close the localChannelReference

getNetworkChannel

public final io.netty.channel.Channel getNetworkChannel()

Returns:

the networkChannelRef

getLocalId

public final Integer getLocalId()

Returns:

the id

getRemoteId

public final Integer getRemoteId()

Returns:

the remoteId

getChannelTrafficShapingHandler

public final io.netty.handler.traffic.ChannelTrafficShapingHandler getChannelTrafficShapingHandler()

Returns:

the ChannelTrafficShapingHandler

getNetworkChannelObject

public final NetworkChannelReference getNetworkChannelObject()

Returns:

the networkChannelObject

getNetworkServerHandler

public final NetworkServerHandler getNetworkServerHandler()

Returns:

the networkServerHandler

getServerHandler

public final TransferActions getServerHandler()

Returns:

the serverHandler

getDbSession

public final DbSession getDbSession()

Returns:

the actual dbSession

setRemoteId

public final void setRemoteId(Integer remoteId)

Parameters:

remoteId - the remoteId to set

getSession

public final R66Session getSession()

Returns:

the session

setSession

public final void setSession(R66Session session)

Parameters:

session - the session to set

getErrorMessage

public final String getErrorMessage()

Returns:

the current errorMessage

setErrorMessage

public final void setErrorMessage(String errorMessage,
                                  ErrorCode code)

Parameters:

errorMessage - the errorMessage to set

getCurrentCode

public final ErrorCode getCurrentCode()

Returns:

the code

validateStartup

public final void validateStartup(boolean validate)

Validate or not the Startup (before connection)

Parameters:

validate -

getFutureValidateStartup

public final R66Future getFutureValidateStartup()

Returns:

the futureValidateStartup

isConnectionValidate

public final boolean isConnectionValidate()

Returns:

True if the connection is validated (in OK or KO status)

validateConnection

public final void validateConnection(boolean validate,
                                     R66Result result)

Validate or Invalidate the connection (authentication)

Parameters:

validate -

getFutureValidateConnection

public final R66Future getFutureValidateConnection()

Returns:

the futureValidateConnection

validateEndTransfer

public final void validateEndTransfer(R66Result finalValue)

Validate the End of a Transfer

Parameters:

finalValue -

getFutureEndTransfer

public final R66Future getFutureEndTransfer()

Returns:

the futureEndTransfer

waitReadyForSendThrough

public final void waitReadyForSendThrough()
                                   throws OpenR66Exception

Special waiter for Send Through method. It reset the EndTransfer future.

Throws:

OpenR66Exception

getFutureValidRequest

public final R66Future getFutureValidRequest()

Returns:

the futureValidRequest

getFutureRequest

public final R66Future getFutureRequest()

Returns:

the futureRequest

invalidateRequest

public final void invalidateRequest(R66Result finalvalue)

Invalidate the current request

Parameters:

finalvalue -

validateRequest

public final void validateRequest(R66Result finalValue)

Validate the current Request

Parameters:

finalValue -

setChannelLimit

public final void setChannelLimit(boolean isSender,
                                  long limit)

getChannelLimit

public final long getChannelLimit(boolean isSender)

toString

public final String toString()

Overrides:

toString in class Object

getRecvThroughHandler

public final RecvThroughHandler getRecvThroughHandler()

Returns:

the recvThroughHandler

isRecvThroughMode

public final boolean isRecvThroughMode()

Returns:

True if in RecvThrough Mode

setRecvThroughHandler

public final void setRecvThroughHandler(RecvThroughHandler recvThroughHandler)

Parameters:

recvThroughHandler - the recvThroughHandler to set

isSendThroughMode

public final boolean isSendThroughMode()

Returns:

True if in SendThrough Mode

setSendThroughMode

public final void setSendThroughMode(boolean isSendThroughMode)

Parameters:

isSendThroughMode - the isSendThroughMode to set

getClientRunner

public final ClientRunner getClientRunner()

Returns:

the clientRunner

setClientRunner

public final void setClientRunner(ClientRunner clientRunner)

Parameters:

clientRunner - the clientRunner to set

sessionNewState

public final void sessionNewState(R66FiniteDualStates desiredState)

Shortcut to set a new state in Session

Parameters:

desiredState -

getSessionState

public final R66FiniteDualStates getSessionState()

Returns:

the current state or TEST if no session exists

getHashComputeDuringTransfer

public final String getHashComputeDuringTransfer()

Returns:

the hashComputeDuringTransfer

setHashComputeDuringTransfer

public final void setHashComputeDuringTransfer(String hashComputeDuringTransfer)

Parameters:

hashComputeDuringTransfer - the hashComputeDuringTransfer to set

setPartialHash

public final void setPartialHash()

isPartialHash

public final boolean isPartialHash()

getPartner

public final PartnerConfiguration getPartner()

Returns:

the partner

setPartner

public final void setPartner(String hostId)

Parameters:

hostId - the partner to set

getRequestId

public final String getRequestId()

Returns:

the requestId

setRequestId

public final void setRequestId(String requestId)

Parameters:

requestId - the requestId to set