ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、こちらまでご連絡ください。

ジョブスケジューラテンプレートの作成

Liferayセルフホスト Liferay PaaS

ジョブスケジューラタスクは、 DispatchTaskExecutor インターフェイスを実装することによって作成されます。 Liferay DXP では、独自の例として、すぐに使用できるエグゼキュータを複数提供しています。作成してデプロイしたら、ジョブスケジューラタスクを Liferay インスタンスに追加できます。

次の手順に従って、DispatchTaskExecutorインターフェースの独自の実装を作成します。

OSGi コンポーネント: @Component アノテーションを使用して、モジュールを OSGi フレームワーク内のコンポーネントとして宣言します。
サービス：モジュールを@Componentアノテーション内のDispatchTaskExecutor.classサービスとして識別します。
OSGi プロパティ: 次のプロパティを @Component アノテーションに追加します。
- dispatch.task.executor.name: ジョブスケジューラ UI で実行者の名前に使用される文字列を定義します。
  
  注
  
  ジョブスケジューラタスクでローカライズされた名前を使用する場合は、モジュールの resources/content/Language.properties ファイルに、 dispatch.task.executor.name プロパティの言語キー値を追加します。
- dispatch.task.executor.type: 適切なジョブスケジューラタスクエグゼキュータとジョブスケジューラトリガーに一致する一意の type 値を定義します。
  
  注
  
  正しいエグゼキュータが一致するように、値は一意である必要があります。値が一意でない場合、ログには起動時にエラーが表示され、同じプロパティ値を持つエグゼキュータが示されます。
DispatchTaskExecutor: DispatchTaskExecutor インターフェイスを実装するか、その実装を拡張します (例: BaseDispatchTaskExecutor)。

重要

DispatchTaskExecutor インターフェースの実装では、フレームワークがタスクの同時実行を制御するためにこれらのログに依存しているため、ジョブスケジューラタスクのステータスログを処理する必要があります。

ユーザーの便宜を図るため、Liferay では、ジョブスケジューラタスクのステータスを IN PROGRESS、 SUCCESSFUL、または FAILEDとして記録する BaseDispatchTaskExecutor 抽象クラスを提供しています。
メソッド：DispatchTaskExecutorインターフェースを直接実装している場合は、execute()メソッドをオーバーライドしてカスタムロジックを実装します。代わりに、BaseDispatchTaskExecutor抽象クラスを拡張する場合は、そのdoExecute()メソッドをオーバーライドします。

注

getName() メソッドは非推奨となり、 dispatch.task.executor.name プロパティに置き換えられました。

ヒント

dispatchTrigger.getDispatchTaskSettings() メソッドを使用して、ジョブスケジューラタスクの設定エディターで設定されたプロパティを取得できます。

次のサンプルモジュールは、カスタムジョブスケジューラタスクエグゼキュータを作成して Liferay インスタンスにデプロイする方法を示しています。

サンプルジョブスケジューラタスクエグゼキュータのデプロイ

新しいLiferay インスタンスを起動し、以下を実行します。

docker run -it -m 8g -p 8080:8080 liferay/portal:7.4.3.132-ga132

http://localhost:8080でLiferayにサインインします。メールアドレス test@liferay.com とパスワード testを使用してください。プロンプトが表示されたら、パスワードを learnに変更します。

次に、次の手順に従って、サンプルのジョブスケジューラタスクエグゼキュータをダウンロード、ビルドし、新しい Docker コンテナにデプロイします。

サンプルモジュールをダウンロードして解凍します。

curl https://resources.learn.liferay.com/examples/liferay-s7a3.zip -O

unzip liferay-s7a3.zip

gradlewコマンドを実行してJARファイルをビルドし、それを新しいDockerコンテナにデプロイします。
```
cd liferay-s7a3
```
```
./gradlew deploy -Ddeploy.docker.container.id=$(docker ps -lq)
```
JARは、build/libsフォルダ（つまり、s7a3-impl/build/libs/com.acme.s7a3.impl-1.0.0）に生成されます。
モジュールが正常にデプロイされ、コンテナコンソールを介して開始されたことを確認します。
```
Processing com.acme.s7a3.impl-1.0.0.jar
STARTED com.acme.s7a3.impl-1.0.0 [1656]
```
モジュールが動作していることを確認するには、それを使用して Liferay インスタンスに新しいジョブスケジューラタスクを追加します。

タスクを作成したら、［Run Now］をクリックします。

実行すると、次のメッセージがコンソールに出力されます。
```
INFO [liferay/dispatch/executor-2][S7A3DispatchTaskExecutor:30] Invoking #doExecute(DispatchTrigger, DispatchTaskExecutorOutput)
```
タスクをクリックしてログタブに移動し、以前の実行の一覧を表示することもできます。

サンプルジョブスケジューラタスクエグゼキュータのコード

@Component(
	property = {
		"dispatch.task.executor.name=s7a3", "dispatch.task.executor.type=s7a3"
	},
	service = DispatchTaskExecutor.class
)
public class S7A3DispatchTaskExecutor extends BaseDispatchTaskExecutor {

	@Override
	public void doExecute(
			DispatchTrigger dispatchTrigger,
			DispatchTaskExecutorOutput dispatchTaskExecutorOutput)
		throws IOException, PortalException {

		if (_log.isInfoEnabled()) {
			_log.info(
				"Invoking #doExecute(DispatchTrigger, " +
					"DispatchTaskExecutorOutput)");
		}
	}

	@Override
	public String getName() {
		return "s7a3";
	}

	private static final Log _log = LogFactoryUtil.getLog(
		S7A3DispatchTaskExecutor.class);

}

モジュールはOSGi @Componentとして宣言され、dispatch.task.executor.nameとdispatch.task.executor.typeの2つのプロパティを定義します。その後、モジュールをDispatchTaskExecutor.classサービスとして識別します。

@Componentアノテーションに続いて、モジュールはBaseDispatchTaskExecutor抽象クラスを拡張し、doExecuteメソッドをオーバーライドします。このメソッドは、LogFactoryUtilを使用して、コンソールのログに通知メッセージを表示します。