org.springframework.messaging.support

Class AbstractMessageChannel

  • java.lang.Object
    • org.springframework.messaging.support.AbstractMessageChannel
    • Field Detail

      • logger

        protected Log logger
    • Constructor Detail

      • AbstractMessageChannel

        public AbstractMessageChannel()
    • Method Detail

      • setLogger

        public void setLogger(Log logger)
        Set an alternative logger to use than the one based on the class name.
        Parameters:
        logger - the logger to use
        Since:
        5.1
      • getLogger

        public Log getLogger()
        Return the currently configured Logger.
        Since:
        5.1
      • setBeanName

        public void setBeanName(java.lang.String name)
        A message channel uses the bean name primarily for logging purposes.
        Specified by:
        setBeanName in interface BeanNameAware
        Parameters:
        name - the name of the bean in the factory. Note that this name is the actual bean name used in the factory, which may differ from the originally specified name: in particular for inner bean names, the actual bean name might have been made unique through appending "#..." suffixes. Use the BeanFactoryUtils.originalBeanName(String) method to extract the original bean name (without suffix), if desired.
      • getBeanName

        public java.lang.String getBeanName()
        Return the bean name for this message channel.
      • send

        public final boolean send(Message<?> message)
        Description copied from interface: MessageChannel
        Send a Message to this channel. If the message is sent successfully, the method returns true. If the message cannot be sent due to a non-fatal reason, the method returns false. The method may also throw a RuntimeException in case of non-recoverable errors.

        This method may block indefinitely, depending on the implementation. To provide a maximum wait time, use MessageChannel.send(Message, long).

        Specified by:
        send in interface MessageChannel
        Parameters:
        message - the message to send
        Returns:
        whether or not the message was sent
      • send

        public final boolean send(Message<?> message,
                                  long timeout)
        Description copied from interface: MessageChannel
        Send a message, blocking until either the message is accepted or the specified timeout period elapses.
        Specified by:
        send in interface MessageChannel
        Parameters:
        message - the message to send
        timeout - the timeout in milliseconds or MessageChannel.INDEFINITE_TIMEOUT
        Returns:
        true if the message is sent, false if not including a timeout of an interrupt of the send
      • sendInternal

        protected abstract boolean sendInternal(Message<?> message,
                                                long timeout)
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object