クラス ServletServerContainerFactoryBean

java.lang.ObjectSE
org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean
実装されたすべてのインターフェース:
AwareFactoryBean<WebSocketContainerEE>InitializingBeanServletContextAware

public class ServletServerContainerFactoryBean extends ObjectSE implements FactoryBean<WebSocketContainerEE>, ServletContextAware, InitializingBean
ServerContainerEE を構成するための FactoryBean。通常、既知の jakarta.servlet.ServletContext 属性でアクセスできる ServerContainer インスタンスは 1 つだけなので、この FactoryBean を宣言し、その setter を使用するだけで、ServerContainer から Spring の構成を構成できます。

これは、ServerContainer が Spring アプリケーションコンテキスト内の他の Bean に挿入されていない場合でも役立ちます。例: アプリケーションは DefaultHandshakeHandlerSockJsServiceServerEndpointExporter を構成し、この FactoryBean を個別に宣言して(唯一の) ServerContainer インスタンスのプロパティをカスタマイズできます。

導入:
4.0
作成者:
Rossen Stoyanchev, Sam Brannen
  • コンストラクターの詳細

    • ServletServerContainerFactoryBean

      public ServletServerContainerFactoryBean()
  • メソッドの詳細

    • setAsyncSendTimeout

      public void setAsyncSendTimeout(LongSE timeoutInMillis)
    • getAsyncSendTimeout

      @Nullable public LongSE getAsyncSendTimeout()
    • setMaxSessionIdleTimeout

      public void setMaxSessionIdleTimeout(LongSE timeoutInMillis)
    • getMaxSessionIdleTimeout

      @Nullable public LongSE getMaxSessionIdleTimeout()
    • setMaxTextMessageBufferSize

      public void setMaxTextMessageBufferSize(IntegerSE bufferSize)
    • getMaxTextMessageBufferSize

      @Nullable public IntegerSE getMaxTextMessageBufferSize()
    • setMaxBinaryMessageBufferSize

      public void setMaxBinaryMessageBufferSize(IntegerSE bufferSize)
    • getMaxBinaryMessageBufferSize

      @Nullable public IntegerSE getMaxBinaryMessageBufferSize()
    • setServletContext

      public void setServletContext(ServletContextEE servletContext)
      インターフェースからコピーされた説明: ServletContextAware
      このオブジェクトが実行される ServletContextEE を設定します。

      通常の Bean プロパティの設定後、InitializingBean の afterPropertiesSet またはカスタム init メソッドのような初期コールバックの前に呼び出されます。ApplicationContextAware の setApplicationContext の後に呼び出されます。

      次で指定:
      インターフェース ServletContextAwaresetServletContext 
      パラメーター:
      servletContext - このオブジェクトによって使用される ServletContext オブジェクト
      関連事項:
    • afterPropertiesSet

      public void afterPropertiesSet()
      インターフェースからコピーされた説明: InitializingBean
      すべての Bean プロパティを設定し、BeanFactoryAwareApplicationContextAware などを満たした後、包含 BeanFactory によって呼び出されます。

      このメソッドにより、Bean インスタンスは、すべての Bean プロパティが設定されたときに、その全体的な構成の検証と最終的な初期化を実行できます。

      次で指定:
      インターフェース InitializingBeanafterPropertiesSet 
    • getObject

      @Nullable public ServerContainerEE getObject()
      インターフェースからコピーされた説明: FactoryBean
      このファクトリによって管理されるオブジェクトのインスタンス(おそらく共有または独立)を返します。

      BeanFactory と同様に、これにより、シングルトンとプロトタイプの両方のデザインパターンをサポートできます。

      この FactoryBean が呼び出し時にまだ完全に初期化されていない場合(たとえば、循環参照に関係しているため)、対応する FactoryBeanNotInitializedException をスローします。

      Spring 2.0 以降、FactoryBeans は null オブジェクトを返すことができます。ファクトリはこれを通常の値として使用します。この場合、FactoryBeanNotInitializedException はスローされません。FactoryBean の実装では、必要に応じて FactoryBeanNotInitializedException 自体をすぐにスローすることをお勧めします。

      次で指定:
      インターフェース FactoryBean<WebSocketContainerEE>getObject 
      戻り値:
      Bean のインスタンス (null にすることができます)
      関連事項:
    • getObjectType

      public ClassSE<?> getObjectType()
      インターフェースからコピーされた説明: FactoryBean
      この FactoryBean が作成するオブジェクトの型、または事前に不明な場合は null を返します。

      これにより、たとえばオートワイヤーなどで、オブジェクトをインスタンス化せずに特定の型の Bean を確認できます。

      シングルトンオブジェクトを作成している実装の場合、このメソッドはシングルトンの作成を可能な限り回避しようとします。むしろ、事前に型を推定する必要があります。プロトタイプの場合、ここで意味のある型を返すこともお勧めします。

      このメソッドは、この FactoryBean が完全に初期化される前に呼び出すことができます。初期化中に作成された状態に依存しないでください。もちろん、利用可能な場合はそのような状態を引き続き使用できます。

      注意 : オートワイヤーは、ここで null を返す FactoryBeans を単に無視します。FactoryBean の現在の状態を使用して、このメソッドを適切に実装することを強くお勧めします。

      次で指定:
      インターフェース FactoryBean<WebSocketContainerEE>getObjectType 
      戻り値:
      この FactoryBean が作成するオブジェクトの型、または呼び出し時に不明な場合は null 
      関連事項:
    • isSingleton

      public boolean isSingleton()
      インターフェースからコピーされた説明: FactoryBean
      このファクトリによって管理されるオブジェクトはシングルトンですか? つまり、FactoryBean.getObject() は常に同じオブジェクト(キャッシュ可能な参照)を返しますか?

      注意 : FactoryBean がシングルトンオブジェクトを保持することを示す場合、getObject() から返されたオブジェクトは所有 BeanFactory によってキャッシュされる可能性があります。FactoryBean が常に同じ参照を公開しない限り、true を返さないでください。

      FactoryBean 自体のシングルトンステータスは、通常、所有する BeanFactory によって提供されます。通常、そこではシングルトンとして定義する必要があります。

      注意 false を返すこのメソッドは、返されるオブジェクトが独立したインスタンスであることを必ずしも示しません。拡張 SmartFactoryBean インターフェースの実装は、SmartFactoryBean.isPrototype() メソッドを通じて独立したインスタンスを明示的に示す場合があります。この拡張インターフェースを実装しないプレーンな FactoryBean 実装は、isSingleton() 実装が false を返す場合、常に独立したインスタンスを返すと単純に想定されます。

      FactoryBean は通常シングルトンインスタンスを管理するため、デフォルトの実装は true を返します。

      次で指定:
      インターフェース FactoryBean<WebSocketContainerEE>isSingleton 
      戻り値:
      公開されたオブジェクトがシングルトンかどうか
      関連事項: