AbstractMessageBrokerConfiguration (Spring Framework API)

java.lang.ObjectSE
- org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration

実装されたすべてのインターフェース:
Aware, ApplicationContextAware
既知の直属サブクラス
WebSocketMessageBrokerConfigurationSupport
```
public abstract class AbstractMessageBrokerConfiguration
extends ObjectSE
implements ApplicationContextAware
```
STOMP などの単純なメッセージングプロトコルでメッセージを処理するための重要な構成を提供します。
clientInboundChannel(org.springframework.core.task.TaskExecutor) および clientOutboundChannel(org.springframework.core.task.TaskExecutor) は、リモートクライアントとの間のメッセージを、次のようないくつかのメッセージハンドラーに配信します。
brokerChannel(org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.core.task.TaskExecutor) は、アプリケーション内からそれぞれのメッセージハンドラーにメッセージを配信します。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 AbstractMessageBrokerConfiguration()
protected コンストラクター。

コンストラクター
修飾子	コンストラクターと説明
`protected`	`AbstractMessageBrokerConfiguration()` protected コンストラクター。

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`protected void`	`addArgumentResolvers(ListSE<HandlerMethodArgumentResolver> argumentResolvers)`
`protected void`	`addReturnValueHandlers(ListSE<HandlerMethodReturnValueHandler> returnValueHandlers)`
`AbstractSubscribableChannel`	`brokerChannel(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, TaskExecutor brokerChannelExecutor)`
`TaskExecutor`	`brokerChannelExecutor(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel)`
`CompositeMessageConverter`	`brokerMessageConverter()`
`SimpMessagingTemplate`	`brokerMessagingTemplate(AbstractSubscribableChannel brokerChannel, AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, CompositeMessageConverter brokerMessageConverter)`
`AbstractSubscribableChannel`	`clientInboundChannel(TaskExecutor clientInboundChannelExecutor)`
`TaskExecutor`	`clientInboundChannelExecutor()`
`AbstractSubscribableChannel`	`clientOutboundChannel(TaskExecutor clientOutboundChannelExecutor)`
`TaskExecutor`	`clientOutboundChannelExecutor()`
`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`	`createJacksonConverter()`
`protected SimpUserRegistry`	`createLocalUserRegistry()` 使用すべきではありません。 5.1 現在、`createLocalUserRegistry(Integer)` を推奨
`protected abstract SimpUserRegistry`	`createLocalUserRegistry(IntegerSE order)` ローカルユーザーへのアクセスを提供するユーザーレジストリを作成します。
`ApplicationContext`	`getApplicationContext()`
`protected MessageBrokerRegistry`	`getBrokerRegistry(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel)` `configureMessageBroker(MessageBrokerRegistry)` による 1 回限りの作成と初期化を保証する `MessageBrokerRegistry` のアクセサー。
`protected ChannelRegistration`	`getClientInboundChannelRegistration()`
`protected ChannelRegistration`	`getClientOutboundChannelRegistration()`
`PathMatcher`	`getPathMatcher(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel)` 他の構成クラスからのアクセスのために、構成された PatchMatcher へのアクセスを提供します。
`Validator`	`getValidator()` このメソッドをオーバーライドして、カスタム `Validator` を提供します。
`TaskScheduler`	`messageBrokerTaskScheduler()`
`void`	`setApplicationContext(ApplicationContext applicationContext)` このオブジェクトが実行される ApplicationContext を設定します。
`SimpAnnotationMethodMessageHandler`	`simpAnnotationMethodMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, SimpMessagingTemplate brokerMessagingTemplate, CompositeMessageConverter brokerMessageConverter)`
`AbstractBrokerMessageHandler`	`simpleBrokerMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationResolver userDestinationResolver)`
`protected Validator`	`simpValidator()` `@Payload` メソッドの引数を検証するための `Validator` インスタンスを返します。
`AbstractBrokerMessageHandler`	`stompBrokerRelayMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationMessageHandler userDestinationMessageHandler, MessageHandler userRegistryMessageHandler, UserDestinationResolver userDestinationResolver)`
`UserDestinationMessageHandler`	`userDestinationMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationResolver userDestinationResolver)`
`UserDestinationResolver`	`userDestinationResolver(SimpUserRegistry userRegistry, AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel)`
`SimpUserRegistry`	`userRegistry(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel)`
`MessageHandler`	`userRegistryMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, SimpUserRegistry userRegistry, SimpMessagingTemplate brokerMessagingTemplate, TaskScheduler messageBrokerTaskScheduler)`

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

コンストラクターの詳細
- AbstractMessageBrokerConfiguration
```
protected AbstractMessageBrokerConfiguration()
```
  protected コンストラクター。

メソッドの詳細

setApplicationContext
```
public void setApplicationContext(@Nullable
                                  ApplicationContext applicationContext)
```
インターフェースからコピーされた説明: 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 オブジェクト
関連事項:
BeanInitializationException

getApplicationContext

@Nullable
public ApplicationContext getApplicationContext()

clientInboundChannel

@Bean
public AbstractSubscribableChannel clientInboundChannel(TaskExecutor clientInboundChannelExecutor)

clientInboundChannelExecutor

