NTTransPacket (Alfresco JLan 6.4.2 API)

java.lang.Object
- org.alfresco.jlan.client.SMBPacket
- - org.alfresco.jlan.client.NTTransPacket

public class NTTransPacket
extends SMBPacket

NT Transaction Packet Class

Author:: gkspencer

Field Summary
- Fields inherited from class org.alfresco.jlan.client.SMBPacket
  ANDXCOMMAND, ANDXRESERVED, COMMAND, DEFAULT_BUFSIZE, ERROR, ERRORCLASS, ERRORCODE, FLAGS, FLAGS2, FLG_CANONICAL, FLG_CASELESS, FLG_NOTIFY, FLG_OPLOCK, FLG_RESPONSE, FLG_SUBDIALECT, FLG2_EXTENDEDATTRIB, FLG2_EXTENDEDSETUP, FLG2_LONGERRORCODE, FLG2_LONGFILENAMES, FLG2_READIFEXE, FLG2_SECURITYSIG, FLG2_UNICODE, m_endpos, m_lastTxTime, m_pos, MID, MIN_RXLEN, PARAMWORDS, PID, PIDHIGH, RAW_READ, RAW_WRITE, SEC_ENCRYPT, SEC_USER, SEQNO, SID, SIGNATURE, SMBHEADER, TID, TRANS_HEADERLEN, UID, WORDCNT

Constructor Summary

Constructors
Constructor and Description

NTTransPacket()
Default constructor

NTTransPacket(byte[] buf)
Class constructor

