From a1b8d2d97a9f1c940e86361c2b54e54f2c6f3ec7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20G=C3=B3mez=20G?= Date: Thu, 4 Jul 2024 13:17:33 +0200 Subject: [PATCH 1/2] changed docs internal id for the extension guide --- docs/_playbook/playbook.yaml | 2 +- docs/old-reference-guide/antora.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_playbook/playbook.yaml b/docs/_playbook/playbook.yaml index d351a40..2f9fb56 100644 --- a/docs/_playbook/playbook.yaml +++ b/docs/_playbook/playbook.yaml @@ -1,6 +1,6 @@ site: title: JobRunr Pro Extension docs PREVIEW - start_page: jobrunrpro_extension_old_ref::index.adoc + start_page: jobrunrpro_extension_guide::index.adoc content: sources: diff --git a/docs/old-reference-guide/antora.yml b/docs/old-reference-guide/antora.yml index c0c433d..5d4e751 100644 --- a/docs/old-reference-guide/antora.yml +++ b/docs/old-reference-guide/antora.yml @@ -1,4 +1,4 @@ -name: jobrunrpro_extension_old_ref +name: jobrunrpro_extension_guide title: JobRunr Pro Extension Guide version: true prerelease: true From b21a4619ecc3139eeb37b3a5dc529713e16d148f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20G=C3=B3mez=20G?= Date: Thu, 4 Jul 2024 13:17:53 +0200 Subject: [PATCH 2/2] Renamed extension-guide docs folder --- docs/old-reference-guide/antora.yml | 14 ----- .../modules/ROOT/pages/index.adoc | 54 ------------------- docs/old-reference-guide/modules/nav.adoc | 1 - 3 files changed, 69 deletions(-) delete mode 100644 docs/old-reference-guide/antora.yml delete mode 100644 docs/old-reference-guide/modules/ROOT/pages/index.adoc delete mode 100644 docs/old-reference-guide/modules/nav.adoc diff --git a/docs/old-reference-guide/antora.yml b/docs/old-reference-guide/antora.yml deleted file mode 100644 index 5d4e751..0000000 --- a/docs/old-reference-guide/antora.yml +++ /dev/null @@ -1,14 +0,0 @@ -name: jobrunrpro_extension_guide -title: JobRunr Pro Extension Guide -version: true -prerelease: true -start_page: ROOT:index.adoc - -asciidoc: - attributes: - component_description: The JobRunr Pro Extension guide from the former reference guide - type: guide - group: axon-framework - -nav: - - modules/nav.adoc \ No newline at end of file diff --git a/docs/old-reference-guide/modules/ROOT/pages/index.adoc b/docs/old-reference-guide/modules/ROOT/pages/index.adoc deleted file mode 100644 index b9cefb7..0000000 --- a/docs/old-reference-guide/modules/ROOT/pages/index.adoc +++ /dev/null @@ -1,54 +0,0 @@ -:navtitle: JobRunr Pro Extension -= JobRunr Pro - -The purpose of this extension is to leverage some features only available in the Pro version of link:https://www.jobrunr.io/en/documentation/pro/[JobRunr,window=_blank,role=external]. Only the Pro version allows to search existing jobs by status and label. This is required for the deadline manager to implement the `cancelAll` methods. The xref:axon_framework_old_ref:deadlines:deadline-managers.adoc[deadline managers] section has more in depth information on deadline managers. Although jobs created with the non-pro `DeadlineManager` will be eligible to be canceled, this is only true when they were created with the `4.8` or later versions. Jobs created with the `4.7.x` version are missing the correct labels and will not be found when trying to cancel them. - - -== Spring usage - -For Spring usage, be sure to include the starters, both of JobRunr Pro and the extension. The deadline manager should be available by using parameter-based injection. It can be used in aggregates and sagas using something like: - -[tabs] -====== -Aggregate:: -+ -[source,java] ----- -@CommandHandler -public void handle(SomeCommand command, @Autowired DeadlineManager deadlineManager) { ... } ----- - -Saga:: -+ --- -[source,java] ----- -@StartSaga -public void handle(SomeEvent event, @Autowired DeadlineManager deadlineManager) { ... } ----- - -Alternatively, you could also auto wire the deadline manager to the class like: -[source, java] ----- -@Autowired -void setDeadlineManager(DeadlineManager deadlineManager) { - this.deadlineManager = deadlineManager; -} ----- -====== - -== Non Spring usage -An JobRunrProDeadlineManager instance can be created using the builder like this: - -[source,java] ----- -JobRunrProDeadlineManager.proBuilder() - .jobScheduler(jobScheduler) - .storageProvider(storageProvider) - .scopeAwareProvider(scopeAwareProvider) - .serializer(serializer) - .transactionManager(transactionManager) - .spanFactory(spanFactory) - .build(); ----- -You probably want to use some form of dependency injection instead of creating a new deadline manager each time you need one. \ No newline at end of file diff --git a/docs/old-reference-guide/modules/nav.adoc b/docs/old-reference-guide/modules/nav.adoc deleted file mode 100644 index 08b32be..0000000 --- a/docs/old-reference-guide/modules/nav.adoc +++ /dev/null @@ -1 +0,0 @@ -* xref:ROOT:index.adoc[]