DefaultUserDestinationResolver (Spring Framework API)

java.lang.ObjectSE
- org.springframework.messaging.simp.user.DefaultUserDestinationResolver

実装されたすべてのインターフェース:
UserDestinationResolver
```
public class DefaultUserDestinationResolver
extends ObjectSE
implements UserDestinationResolver
```
SimpUserRegistry に依存してユーザーのアクティブセッションを見つける UserDestinationResolver のデフォルト実装。
ユーザーがサブスクライブしようとしたとき。"/user/queue/position-updates" には、"/user" プレフィックスが削除され、セッション ID に基づいて一意のサフィックスが追加されます。"/queue/position-updates-useri9oqdfzo" は、異なるユーザーが衝突することなく同じ論理宛先にサブスクライブできるようにします。
ユーザーに送信する場合、例: "/user/{username}/queue/position-updates", "/user/{username}" プレフィックスが削除され、アクティブなセッション ID に基づくサフィックスが追加されます。"/queue/position-updates-useri9oqdfzo"。
導入:
4.0
作成者:
Rossen Stoyanchev, Brian Clozel

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

コンストラクター
コンストラクターと説明
`DefaultUserDestinationResolver(SimpUserRegistry userRegistry)` 提供されたレジストリを介してユーザーセッション ID 情報にアクセスするインスタンスを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`protected boolean`	`checkDestination(StringSE destination, StringSE requiredPrefix)`
`StringSE`	`getDestinationPrefix()` ユーザー宛先に構成されたプレフィックスを返します。
`SimpUserRegistry`	`getSimpUserRegistry()` 設定された `SimpUserRegistry` を返します。
`protected StringSE`	`getTargetDestination(StringSE sourceDestination, StringSE actualDestination, StringSE sessionId, StringSE user)` このメソッドは、特定のアクティブユーザーセッションのソース「ユーザー」宛先を実際のターゲット宛先に変換する方法を決定します。
`boolean`	`isRemoveLeadingSlash()` ターゲット宛先から先頭のスラッシュを削除するかどうか。
`UserDestinationResult`	`resolveDestination(Message<?> message)` ユーザー宛先を指定したメッセージを、実際の宛先を含む 1 つ以上のメッセージ（アクティブなユーザーセッションごとに 1 つ）に解決します。
`void`	`setPathMatcher(PathMatcher pathMatcher)` 使用すべきではありません。 4.3.14 の時点で、このプロパティは使用されなくなり、`PathMatcher` の設定方法にかかわらず、先頭のスラッシュを保持するかどうかを明示的に示す `setRemoveLeadingSlash(boolean)` に置き換えられます。
`void`	`setRemoveLeadingSlash(boolean remove)` このプロパティを使用して、変換されたユーザー宛先からの先行スラッシュを削除する必要があるかどうかを示します。
`void`	`setUserDestinationPrefix(StringSE prefix)` ユーザーの宛先を識別するために使用される接頭辞。
`StringSE`	`toString()`

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

- コンストラクターの詳細
  - DefaultUserDestinationResolver
```
public DefaultUserDestinationResolver(SimpUserRegistry userRegistry)
```
    提供されたレジストリを介してユーザーセッション ID 情報にアクセスするインスタンスを作成します。
    パラメーター:
    userRegistry - レジストリ、null
- メソッドの詳細
  - getSimpUserRegistry
```
public SimpUserRegistry getSimpUserRegistry()
```
    設定された SimpUserRegistry を返します。
  - setUserDestinationPrefix
```
public void setUserDestinationPrefix(StringSE prefix)
```
    ユーザーの宛先を識別するために使用される接頭辞。指定された接頭辞で始まらない宛先は解決されません。
    デフォルトのプレフィックスは "/user/" です。
    パラメーター:
    prefix - 使用する接頭辞
  - getDestinationPrefix
