Module jcifs
Package org.codelibs.jcifs.smb.util.transport

Interface Message

All Known Subinterfaces:
CommonServerMessageBlock, CommonServerMessageBlockRequest, CommonServerMessageBlockResponse, NotifyResponse, Request<T>, Request, RequestWithPath, Response, SmbNegotiationResponse, TreeConnectResponse
All Known Implementing Classes:
AndXServerMessageBlock, NetServerEnum2, NetServerEnum2Response, NetShareEnum, NetShareEnumResponse, NtTransNotifyChange, NtTransNotifyChangeResponse, NtTransQuerySecurityDesc, NtTransQuerySecurityDescResponse, ServerMessageBlock, ServerMessageBlock2, ServerMessageBlock2Request, ServerMessageBlock2Response, Smb2CancelRequest, Smb2ChangeNotifyRequest, Smb2ChangeNotifyResponse, Smb2CloseRequest, Smb2CloseResponse, Smb2CreateRequest, Smb2CreateResponse, Smb2EchoRequest, Smb2EchoResponse, Smb2FlushRequest, Smb2FlushResponse, Smb2IoctlRequest, Smb2IoctlResponse, Smb2LockRequest, Smb2LockResponse, Smb2LogoffRequest, Smb2LogoffResponse, Smb2NegotiateRequest, Smb2NegotiateResponse, Smb2OplockBreakNotification, Smb2QueryDirectoryRequest, Smb2QueryDirectoryResponse, Smb2QueryInfoRequest, Smb2QueryInfoResponse, Smb2ReadRequest, Smb2ReadResponse, Smb2SessionSetupRequest, Smb2SessionSetupResponse, Smb2SetInfoRequest, Smb2SetInfoResponse, Smb2TreeConnectRequest, Smb2TreeConnectResponse, Smb2TreeDisconnectRequest, Smb2TreeDisconnectResponse, Smb2WriteRequest, Smb2WriteResponse, SmbComBlankResponse, SmbComClose, SmbComCreateDirectory, SmbComDelete, SmbComDeleteDirectory, SmbComFindClose2, SmbComLockingAndX, SmbComLogoffAndX, SmbComNegotiate, SmbComNegotiateResponse, SmbComNtCancel, SmbComNTCreateAndX, SmbComNTCreateAndXResponse, SmbComNtTransaction, SmbComNtTransactionResponse, SmbComOpenAndX, SmbComOpenAndXResponse, SmbComQueryInformation, SmbComQueryInformationResponse, SmbComReadAndX, SmbComReadAndXResponse, SmbComRename, SmbComSeek, SmbComSeekResponse, SmbComSessionSetupAndX, SmbComSessionSetupAndXResponse, SmbComSetInformation, SmbComSetInformationResponse, SmbComTransaction, SmbComTransactionResponse, SmbComTreeConnectAndX, SmbComTreeConnectAndXResponse, SmbComTreeDisconnect, SmbComWrite, SmbComWriteAndX, SmbComWriteAndXResponse, SmbComWriteResponse, Trans2FindFirst2, Trans2FindFirst2Response, Trans2FindNext2, Trans2GetDfsReferral, Trans2GetDfsReferralResponse, Trans2QueryFSInformation, Trans2QueryFSInformationResponse, Trans2QueryPathInformation, Trans2QueryPathInformationResponse, Trans2SetFileInformation, Trans2SetFileInformationResponse, TransCallNamedPipe, TransCallNamedPipeResponse, TransPeekNamedPipe, TransPeekNamedPipeResponse, TransTransactNamedPipe, TransTransactNamedPipeResponse, TransWaitNamedPipe, TransWaitNamedPipeResponse
public interface Message
Base class for transport-layer messages in the jCIFS network communication. Provides common functionality for message handling and processing.
Author:
mbechler

  • Method Summary

    Modifier and Type
    Method
    Description
    byte[]
    getRawPayload()
    Gets the raw payload of the message.
    boolean
    isRetainPayload()
    Determines whether to retain the message payload.
    void
    retainPayload()
    Indicate that this message should retain it's raw payload
    void
    setRawPayload(byte[] rawPayload)
    Sets the raw payload of the message.

  • Method Details

    • retainPayload

      void retainPayload()
      Indicate that this message should retain it's raw payload

    • isRetainPayload

      boolean isRetainPayload()
      Determines whether to retain the message payload.
      Returns:
      whether to retain the message payload

    • getRawPayload

      byte[] getRawPayload()
      Gets the raw payload of the message.
      Returns:
      the raw response message

    • setRawPayload

      void setRawPayload(byte[] rawPayload)
      Sets the raw payload of the message.
      Parameters:
      rawPayload - the raw message payload to set