RequestPacket (Waarp All 3.6.2-jre8 API Reference)

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

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`	`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 String`	`transferInformation`
`protected byte`	`way`

Fields inherited from class org.waarp.openr66.protocol.localhandler.packet.AbstractLocalPacket
EMPTY_ARRAY, end, global, header, LOCAL_HEADER_SIZE, middle

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`createAllBuffers(LocalChannelReference lcr, int networkHeader)` Prepare the 3 buffers Header, Middle and End
`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`	`getFilename()`
`long`	`getLimit()`
`int`	`getMode()`
`static int`	`getModeMD5(int mode)`
`long`	`getOriginalSize()`
`int`	`getRank()`
`String`	`getRulename()`
`long`	`getSpecialId()`
`String`	`getTransferInformation()`
`byte`	`getType()`
`boolean`	`hasGlobalBuffer()`
`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, getLocalPacketForNetworkPacket, 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
```

transferInformation

protected final String transferInformation

separator
```
protected String separator
```

Constructor Detail

RequestPacket

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

Parameters:: rulename -; mode -; filename -; blocksize -; rank -; specialId -; transferInformation -

Method Detail
- getModeMD5
```
public static int getModeMD5(int mode)
```
  Parameters:
  
  mode -
  
  Returns:
  
  the same mode (RECV or SEND) in MD5 version
- isRecvMode
```
public static boolean isRecvMode(int mode)
```
  Parameters:
  
  mode -
  
  Returns:
  
  true if this mode is a RECV(MD5) mode
- isSendThroughMode
```
public static boolean isSendThroughMode(int mode,
                                        boolean isRequested)
```
  Parameters:
  
  mode -
  
  isRequested -
  
  Returns:
  
  True if this mode is a THROUGH (MD5) mode
- isSendThroughMode
```
public static boolean isSendThroughMode(int mode)
```
  Parameters:
  
  mode -
  
  Returns:
  
  True if this mode is a SEND THROUGH (MD5) mode
- isRecvThroughMode
```
public static boolean isRecvThroughMode(int mode,
                                        boolean isRequested)
```
  Parameters:
  
  mode -
  
  isRequested -
  
  Returns:
  
  True if this mode is a THROUGH (MD5) mode
- isRecvThroughMode
```
public static boolean isRecvThroughMode(int mode)
```
  Parameters:
  
  mode -
  
  Returns:
  
  True if this mode is a RECV THROUGH (MD5) mode
- isSendMode
```
public static boolean isSendMode(int mode)
```
- isThroughMode
```
public static boolean isThroughMode(int mode)
```
  Parameters:
  
  mode -
  
  Returns:
  
  True if this mode is a THROUGH mode (with or without MD5)
- isMD5Mode
```
public static boolean isMD5Mode(int mode)
```
  Parameters:
  
  mode -
  
  Returns:
  
  true if this mode is a MD5 mode
- isCompatibleMode
```
public static 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
- hasGlobalBuffer
```
public final boolean hasGlobalBuffer()
```
  Specified by:
  
  hasGlobalBuffer in class AbstractLocalPacket
  
  Returns:
  
  True if all buffers fit in one piece
- createAllBuffers
```
public final void createAllBuffers(LocalChannelReference lcr,
                                   int networkHeader)
```
  Description copied from class: AbstractLocalPacket
  
  Prepare the 3 buffers Header, Middle and End
  
  Specified by:
  
  createAllBuffers in class AbstractLocalPacket
- createEnd
```
public final void createEnd(LocalChannelReference lcr)
```
  Description copied from class: AbstractLocalPacket
  
  Prepare the End buffer
  
  Overrides:
  
  createEnd in class AbstractLocalPacket
- createHeader
```
public final void createHeader(LocalChannelReference lcr)
                        throws OpenR66ProtocolPacketException
```
  Description copied from class: AbstractLocalPacket
  
  Prepare the Header buffer
  
  Overrides:
  
  createHeader in class AbstractLocalPacket
  
  Throws:
  
  OpenR66ProtocolPacketException
- createMiddle
```
public final void createMiddle(LocalChannelReference lcr)
                        throws OpenR66ProtocolPacketException
```
  Description copied from class: AbstractLocalPacket
  
  Prepare the Middle buffer
  
  Overrides:
  
  createMiddle in class AbstractLocalPacket
  
  Throws:
  
  OpenR66ProtocolPacketException
- getType
```
public final byte getType()
```
  Specified by:
  
  getType in class AbstractLocalPacket
  
  Returns:
  
  the type of Packet
- toString
```
public final String toString()
```
  Specified by:
  
  toString in class AbstractLocalPacket
- getRulename
```
public final String getRulename()
```
  Returns:
  
  the rulename
- getFilename
```
public final String getFilename()
```
  Returns:
  
  the filename
- getMode
```
public final int getMode()
```
  Returns:
  
  the mode
- isRetrieve
```
public final boolean isRetrieve()
```
  Returns:
  
  True if this packet concerns a Retrieve operation
- getTransferInformation
```
public final String getTransferInformation()
```
  Returns:
  
  the fifinal Information
- getBlocksize
```
public final int getBlocksize()
```
  Returns:
  
  the blocksize
- getRank
```
public final int getRank()
```
  Returns:
  
  the rank
- setRank
```
public final void setRank(int rank)
```
  Parameters:
  
  rank - the rank to set
- getOriginalSize
```
public final long getOriginalSize()
```
  Returns:
  
  the originalSize
- setOriginalSize
```
public final void setOriginalSize(long originalSize)
```
  Parameters:
  
  originalSize - the originalSize to set
- setSpecialId
```
public final void setSpecialId(long specialId)
```
  Parameters:
  
  specialId - the specialId to set
- getSpecialId
```
public final long getSpecialId()
```
  Returns:
  
  the specialId
- isToValidate
```
public final boolean isToValidate()
```
  Returns:
  
  True if this packet is to be validated
- validate
```
public final void validate()
```
  Validate the request
- setFilename
```
public void setFilename(String filename)
```
  Parameters:
  
  filename - the filename to set
- getCode
```
public final char getCode()
```
  Returns:
  
  the code
- setCode
```
public final void setCode(char code)
```
  Parameters:
  
  code - the code to set
- getLimit
```
public final long getLimit()
```
- setLimit
```
public final void setLimit(long limit)
```

Class RequestPacket

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

REQVALIDATE

REQANSWERVALIDATE

rulename

mode

filename

blocksize

rank

specialId

way

code

originalSize

limit

transferInformation

separator

Constructor Detail

RequestPacket

Method Detail

getModeMD5

isRecvMode

isSendThroughMode

isSendThroughMode

isRecvThroughMode

isRecvThroughMode

isSendMode

isThroughMode

isMD5Mode

isCompatibleMode

createFromBuffer

hasGlobalBuffer

createAllBuffers

createEnd

createHeader

createMiddle

getType

toString

getRulename

getFilename

getMode

isRetrieve

getTransferInformation

getBlocksize

getRank

setRank

getOriginalSize

setOriginalSize

setSpecialId

getSpecialId

isToValidate

validate

setFilename

getCode

setCode

getLimit

setLimit