Constructors
Constructor and Description
`NTTransPacket()` Default constructor
`NTTransPacket(byte[] buf)` Class constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransactBuffer`	`doTransaction(Session sess, TransactBuffer tbuf)` Perform a transaction request and receive the response data
`int`	`getDataBlockCount()` Return the data block count
`int`	`getDataBlockDisplacement()` Return the data block displacment
`int`	`getDataBlockOffset()` Return the data block offset
`int`	`getDataLength()` Return the data block size
`int`	`getDataOffset()` Return the data block offset
`int`	`getNTFunction()` Get the NT transaction function code
`int[]`	`getParameterBlock()` Unpack the parameter block
`int`	`getParameterBlockCount()` Return the parameter block count
`int`	`getParameterBlockDisplacement()` Return the paramater block displacement
`int`	`getParameterBlockOffset()` Return the parameter block offset
`int`	`getSetupCount()` Get the setup parameter count
`int`	`getSetupOffset()` Return the offset to the setup words data
`int`	`getTotalDataCount()` Return the total data count
`int`	`getTotalParameterCount()` Return the total parameter count
`void`	`InitializeNTTransact(int func, byte[] paramblk, int plen, byte[] datablk, int dlen, int setupcnt)` Initialize the transact SMB packet
`void`	`InitializeNTTransact(int func, byte[] paramblk, int plen, byte[] datablk, int dlen, int setupcnt, int maxPrm, int maxData)` Initialize the transact SMB packet
`void`	`resetDataBlockPointer()` Reset the byte/parameter pointer area for packing/unpacking the transaction data block
`void`	`resetParameterBlockPointer()` Reset the byte/parameter pointer area for packing/unpacking the transaction paramater block
`void`	`resetSetupPointer()` Reset the byte/parameter pointer area for packing/unpacking setup paramaters items to the packet
`void`	`setDataBlockCount(int cnt)` Set the data block count
`void`	`setDataBlockOffset(int off)` Set the data block offset
`void`	`setMaximumDataReturn(int cnt)` Set the maximum return data count
`void`	`setMaximumParameterReturn(int cnt)` Set the maximum return parameter count
`void`	`setMaximumSetupCount(int cnt)` Set the maximum setup parameter count
`void`	`setNTFunction(int func)` Set the NT transaction function code
`void`	`setNTParameterCount(int cnt)` Set the paramater block count
`void`	`setParameterBlockOffset(int off)` Set the parameter block offset within the packet
`void`	`setSetupCount(int cnt)` Set the setup parameter count
`void`	`setTotalDataCount(int cnt)` Set the total data count
`void`	`setTotalParameterCount(int cnt)` Set the total parameter count

Methods inherited from class org.alfresco.jlan.client.SMBPacket
alignBytePointer, checkForError, clearBytes, DumpPacket, equalsError, ExchangeLowLevelSMB, ExchangeSMB, ExchangeSMB, getAndXCommand, getAvailableLength, getBuffer, getBufferLength, getByteCount, getByteOffset, getCommand, getErrorClass, getErrorCode, getFlags, getFlags2, getFlags2AsString, getFlagsAsString, getLastPacketSendTime, getLength, getLongErrorCode, getMultiplexId, getParameter, getParameterCount, getParameterLong, getPosition, getProcessId, getSignature, getTreeId, getUserId, hasExtendedSetup, hasLongErrorCode, hasMoreData, hasSecuritySignature, isCaseless, isLongErrorCode, isLongFileNames, isRequest, isResponse, isType, isUnicode, isValidResponse, packByte, packByte, packBytes, packInt, packLong, packString, packWord, ReceiveAsynchSMB, ReceiveSMB, ReceiveSMB, resetBytePointer, resetBytePointerAlign, resetParameterPointer, SendSMB, setAndXCommand, setByteCount, setByteCount, setBytePointer, setBytes, setCommand, setErrorClass, setErrorCode, setFlags, setFlags2, setLongErrorCode, setMultiplexId, setParameter, setParameterCount, setParameterLong, setPosition, setProcessId, setSeqNo, setSID, setSignature, setSignature, setSignature, setTreeId, setUserId, skipBytes, unpackByte, unpackBytes, unpackInt, unpackLong, unpackString, unpackString, unpackWord

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NTTransPacket
```
public NTTransPacket()
```
    Default constructor
  - NTTransPacket
```
public NTTransPacket(byte[] buf)
```
    Class constructor
    
    Parameters:
    
    buf - byte[]
- Method Detail
  - getDataLength
```
public final int getDataLength()
```
    Return the data block size
    
    Returns:
    
    Data block size in bytes
  - getDataOffset
```
public final int getDataOffset()
```
    Return the data block offset
    
    Returns:
    
    Data block offset within the SMB packet.
  - getParameterBlock
```
public final int[] getParameterBlock()
```
    Unpack the parameter block
    
    Returns:
    
    int[]
  - getTotalParameterCount
```
public final int getTotalParameterCount()
```
    Return the total parameter count
    
    Returns:
    
    int
  - getTotalDataCount
```
public final int getTotalDataCount()
```
    Return the total data count
    
    Returns:
    
    int
  - getParameterBlockCount
```
public final int getParameterBlockCount()
```
    Return the parameter block count
    
    Returns:
    
    int
  - getParameterBlockOffset
```
public final int getParameterBlockOffset()
```
    Return the parameter block offset
    
    Returns:
    
    int
  - getParameterBlockDisplacement
```
public final int getParameterBlockDisplacement()
```
    Return the paramater block displacement
    
    Returns:
    
    int
  - getDataBlockCount
```
public final int getDataBlockCount()
```
    Return the data block count
    
    Returns:
    
    int
  - getDataBlockOffset
```
public final int getDataBlockOffset()
```
    Return the data block offset
    
    Returns:
    
    int
  - getDataBlockDisplacement
```
public final int getDataBlockDisplacement()
```
    Return the data block displacment
    
    Returns:
    
    int
  - InitializeNTTransact
```
public final void InitializeNTTransact(int func,
                                       byte[] paramblk,
                                       int plen,
                                       byte[] datablk,
                                       int dlen,
                                       int setupcnt)
```
    Initialize the transact SMB packet
    
    Parameters:
    
    func - NT transaction function code
    
    paramblk - Parameter block data bytes
    
    plen - Parameter block data length
    
    datablk - Data block data bytes
    
    dlen - Data block data length
    
    setupcnt - Number of setup parameters
  - InitializeNTTransact
```
public final void InitializeNTTransact(int func,
                                       byte[] paramblk,
                                       int plen,
                                       byte[] datablk,
                                       int dlen,
                                       int setupcnt,
                                       int maxPrm,
                                       int maxData)
