org.waarp.openr66.protocol.localhandler.packet

Class RequestPacket

java.lang.Object

org.waarp.openr66.protocol.localhandler.packet.AbstractLocalPacket

org.waarp.openr66.protocol.localhandler.packet.RequestPacket

public class RequestPacket
extends AbstractLocalPacket

Request class

header = "rulename MODETRANS" middle = way+"FILENAME BLOCKSIZE RANK specialId code (optional length)" end = "fileInformation"

or

header = "{rule:rulename, mode:MODETRANS}" middle = way{filename:FILENAME, block:BLOCKSIZE, rank:RANK, id:specialId, code:code, length:length}" end = "fileInformation"

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RequestPacket.FIELDS
static class	RequestPacket.TRANSFERMODE

Field Summary

Fields

Modifier and Type	Field and Description
protected int	blocksize
protected char	code
protected String	fileInformation
protected String	filename
protected long	limit
protected int	mode
protected long	originalSize
protected int	rank
protected static byte	REQANSWERVALIDATE
protected static byte	REQVALIDATE
protected String	rulename
protected String	separator
protected long	specialId
protected byte	way

Fields inherited from class org.waarp.openr66.protocol.localhandler.packet.AbstractLocalPacket

end, header, middle

Constructor Summary

Constructors

Constructor and Description
RequestPacket(String rulename, int mode, String filename, int blocksize, int rank, long specialId, String fileInformation, long originalSize, String separator)

Method Summary

Modifier and Type	Method and Description
void	createEnd(LocalChannelReference lcr) Prepare the End buffer
static RequestPacket	createFromBuffer(int headerLength, int middleLength, int endLength, io.netty.buffer.ByteBuf buf)
void	createHeader(LocalChannelReference lcr) Prepare the Header buffer
void	createMiddle(LocalChannelReference lcr) Prepare the Middle buffer
int	getBlocksize()
char	getCode()
String	getFileInformation()
String	getFilename()
long	getLimit()
int	getMode()
static int	getModeMD5(int mode)
long	getOriginalSize()
int	getRank()
String	getRulename()
long	getSpecialId()
byte	getType()
static boolean	isCompatibleMode(int mode1, int mode2)
static boolean	isMD5Mode(int mode)
static boolean	isRecvMode(int mode)
static boolean	isRecvThroughMode(int mode)
static boolean	isRecvThroughMode(int mode, boolean isRequested)
boolean	isRetrieve()
static boolean	isSendMode(int mode)
static boolean	isSendThroughMode(int mode)
static boolean	isSendThroughMode(int mode, boolean isRequested)
static boolean	isThroughMode(int mode)
boolean	isToValidate()
void	setCode(char code)
void	setFilename(String filename)
void	setLimit(long limit)
void	setOriginalSize(long originalSize)
void	setRank(int rank)
void	setSpecialId(long specialId)
String	toString()
void	validate() Validate the request

Methods inherited from class org.waarp.openr66.protocol.localhandler.packet.AbstractLocalPacket

clear, getLocalPacket, retain

Methods inherited from class java.lang.Object

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

Field Detail

REQVALIDATE

protected static final byte REQVALIDATE

See Also:

Constant Field Values

REQANSWERVALIDATE

protected static final byte REQANSWERVALIDATE

See Also:

Constant Field Values

rulename

protected final String rulename

mode

protected final int mode

filename

protected String filename

blocksize

protected final int blocksize

rank

protected int rank

specialId

protected long specialId

way

protected byte way

code

protected char code

originalSize

protected long originalSize

limit

protected long limit

fileInformation

protected final String fileInformation

separator

protected String separator

Constructor Detail

RequestPacket

public RequestPacket(String rulename,
                     int mode,
                     String filename,
                     int blocksize,
                     int rank,
                     long specialId,
                     String fileInformation,
                     long originalSize,
                     String separator)

Parameters:

rulename -

mode -

filename -

blocksize -

rank -

specialId -

fileInformation -

Method Detail

getModeMD5

public static final int getModeMD5(int mode)

Parameters:

mode -

Returns:

the same mode (RECV or SEND) in MD5 version

isRecvMode

public static final boolean isRecvMode(int mode)

