クラス AbstractMessageBrokerConfiguration
- 実装されたすべてのインターフェース:
Aware
,ApplicationContextAware
- 既知の直属サブクラス
WebSocketMessageBrokerConfigurationSupport
clientInboundChannel(java.util.concurrent.Executor)
および clientOutboundChannel(java.util.concurrent.Executor)
は、リモートクライアントとの間のメッセージを、次のようないくつかのメッセージハンドラーに配信します。
simpAnnotationMethodMessageHandler(org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.simp.SimpMessagingTemplate, org.springframework.messaging.converter.CompositeMessageConverter)
simpleBrokerMessageHandler(org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.simp.user.UserDestinationResolver)
stompBrokerRelayMessageHandler(org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.simp.user.UserDestinationMessageHandler, org.springframework.messaging.MessageHandler, org.springframework.messaging.simp.user.UserDestinationResolver)
userDestinationMessageHandler(org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.simp.user.UserDestinationResolver)
brokerChannel(org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, java.util.concurrent.Executor)
は、アプリケーション内からそれぞれのメッセージハンドラーにメッセージを配信します。brokerMessagingTemplate(org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.converter.CompositeMessageConverter)
は、メッセージを送信するために任意のアプリケーションコンポーネントに挿入できます。
サブクラスは、クライアントの受信 / 送信チャネル (たとえば、WebSocket 経由の STOMP) との間でメッセージをやり取りする構成の部分を担当します。
- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev, Brian Clozel, Sebastien Deleuze
コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明protected void
addArgumentResolvers
(ListSE<HandlerMethodArgumentResolver> argumentResolvers) protected void
addReturnValueHandlers
(ListSE<HandlerMethodReturnValueHandler> returnValueHandlers) brokerChannel
(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, ExecutorSE executor) brokerChannelExecutor
(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel) brokerMessagingTemplate
(AbstractSubscribableChannel brokerChannel, AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, CompositeMessageConverter brokerMessageConverter) clientInboundChannel
(ExecutorSE executor) clientOutboundChannel
(ExecutorSE executor) protected void
configureClientInboundChannel
(ChannelRegistration registration) WebSocket クライアントからの受信メッセージのメッセージチャネルをカスタマイズするためのサブクラスのフック。protected void
configureClientOutboundChannel
(ChannelRegistration registration) アプリケーションまたはメッセージブローカーから WebSocket クライアントへのメッセージのメッセージチャネルをカスタマイズするためのサブクラスのフック。protected void
configureMessageBroker
(MessageBrokerRegistry registry) 提供されたMessageBrokerRegistry
インスタンスを介してメッセージブローカ構成をカスタマイズするためのサブクラスのフック。protected boolean
configureMessageConverters
(ListSE<MessageConverter> messageConverters) このメソッドをオーバーライドして、カスタムメッセージコンバーターを追加します。protected SimpAnnotationMethodMessageHandler
createAnnotationMethodMessageHandler
(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, SimpMessagingTemplate brokerMessagingTemplate) SimpAnnotationMethodMessageHandler
のカスタムサブクラスにプラグインするための protected メソッド。protected MappingJackson2MessageConverter
protected abstract SimpUserRegistry
createLocalUserRegistry
(IntegerSE order) ローカルユーザーへのアクセスを提供するユーザーレジストリを作成します。protected final MessageBrokerRegistry
getBrokerRegistry
(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel) configureMessageBroker(MessageBrokerRegistry)
による 1 回限りの作成と初期化を保証するMessageBrokerRegistry
のアクセサー。protected final ChannelRegistration
protected final ChannelRegistration
final PathMatcher
getPathMatcher
(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel) 他の構成クラスからのアクセスのために、構成された PatchMatcher へのアクセスを提供します。protected final int
getPhase()
このメソッドをオーバーライドして、カスタムValidator
を提供します。protected int
void
setApplicationContext
(ApplicationContext applicationContext) このオブジェクトが実行される ApplicationContext を設定します。simpAnnotationMethodMessageHandler
(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, SimpMessagingTemplate brokerMessagingTemplate, CompositeMessageConverter brokerMessageConverter) simpleBrokerMessageHandler
(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationResolver userDestinationResolver) protected Validator
@Payload
メソッドの引数を検証するためのValidator
インスタンスを返します。stompBrokerRelayMessageHandler
(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationMessageHandler userDestinationMessageHandler, MessageHandler userRegistryMessageHandler, UserDestinationResolver userDestinationResolver) userDestinationMessageHandler
(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationResolver userDestinationResolver) userDestinationResolver
(SimpUserRegistry userRegistry, AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel) userRegistry
(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel) userRegistryMessageHandler
(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, SimpUserRegistry userRegistry, SimpMessagingTemplate brokerMessagingTemplate, TaskScheduler scheduler)
コンストラクターの詳細
AbstractMessageBrokerConfiguration
protected AbstractMessageBrokerConfiguration()protected コンストラクター。
メソッドの詳細
setApplicationContext
インターフェースからコピーされた説明:ApplicationContextAware
このオブジェクトが実行される ApplicationContext を設定します。通常、この呼び出しはオブジェクトの初期化に使用されます。通常の Bean プロパティの設定後、ただし
InitializingBean.afterPropertiesSet()
またはカスタム init メソッドなどの init コールバックの前に呼び出されます。ResourceLoaderAware.setResourceLoader(org.springframework.core.io.ResourceLoader)
、ApplicationEventPublisherAware.setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher)
およびMessageSourceAware
の後に呼び出されます(該当する場合)。- 次で指定:
- インターフェース
ApplicationContextAware
のsetApplicationContext
- パラメーター:
applicationContext
- このオブジェクトによって使用される ApplicationContext オブジェクト- 関連事項:
getApplicationContext
clientInboundChannel
@Bean public AbstractSubscribableChannel clientInboundChannel(@Qualifier("clientInboundChannelExecutor") ExecutorSE executor) clientInboundChannelExecutor
getClientInboundChannelRegistration
getPhase
protected final int getPhase()initPhase
protected int initPhase()configureClientInboundChannel
WebSocket クライアントからの受信メッセージのメッセージチャネルをカスタマイズするためのサブクラスのフック。clientOutboundChannel
@Bean public AbstractSubscribableChannel clientOutboundChannel(@Qualifier("clientOutboundChannelExecutor") ExecutorSE executor) clientOutboundChannelExecutor
getClientOutboundChannelRegistration
configureClientOutboundChannel
アプリケーションまたはメッセージブローカーから WebSocket クライアントへのメッセージのメッセージチャネルをカスタマイズするためのサブクラスのフック。brokerChannel
@Bean public AbstractSubscribableChannel brokerChannel(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, @Qualifier("brokerChannelExecutor") ExecutorSE executor) brokerChannelExecutor
@Bean public ExecutorSE brokerChannelExecutor(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel) getBrokerRegistry
protected final MessageBrokerRegistry getBrokerRegistry(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel) configureMessageBroker(MessageBrokerRegistry)
による 1 回限りの作成と初期化を保証するMessageBrokerRegistry
のアクセサー。configureMessageBroker
提供されたMessageBrokerRegistry
インスタンスを介してメッセージブローカ構成をカスタマイズするためのサブクラスのフック。getPathMatcher
@Nullable public final PathMatcher getPathMatcher(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel) 他の構成クラスからのアクセスのために、構成された PatchMatcher へのアクセスを提供します。simpAnnotationMethodMessageHandler
@Bean public SimpAnnotationMethodMessageHandler simpAnnotationMethodMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, SimpMessagingTemplate brokerMessagingTemplate, CompositeMessageConverter brokerMessageConverter) createAnnotationMethodMessageHandler
protected SimpAnnotationMethodMessageHandler createAnnotationMethodMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, SimpMessagingTemplate brokerMessagingTemplate) SimpAnnotationMethodMessageHandler
のカスタムサブクラスにプラグインするための protected メソッド。- 導入:
- 5.3.2
addArgumentResolvers
addReturnValueHandlers
simpleBrokerMessageHandler
@Bean @Nullable public AbstractBrokerMessageHandler simpleBrokerMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationResolver userDestinationResolver) stompBrokerRelayMessageHandler
@Bean @Nullable public AbstractBrokerMessageHandler stompBrokerRelayMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationMessageHandler userDestinationMessageHandler, @Nullable MessageHandler userRegistryMessageHandler, UserDestinationResolver userDestinationResolver) userDestinationMessageHandler
@Bean public UserDestinationMessageHandler userDestinationMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationResolver userDestinationResolver) userRegistryMessageHandler
@Bean @Nullable public MessageHandler userRegistryMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, SimpUserRegistry userRegistry, SimpMessagingTemplate brokerMessagingTemplate, @Qualifier("messageBrokerTaskScheduler") TaskScheduler scheduler) messageBrokerTaskScheduler
@Bean(name={"messageBrokerTaskScheduler","messageBrokerSockJsTaskScheduler"}) public TaskScheduler messageBrokerTaskScheduler()brokerMessagingTemplate
@Bean public SimpMessagingTemplate brokerMessagingTemplate(AbstractSubscribableChannel brokerChannel, AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, CompositeMessageConverter brokerMessageConverter) brokerMessageConverter
createJacksonConverter
configureMessageConverters
このメソッドをオーバーライドして、カスタムメッセージコンバーターを追加します。- パラメーター:
messageConverters
- コンバーターを追加するリスト、最初は空- 戻り値:
- デフォルトのメッセージコンバーターをリストに追加する場合は
true
、コンバーターを追加しない場合はfalse
userDestinationResolver
@Bean public UserDestinationResolver userDestinationResolver(SimpUserRegistry userRegistry, AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel) userRegistry
@Bean public SimpUserRegistry userRegistry(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel) createLocalUserRegistry
ローカルユーザーへのアクセスを提供するユーザーレジストリを作成します。- パラメーター:
order
-SmartApplicationListener
として使用する順序。- 導入:
- 5.1
simpValidator
@Payload
メソッドの引数を検証するためのValidator
インスタンスを返します。順番に、このメソッドは Validator インスタンスを取得しようとします。
- 最初に getValidator() に委譲する
- 何も返されない場合は、MVC 構成によって作成された、よく知られている名前 "mvcValidator" を持つ既存のインスタンスを取得します。
- 何も返されない場合は、
OptionalValidatorFactoryBean
を作成する前に、JSR-303 実装の存在についてクラスパスを確認します - 何もしない Validator インスタンスを返す
getValidator
このメソッドをオーバーライドして、カスタムValidator
を提供します。- 導入:
- 4.0.1