```
    Initialize the transact SMB packet
    
    Parameters:
    
    func - NT transaction function code
    
    paramblk - Parameter block data bytes
    
    plen - Parameter block data length
    
    datablk - Data block data bytes
    
    dlen - Data block data length
    
    setupcnt - Number of setup parameters
    
    maxPrm - Maximum parameter bytes to return
    
    maxData - Maximum data bytes to return
  - doTransaction
```
public final TransactBuffer doTransaction(Session sess,
                                          TransactBuffer tbuf)
                                   throws IOException,
                                          SMBException
```
    Perform a transaction request and receive the response data
    
    Parameters:
    
    sess - Session
    
    tbuf - TransactBuffer
    
    Returns:
    
    TransactBuffer
    
    Throws:
    
    IOException
    
    SMBException
  - setTotalParameterCount
```
public final void setTotalParameterCount(int cnt)
```
    Set the total parameter count
    
    Parameters:
    
    cnt - int
  - setTotalDataCount
```
public final void setTotalDataCount(int cnt)
```
    Set the total data count
    
    Parameters:
    
    cnt - int
  - setMaximumParameterReturn
```
public final void setMaximumParameterReturn(int cnt)
```
    Set the maximum return parameter count
    
    Parameters:
    
    cnt - int
  - setMaximumDataReturn
```
public final void setMaximumDataReturn(int cnt)
```
    Set the maximum return data count
    
    Parameters:
    
    cnt - int
  - setNTParameterCount
```
public final void setNTParameterCount(int cnt)
```
    Set the paramater block count
    
    Parameters:
    
    cnt - int
  - setParameterBlockOffset
```
public final void setParameterBlockOffset(int off)
```
    Set the parameter block offset within the packet
    
    Parameters:
    
    off - int
  - setDataBlockCount
```
public final void setDataBlockCount(int cnt)
```
    Set the data block count
    
    Parameters:
    
    cnt - int
  - setDataBlockOffset
```
public final void setDataBlockOffset(int off)
```
    Set the data block offset
    
    Parameters:
    
    off - int
  - getSetupCount
```
public final int getSetupCount()
```
    Get the setup parameter count
    
    Returns:
    
    int
  - getSetupOffset
```
public final int getSetupOffset()
```
    Return the offset to the setup words data
    
    Returns:
    
    int
  - getNTFunction
```
public final int getNTFunction()
```
    Get the NT transaction function code
    
    Returns:
    
    int
  - setMaximumSetupCount
```
public final void setMaximumSetupCount(int cnt)
```
    Set the maximum setup parameter count
    
    Parameters:
    
    cnt - Maximum count of setup paramater words
  - setSetupCount
```
public final void setSetupCount(int cnt)
```
    Set the setup parameter count
    
    Parameters:
    
    cnt - Count of setup paramater words
  - setNTFunction
```
public final void setNTFunction(int func)
```
    Set the NT transaction function code
    
    Parameters:
    
    func - int
  - resetSetupPointer
```
public final void resetSetupPointer()
```
    Reset the byte/parameter pointer area for packing/unpacking setup paramaters items to the packet
  - resetDataBlockPointer
```
public final void resetDataBlockPointer()
```
    Reset the byte/parameter pointer area for packing/unpacking the transaction data block
  - resetParameterBlockPointer
```
public final void resetParameterBlockPointer()
```
    Reset the byte/parameter pointer area for packing/unpacking the transaction paramater block

Class NTTransPacket

Field Summary

Fields inherited from class org.alfresco.jlan.client.SMBPacket

Constructor Summary

Method Summary

Methods inherited from class org.alfresco.jlan.client.SMBPacket

Methods inherited from class java.lang.Object

Constructor Detail

NTTransPacket

NTTransPacket

Method Detail

getDataLength

getDataOffset

getParameterBlock

getTotalParameterCount

getTotalDataCount

getParameterBlockCount

getParameterBlockOffset

getParameterBlockDisplacement

getDataBlockCount

getDataBlockOffset

getDataBlockDisplacement

InitializeNTTransact

InitializeNTTransact

doTransaction

setTotalParameterCount

setTotalDataCount

setMaximumParameterReturn

setMaximumDataReturn

setNTParameterCount

setParameterBlockOffset

setDataBlockCount

setDataBlockOffset

getSetupCount

getSetupOffset

getNTFunction

setMaximumSetupCount

setSetupCount

setNTFunction

resetSetupPointer

resetDataBlockPointer

resetParameterBlockPointer