类 SimpMessagingTemplate

构造器详细资料

• SimpMessagingTemplate

  public SimpMessagingTemplate​(MessageChannel messageChannel)

  Create a new SimpMessagingTemplate instance.

  参数:

  messageChannel - the message channel (never null)

方法详细资料

• getMessageChannel

  public MessageChannel getMessageChannel()

  Return the configured message channel.

• setUserDestinationPrefix

  public void setUserDestinationPrefix​(String prefix)

  Configure the prefix to use for destinations targeting a specific user.

  The default value is "/user/".

  另请参阅:

  UserDestinationMessageHandler

• getUserDestinationPrefix

  public String getUserDestinationPrefix()

  Return the configured user destination prefix.

• setSendTimeout

  public void setSendTimeout​(long sendTimeout)

  Specify the timeout value to use for send operations (in milliseconds).

• getSendTimeout

  public long getSendTimeout()

  Return the configured send timeout (in milliseconds).

• setHeaderInitializer

  public void setHeaderInitializer​(@Nullable
                                   MessageHeaderInitializer headerInitializer)

  Configure a MessageHeaderInitializer to apply to the headers of all messages created through the SimpMessagingTemplate.

  By default, this property is not set.

• getHeaderInitializer

  @Nullable
  public MessageHeaderInitializer getHeaderInitializer()

  Return the configured header initializer.

• send

  public void send​(Message<?> message)

  If the headers of the given message already contain a SimpMessageHeaderAccessor#DESTINATION_HEADER then the message is sent without further changes.

  If a destination header is not already present ,the message is sent to the configured defaultDestination or an exception an IllegalStateException is raised if that isn't configured.

  指定者:

  send 在接口中 MessageSendingOperations<String>

  覆盖:

  send 在类中 AbstractMessageSendingTemplate<String>

  参数:

  message - the message to send (never null)

• doSend

  protected void doSend​(String destination,
                        Message<?> message)

  指定者:

  doSend 在类中 AbstractMessageSendingTemplate<String>

• convertAndSendToUser

  public void convertAndSendToUser​(String user,
                                   String destination,
                                   Object payload)
                            throws MessagingException

  从接口复制的说明: SimpMessageSendingOperations
  Send a message to the given user.

  指定者:

  convertAndSendToUser 在接口中 SimpMessageSendingOperations

  参数:

  user - the user that should receive the message.

  destination - the destination to send the message to.

  payload - the payload to send

  抛出:

  MessagingException

• convertAndSendToUser

  public void convertAndSendToUser​(String user,
                                   String destination,
                                   Object payload,
                                   @Nullable
                                   Map<String,​Object> headers)
                            throws MessagingException

  从接口复制的说明: SimpMessageSendingOperations
  Send a message to the given user.

  By default headers are interpreted as native headers (e.g. STOMP) and are saved under a special key in the resulting Spring Message. In effect when the message leaves the application, the provided headers are included with it and delivered to the destination (e.g. the STOMP client or broker).

  If the map already contains the key "nativeHeaders" or was prepared with SimpMessageHeaderAccessor then the headers are used directly. A common expected case is providing a content type (to influence the message conversion) and native headers. This may be done as follows:

   SimpMessageHeaderAccessor accessor = SimpMessageHeaderAccessor.create();
   accessor.setContentType(MimeTypeUtils.TEXT_PLAIN);
   accessor.setNativeHeader("foo", "bar");
   accessor.setLeaveMutable(true);
   MessageHeaders headers = accessor.getMessageHeaders();
   messagingTemplate.convertAndSendToUser(user, destination, payload, headers);
   

  Note: if the MessageHeaders are mutable as in the above example, implementations of this interface should take notice and update the headers in the same instance (rather than copy or re-create it) and then set it immutable before sending the final message.

  指定者:

  convertAndSendToUser 在接口中 SimpMessageSendingOperations

  参数:

  user - the user that should receive the message (must not be null)

  destination - the destination to send the message to (must not be null)

  payload - the payload to send (may be null)

  headers - the message headers (may be null)

  抛出:

  MessagingException

• convertAndSendToUser

  public void convertAndSendToUser​(String user,
                                   String destination,
                                   Object payload,
                                   @Nullable
                                   MessagePostProcessor postProcessor)
                            throws MessagingException

  从接口复制的说明: SimpMessageSendingOperations
  Send a message to the given user.

  指定者:

  convertAndSendToUser 在接口中 SimpMessageSendingOperations

  参数:

  user - the user that should receive the message (must not be null)

  destination - the destination to send the message to (must not be null)

  payload - the payload to send (may be null)

  postProcessor - a postProcessor to post-process or modify the created message

  抛出:

  MessagingException

• convertAndSendToUser

  public void convertAndSendToUser​(String user,
                                   String destination,
                                   Object payload,
                                   @Nullable
                                   Map<String,​Object> headers,
                                   @Nullable
                                   MessagePostProcessor postProcessor)
                            throws MessagingException

  从接口复制的说明: SimpMessageSendingOperations
  Send a message to the given user.

  See MessageSendingOperations.convertAndSend(Object, Object, java.util.Map) for important notes regarding the input headers.

  指定者:

  convertAndSendToUser 在接口中 SimpMessageSendingOperations

  参数:

  user - the user that should receive the message

  destination - the destination to send the message to

  payload - the payload to send

  headers - the message headers

  postProcessor - a postProcessor to post-process or modify the created message

  抛出:

  MessagingException

• processHeadersToSend

  protected Map<String,​Object> processHeadersToSend​(@Nullable
                                                          Map<String,​Object> headers)

  Creates a new map and puts the given headers under the key NATIVE_HEADERS NATIVE_HEADERS NATIVE_HEADERS. effectively treats the input header map as headers to be sent out to the destination.

  However if the given headers already contain the key NATIVE_HEADERS NATIVE_HEADERS then the same headers instance is returned without changes.

  Also if the given headers were prepared and obtained with MessageHeaderAccessor.getMessageHeaders() then the same headers instance is also returned without changes.

  覆盖:

  processHeadersToSend 在类中 AbstractMessageSendingTemplate<String>

  参数:

  headers - the headers to send (or null if none)

  返回:

  the actual headers to send (or null if none)