@Bean
public TaskExecutor clientInboundChannelExecutor()

getClientInboundChannelRegistration

protected final ChannelRegistration getClientInboundChannelRegistration()

configureClientInboundChannel
```
protected void configureClientInboundChannel(ChannelRegistration registration)
```
WebSocket クライアントからの受信メッセージのメッセージチャネルをカスタマイズするためのサブクラスのフック。

clientOutboundChannel

@Bean
public AbstractSubscribableChannel clientOutboundChannel(TaskExecutor clientOutboundChannelExecutor)

clientOutboundChannelExecutor

@Bean
public TaskExecutor clientOutboundChannelExecutor()

getClientOutboundChannelRegistration

protected final ChannelRegistration getClientOutboundChannelRegistration()

configureClientOutboundChannel
```
protected void configureClientOutboundChannel(ChannelRegistration registration)
```
アプリケーションまたはメッセージブローカーから WebSocket クライアントへのメッセージのメッセージチャネルをカスタマイズするためのサブクラスのフック。

brokerChannel

@Bean
public AbstractSubscribableChannel brokerChannel(AbstractSubscribableChannel clientInboundChannel,
                                                       AbstractSubscribableChannel clientOutboundChannel,
                                                       TaskExecutor brokerChannelExecutor)

brokerChannelExecutor

@Bean
public TaskExecutor brokerChannelExecutor(AbstractSubscribableChannel clientInboundChannel,
                                                AbstractSubscribableChannel clientOutboundChannel)

getBrokerRegistry

protected final MessageBrokerRegistry getBrokerRegistry(AbstractSubscribableChannel clientInboundChannel,
                                                        AbstractSubscribableChannel clientOutboundChannel)

configureMessageBroker(MessageBrokerRegistry) による 1 回限りの作成と初期化を保証する MessageBrokerRegistry のアクセサー。

configureMessageBroker
```
protected void configureMessageBroker(MessageBrokerRegistry registry)
```
提供された 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

protected void addArgumentResolvers(ListSE<HandlerMethodArgumentResolver> argumentResolvers)

addReturnValueHandlers

protected void addReturnValueHandlers(ListSE<HandlerMethodReturnValueHandler> returnValueHandlers)

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,
                                                                  TaskScheduler messageBrokerTaskScheduler)

messageBrokerTaskScheduler

@Bean(name={"messageBrokerTaskScheduler","messageBrokerSockJsTaskScheduler"})
public TaskScheduler messageBrokerTaskScheduler()

brokerMessagingTemplate

@Bean
public SimpMessagingTemplate brokerMessagingTemplate(AbstractSubscribableChannel brokerChannel,
                                                           AbstractSubscribableChannel clientInboundChannel,
                                                           AbstractSubscribableChannel clientOutboundChannel,
                                                           CompositeMessageConverter brokerMessageConverter)

brokerMessageConverter

@Bean
public CompositeMessageConverter brokerMessageConverter()

createJacksonConverter

protected MappingJackson2MessageConverter createJacksonConverter()

configureMessageConverters
```
protected boolean configureMessageConverters(ListSE<MessageConverter> messageConverters)
```
このメソッドをオーバーライドして、カスタムメッセージコンバーターを追加します。
パラメーター:
messageConverters - コンバーターを追加するリスト、最初は空
戻り値:
デフォルトのメッセージコンバーターをリストに追加する場合は true、コンバーターを追加しない場合は false

userDestinationResolver

@Bean
public UserDestinationResolver userDestinationResolver(SimpUserRegistry userRegistry,
                                                             AbstractSubscribableChannel clientInboundChannel,
                                                             AbstractSubscribableChannel clientOutboundChannel)

userRegistry

@Bean
public SimpUserRegistry userRegistry(AbstractSubscribableChannel clientInboundChannel,
                                           AbstractSubscribableChannel clientOutboundChannel)

createLocalUserRegistry
```
@DeprecatedSE
 @Nullable
protected SimpUserRegistry createLocalUserRegistry()
```
非推奨。5.1 現在、createLocalUserRegistry(Integer) を推奨
ローカルユーザーへのアクセスを提供するユーザーレジストリを作成します。

createLocalUserRegistry
```
protected abstract SimpUserRegistry createLocalUserRegistry(@Nullable
                                                            IntegerSE order)
```
ローカルユーザーへのアクセスを提供するユーザーレジストリを作成します。
パラメーター:
order - SmartApplicationListener として使用する順序。
導入:
5.1

simpValidator
```
protected Validator simpValidator()
```
@Payload メソッドの引数を検証するための Validator インスタンスを返します。
順番に、このメソッドは Validator インスタンスを取得しようとします。
- 最初に getValidator() に委譲する
- 何も返されない場合は、MVC 構成によって作成された既知の名前 "mvcValidator" を持つ既存のインスタンスを取得します
- 何も返されない場合は、OptionalValidatorFactoryBean を作成する前に、JSR-303 実装の存在についてクラスパスを確認します
- 何もしない Validator インスタンスを返す

getValidator
```
@Nullable
public Validator getValidator()
```
このメソッドをオーバーライドして、カスタム Validator を提供します。
導入:
4.0.1

クラス AbstractMessageBrokerConfiguration

コンストラクターのサマリー