public class JobDetailFactoryBean extends ObjectSE implements FactoryBean<JobDetail>, BeanNameAware, ApplicationContextAware, InitializingBean
JobDetail
インスタンスを作成するための Spring FactoryBean
。JobDetail 構成の Bean スタイルの使用をサポートします。JobDetail(Impl)
自体はすでに JavaBean ですが、適切なデフォルトがありません。このクラスは、Spring Bean 名をジョブ名として使用し、Quartz デフォルトグループ("DEFAULT" )をジョブグループとして指定します(指定されていない場合)。
setName(java.lang.String)
, setGroup(java.lang.String)
, BeanNameAware
, Scheduler.DEFAULT_GROUP
OBJECT_TYPE_ATTRIBUTE
コンストラクターと説明 |
---|
JobDetailFactoryBean() |
修飾子と型 | メソッドと説明 |
---|---|
void | afterPropertiesSet() |
JobDataMap | getJobDataMap() ジョブの JobDataMap を返します。 |
JobDetail | getObject() このファクトリによって管理されるオブジェクトのインスタンス(おそらく共有または独立)を返します。 |
ClassSE<?> | getObjectType() この FactoryBean が作成するオブジェクトの型、または事前に不明な場合は null を返します。 |
boolean | isSingleton() このファクトリによって管理されるオブジェクトはシングルトンですか? つまり、 FactoryBean.getObject() は常に同じオブジェクト(キャッシュ可能な参照)を返しますか? |
void | setApplicationContext(ApplicationContext applicationContext) このオブジェクトが実行される ApplicationContext を設定します。 |
void | setApplicationContextJobDataKey(StringSE applicationContextJobDataKey) JobDataMap で公開する ApplicationContext 参照のキーを設定します (例: "applicationContext" )。 |
void | setBeanName(StringSE beanName) この Bean を作成した Bean ファクトリで Bean の名前を設定します。 |
void | setDescription(StringSE description) このジョブの説明文を設定します。 |
void | setDurability(boolean durability) ジョブの耐久性を指定します。 |
void | setGroup(StringSE group) ジョブのグループを指定します。 |
void | setJobClass(ClassSE<? extends Job> jobClass) ジョブの実装クラスを指定します。 |
void | setJobDataAsMap(MapSE<StringSE,?> jobDataAsMap) 指定されたマップを介して JobDataMap にオブジェクトを登録します。 |
void | setJobDataMap(JobDataMap jobDataMap) ジョブの JobDataMap を設定します。 |
void | setName(StringSE name) ジョブの名前を指定します。 |
void | setRequestsRecovery(boolean requestsRecovery) このジョブの回復フラグを設定します。 |
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
public void setName(StringSE name)
public void setGroup(StringSE group)
public void setJobDataMap(JobDataMap jobDataMap)
public JobDataMap getJobDataMap()
public void setJobDataAsMap(MapSE<StringSE,?> jobDataAsMap)
これらのオブジェクトは、SchedulerContext のオブジェクトとは対照的に、このジョブでのみ使用できます。
メモ: JobDetail がデータベースに保持される永続的なジョブを使用する場合は、Spring 管理の Bean または ApplicationContext 参照を JobDataMap ではなく SchedulerContext に配置しないでください。
jobDataAsMap
- String キーと任意のオブジェクトを値として持つ Map (たとえば、Spring に管理された Bean)SchedulerFactoryBean.setSchedulerContextAsMap(java.util.Map<java.lang.String, ?>)
public void setDurability(boolean durability)
public void setRequestsRecovery(boolean requestsRecovery)
public void setDescription(StringSE description)
public void setBeanName(StringSE beanName)
BeanNameAware
通常の Bean プロパティの設定後、ただし InitializingBean.afterPropertiesSet()
またはカスタム init メソッドなどの init コールバックの前に呼び出されます。
BeanNameAware
の setBeanName
beanName
- ファクトリ内の Bean の名前。この名前は、ファクトリで使用される実際の Bean 名であり、最初に指定した名前とは異なる場合があります。特に内部 Bean 名の場合、実際の Bean 名は "#..." サフィックスを追加することで一意になります。必要に応じて、BeanFactoryUtils.originalBeanName(String)
メソッドを使用して、元の Bean 名(サフィックスなし)を抽出します。public void setApplicationContext(ApplicationContext applicationContext)
ApplicationContextAware
通常の Bean プロパティの設定後、ただし InitializingBean.afterPropertiesSet()
またはカスタム init メソッドなどの init コールバックの前に呼び出されます。ResourceLoaderAware.setResourceLoader(org.springframework.core.io.ResourceLoader)
、ApplicationEventPublisherAware.setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher)
および MessageSourceAware
の後に呼び出されます(該当する場合)。
ApplicationContextAware
の setApplicationContext
applicationContext
- このオブジェクトによって使用される ApplicationContext オブジェクト BeanInitializationException
public void setApplicationContextJobDataKey(StringSE applicationContextJobDataKey)
QuartzJobBean の場合、参照は Bean プロパティとしてジョブインスタンスに適用されます。そのシナリオでは、"applicationContext" 属性 は "setApplicationContext" メソッドに対応します。
Quartz 自体がジョブのライフサイクルを担当するため、ApplicationContextAware のような BeanFactory コールバックインターフェースは Quartz ジョブインスタンスに自動的に適用されないことに注意してください。
メモ: JobDetail の内容がデータベースに保持される永続的なジョブストアを使用する場合は、ApplicationContext 参照を JobDataMap ではなく SchedulerContext に配置してください。
public void afterPropertiesSet()
InitializingBean
BeanFactoryAware
、ApplicationContextAware
などを満たした後、包含 BeanFactory
によって呼び出されます。このメソッドにより、Bean インスタンスは、すべての Bean プロパティが設定されたときに、その全体的な構成の検証と最終的な初期化を実行できます。
InitializingBean
の afterPropertiesSet
@Nullable public JobDetail getObject()
FactoryBean
BeanFactory
と同様に、これにより、シングルトンとプロトタイプの両方のデザインパターンをサポートできます。
この FactoryBean が呼び出し時にまだ完全に初期化されていない場合(たとえば、循環参照に関係しているため)、対応する FactoryBeanNotInitializedException
をスローします。
Spring 2.0 以降、FactoryBeans は null
オブジェクトを返すことができます。ファクトリはこれを通常の値として使用します。この場合、FactoryBeanNotInitializedException はスローされません。FactoryBean の実装では、必要に応じて FactoryBeanNotInitializedException 自体をすぐにスローすることをお勧めします。
FactoryBean<JobDetail>
の getObject
null
にすることができます)FactoryBeanNotInitializedException
public ClassSE<?> getObjectType()
FactoryBean
null
を返します。これにより、たとえばオートワイヤーなどで、オブジェクトをインスタンス化せずに特定の型の Bean を確認できます。
シングルトンオブジェクトを作成している実装の場合、このメソッドはシングルトンの作成を可能な限り回避しようとします。むしろ、事前に型を推定する必要があります。プロトタイプの場合、ここで意味のある型を返すこともお勧めします。
このメソッドは、この FactoryBean が完全に初期化される前に呼び出すことができます。初期化中に作成された状態に依存しないでください。もちろん、利用可能な場合はそのような状態を引き続き使用できます。
注意 : オートワイヤーは、ここで null
を返す FactoryBeans を単に無視します。FactoryBean の現在の状態を使用して、このメソッドを適切に実装することを強くお勧めします。
FactoryBean<JobDetail>
の getObjectType
null
ListableBeanFactory.getBeansOfType(java.lang.Class<T>)
public boolean isSingleton()
FactoryBean
FactoryBean.getObject()
は常に同じオブジェクト(キャッシュ可能な参照)を返しますか? 注意 : FactoryBean がシングルトンオブジェクトを保持することを示す場合、getObject()
から返されたオブジェクトは所有 BeanFactory によってキャッシュされる可能性があります。FactoryBean が常に同じ参照を公開しない限り、true
を返さないでください。
FactoryBean 自体のシングルトンステータスは、通常、所有する BeanFactory によって提供されます。通常、そこではシングルトンとして定義する必要があります。
注意 : false
を返すこのメソッドは、返されるオブジェクトが独立したインスタンスであることを必ずしも示しません。拡張 SmartFactoryBean
インターフェースの実装は、SmartFactoryBean.isPrototype()
メソッドを通じて独立したインスタンスを明示的に示す場合があります。この拡張インターフェースを実装しないプレーンな FactoryBean
実装は、isSingleton()
実装が false
を返す場合、常に独立したインスタンスを返すと単純に想定されます。
FactoryBean
は通常シングルトンインスタンスを管理するため、デフォルトの実装では true
が返されます。
FactoryBean<JobDetail>
の isSingleton
FactoryBean.getObject()
, SmartFactoryBean.isPrototype()