Class SomQmgrInboundMessage

    • Constructor Detail

      • SomQmgrInboundMessage

        public SomQmgrInboundMessage​(SomSession session,
                                     java.lang.String cName,
                                     java.lang.String mName)
        Create a new SOM Inbound message object
        Parameters:
        session - Session with which the object is associated
        cName - inbound channel name which must not be null
        mName - inbound MTA name which must not be null
      • SomQmgrInboundMessage

        public SomQmgrInboundMessage​(SomSession session,
                                     java.lang.String c,
                                     java.lang.String m,
                                     java.lang.String[] pairs)
        Create a new SOM Inbound message object, initializing it from the data pairs
        Parameters:
        session - Session with which the object is associated
        c - inbound channel name which must not be null
        m - inbound MTA name which must not be null
        pairs - attribute pairs from which to initialize object
    • Method Detail

      • mta

        public java.lang.String mta()
        Get MTA name for this inbound message
        Returns:
        mta name
      • inboundSize

        public java.lang.Integer inboundSize()
                                      throws SomException
        Get size of inbound message
        Returns:
        inbound message size
        Throws:
        SomException - if attribute is not found
      • inMsgid

        public java.lang.String inMsgid()
                                 throws SomException
        Get message id for inbound message
        Returns:
        inbound message id
        Throws:
        SomException - if attribute is not found
      • receivedBytes

        public java.lang.Integer receivedBytes()
                                        throws SomException
        Get number of bytes of message received so far
        Returns:
        number of bytes received so far
        Throws:
        SomException - if attribute is not found
      • retransmissions

        public java.lang.Integer retransmissions()
                                          throws SomException
        Get number of retransmissions of the message
        Returns:
        number of retransmissions
        Throws:
        SomException - if attribute is not found
      • startTime

        public java.lang.String startTime()
                                   throws SomException
        Get time at which transfer started
        Returns:
        start time of transfer
        Throws:
        SomException - if attribute is not found
      • handleResponse

        public void handleResponse​(SomCommand command,
                                   int status,
                                   java.lang.String detail)
        Description copied from interface: SomQmgrHandler
        Handles the response to control commands which return an OK/error response plus an info string
        Specified by:
        handleResponse in interface SomHandler
        Specified by:
        handleResponse in interface SomQmgrHandler
        Parameters:
        command - the SOM command
        status - operation status
        detail - detail on error
      • handleResponse

        public void handleResponse​(SomCommand command,
                                   int status,
                                   SomQmgrChannel object)
        Description copied from interface: SomQmgrHandler
        Handles the response to commands which return a list of channel objects
        Specified by:
        handleResponse in interface SomQmgrHandler
        Parameters:
        command - the SOM command
        status - operation status
        object - a channel object
      • handleResponse

        public void handleResponse​(SomCommand command,
                                   int status,
                                   SomQmgrMta object)
        Description copied from interface: SomQmgrHandler
        Handles the response to commands which return a list of MTA objects
        Specified by:
        handleResponse in interface SomQmgrHandler
        Parameters:
        command - the SOM command
        status - operation status
        object - a SOM Qmgr MTA object
      • handleResponse

        public void handleResponse​(SomCommand obj,
                                   int status,
                                   SomMessage msg)
        Description copied from interface: SomQmgrHandler
        Handles the response to commands which return a SomMessage object (i.e. read from the Queue or Archive).
        Specified by:
        handleResponse in interface SomQmgrHandler
        Parameters:
        obj - the SOM command
        status - operation status
        msg - a message object
      • handleResponse

        public void handleResponse​(SomCommand command,
                                   int status,
                                   SomQmgrMessage object)
        Description copied from interface: SomQmgrHandler
        Handles the response to commands which return a list of message objects
        Specified by:
        handleResponse in interface SomQmgrHandler
        Parameters:
        command - the SOM command
        status - operation status
        object - a qmgr message object
      • handleBindResponse

        public void handleBindResponse​(int status,
                                       java.lang.String detail)
        Description copied from interface: SomHandler
        Handle the response to a Bind operation
        Specified by:
        handleBindResponse in interface SomHandler
        Parameters:
        status - operation status
        detail - error detail on failure
      • handleResponse

        public void handleResponse​(SomCommand command,
                                   int status,
                                   java.lang.String[] pairs)
        Description copied from interface: SomQmgrHandler
        Handles the response to commands which return data about the current object - i.e. we are refreshing an existing object.
        Specified by:
        handleResponse in interface SomQmgrHandler
        Parameters:
        command - the SOM command
        status - operation status
        pairs - data pairs
      • refresh

        public void refresh​(SomCommandListener listener)
                     throws SomException
        Refresh the status of this inbound message
        Parameters:
        listener - Listener object to notify when complete which may be null
        Throws:
        SomException - on error
      • buildInfoString

        public java.lang.String buildInfoString()
        Build information string for this message
        Returns:
        Info string