Parameters:

mode -

Returns:

true if this mode is a RECV(MD5) mode

isSendThroughMode

public static final boolean isSendThroughMode(int mode,
                                              boolean isRequested)

Parameters:

mode -

isRequested -

Returns:

True if this mode is a THROUGH (MD5) mode

isSendThroughMode

public static final boolean isSendThroughMode(int mode)

Parameters:

mode -

Returns:

True if this mode is a SEND THROUGH (MD5) mode

isRecvThroughMode

public static final boolean isRecvThroughMode(int mode,
                                              boolean isRequested)

Parameters:

mode -

isRequested -

Returns:

True if this mode is a THROUGH (MD5) mode

isRecvThroughMode

public static final boolean isRecvThroughMode(int mode)

Parameters:

mode -

Returns:

True if this mode is a RECV THROUGH (MD5) mode

isSendMode

public static final boolean isSendMode(int mode)

isThroughMode

public static final boolean isThroughMode(int mode)

Parameters:

mode -

Returns:

True if this mode is a THROUGH mode (with or without MD5)

isMD5Mode

public static final boolean isMD5Mode(int mode)

Parameters:

mode -

Returns:

true if this mode is a MD5 mode

isCompatibleMode

public static final boolean isCompatibleMode(int mode1,
                                             int mode2)

Parameters:

mode1 -

mode2 -

Returns:

true if both modes are compatible (both send, or both recv)

createFromBuffer

public static RequestPacket createFromBuffer(int headerLength,
                                             int middleLength,
                                             int endLength,
                                             io.netty.buffer.ByteBuf buf)
                                      throws OpenR66ProtocolPacketException

Parameters:

headerLength -

middleLength -

endLength -

buf -

Returns:

the new RequestPacket from buffer

Throws:

OpenR66ProtocolPacketException

createEnd

public void createEnd(LocalChannelReference lcr)
               throws OpenR66ProtocolPacketException

Description copied from class: AbstractLocalPacket

Prepare the End buffer

Specified by:

createEnd in class AbstractLocalPacket

Throws:

OpenR66ProtocolPacketException

createHeader

public void createHeader(LocalChannelReference lcr)
                  throws OpenR66ProtocolPacketException

Description copied from class: AbstractLocalPacket

Prepare the Header buffer

Specified by:

createHeader in class AbstractLocalPacket

Throws:

OpenR66ProtocolPacketException

createMiddle

public void createMiddle(LocalChannelReference lcr)
                  throws OpenR66ProtocolPacketException

Description copied from class: AbstractLocalPacket

Prepare the Middle buffer

Specified by:

createMiddle in class AbstractLocalPacket

Throws:

OpenR66ProtocolPacketException

getType

public byte getType()

Specified by:

getType in class AbstractLocalPacket

Returns:

the type of Packet

toString

public String toString()

Specified by:

toString in class AbstractLocalPacket

getRulename

public String getRulename()

Returns:

the rulename

getFilename

public String getFilename()

Returns:

the filename

getMode

public int getMode()

Returns:

the mode

isRetrieve

public boolean isRetrieve()

Returns:

True if this packet concerns a Retrieve operation

getFileInformation

public String getFileInformation()

Returns:

the fileInformation

getBlocksize

public int getBlocksize()

Returns:

the blocksize

getRank

public int getRank()

Returns:

the rank

setRank

public void setRank(int rank)

Parameters:

rank - the rank to set

getOriginalSize

public long getOriginalSize()

Returns:

the originalSize

setOriginalSize

public void setOriginalSize(long originalSize)

Parameters:

originalSize - the originalSize to set

setSpecialId

public void setSpecialId(long specialId)

Parameters:

specialId - the specialId to set

getSpecialId

public long getSpecialId()

Returns:

the specialId

isToValidate

public boolean isToValidate()

Returns:

True if this packet is to be validated

validate

public void validate()

Validate the request

setFilename

public void setFilename(String filename)

Parameters:

filename - the filename to set

getCode

public char getCode()

Returns:

the code

setCode

public void setCode(char code)

Parameters:

code - the code to set

getLimit

public long getLimit()

setLimit

public void setLimit(long limit)