クラス ServletContextAttributeFactoryBean

java.lang.ObjectSE
org.springframework.web.context.support.ServletContextAttributeFactoryBean
実装されたすべてのインターフェース:
AwareFactoryBean<ObjectSE>ServletContextAware

public class ServletContextAttributeFactoryBean extends ObjectSE implements FactoryBean<ObjectSE>, ServletContextAware
特定の既存の ServletContext 属性をフェッチする FactoryBean。Bean 参照として使用されるときにその ServletContext 属性を公開し、名前付き Spring Bean インスタンスとして使用できるようにします。

Spring アプリケーションコンテキストの起動前に存在する ServletContext 属性にリンクすることを目的としています。通常、そのような属性はサードパーティの Web フレームワークによってそこに配置されます。純粋に Spring ベースの Web アプリケーションでは、そのような ServletContext 属性のリンクは必要ありません。

注意 : また、Map 型の "contextAttributes" デフォルト Bean を使用し、"#{contextAttributes.myKey}" 式を使用してこれを逆参照し、名前で特定の属性にアクセスすることもできます。

導入:
1.1.4
作成者:
Juergen Hoeller
関連事項:
  • コンストラクターの詳細

    • ServletContextAttributeFactoryBean

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

    • setAttributeName

      public void setAttributeName(StringSE attributeName)
      公開する ServletContext 属性の名前を設定します。
    • setServletContext

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

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

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

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

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

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

      FactoryBeans は null オブジェクトを返すことができます。Bean ファクトリはこれを通常の値と見なし、この場合は FactoryBeanNotInitializedException をスローしません。ただし、FactoryBean 実装では、必要に応じて FactoryBeanNotInitializedException 自体をスローすることが推奨されます。

      次で指定:
      インターフェース FactoryBean<ObjectSE>getObject 
      戻り値:
      Bean のインスタンス (null にすることができます)
      例外:
      ExceptionSE - 作成エラーの場合
      関連事項:
    • getObjectType

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

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

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

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

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

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