```
public StringSE getDestinationPrefix()
```
    ユーザー宛先に構成されたプレフィックスを返します。
  - setRemoveLeadingSlash
```
public void setRemoveLeadingSlash(boolean remove)
```
    このプロパティを使用して、変換されたユーザー宛先からの先行スラッシュを削除する必要があるかどうかを示します。これは、メッセージブローカーが構成されている宛先プレフィックスに依存します。
    デフォルトでは、これは false に設定されています。つまり、「ターゲットの宛先を変更しないでください」です。ただし、構成された宛先の先頭にスラッシュがない場合、AbstractMessageBrokerConfiguration は true に変更することがあります。
    パラメーター:
    remove - 先頭のスラッシュを削除するかどうか
    導入:
    4.3.14
  - isRemoveLeadingSlash
```
public boolean isRemoveLeadingSlash()
```
    ターゲット宛先から先頭のスラッシュを削除するかどうか。
    導入:
    4.3.14
  - setPathMatcher
```
@DeprecatedSE
public void setPathMatcher(@Nullable
                                       PathMatcher pathMatcher)
```
    非推奨。4.3.14 以降、このプロパティは使用されなくなり、PathMatcher の構成方法に関係なく、先頭のスラッシュを保持するかどうかをより明確に示す setRemoveLeadingSlash(boolean) に置き換えられました。
    宛先の操作に使用中の PathMatcher を提供します。これは、userDestinationPrefix を削除した後、先頭のスラッシュを実際の宛先に保持する必要があるかどうかを判断できます。
    デフォルトでは、実際の宛先には先頭にスラッシュがあります。/queue/position-updates は、区切り文字としてスラッシュを使用した宛先をサポートするブローカーで有効です。代替のセパレータをサポートする PathMatcher が提供されている場合、結果の宛先には先頭にスラッシュがありません。jms.queue.position-updates。
    パラメーター:
    pathMatcher - 宛先を操作するために使用される PathMatcher
    導入:
    4.3
  - resolveDestination
```
@Nullable
public UserDestinationResult resolveDestination(Message<?> message)
```
    インターフェースからコピーされた説明: UserDestinationResolver
    ユーザー宛先を指定したメッセージを、実際の宛先を含む 1 つ以上のメッセージ（アクティブなユーザーセッションごとに 1 つ）に解決します。
    次で指定:
    インターフェース UserDestinationResolver の resolveDestination
    パラメーター:
    message - 解決しようとするメッセージ
    戻り値:
    0 以上のターゲットメッセージ（アクティブなセッションごとに 1 つ）、またはソースメッセージにユーザー宛先が含まれていない場合は null。
  - checkDestination
```
protected boolean checkDestination(StringSE destination,
                                   StringSE requiredPrefix)
```
  - getTargetDestination
```
@Nullable
protected StringSE getTargetDestination(StringSE sourceDestination,
                                                StringSE actualDestination,
                                                StringSE sessionId,
                                                @Nullable
                                                StringSE user)
```
    このメソッドは、特定のアクティブユーザーセッションのソース「ユーザー」宛先を実際のターゲット宛先に変換する方法を決定します。
    パラメーター:
    sourceDestination - 入力メッセージからのソース宛先。
    actualDestination - ユーザー接頭辞のない宛先のサブセット。
    sessionId - null ではなく、アクティブなユーザーセッションの ID。
    user - 認証されていない場合など、ターゲットユーザー、おそらく null。
    戻り値:
    ターゲット宛先、ない場合は null
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス ObjectSE の toStringSE

クラス DefaultUserDestinationResolver

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

メソッドのサマリー

クラス java.lang.ObjectSE から継承されたメソッド

コンストラクターの詳細

DefaultUserDestinationResolver

メソッドの詳細

getSimpUserRegistry

setUserDestinationPrefix

getDestinationPrefix

setRemoveLeadingSlash

isRemoveLeadingSlash

setPathMatcher

resolveDestination

checkDestination

getTargetDestination

toString