diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml index 99d0f36e..8f403aad 100644 --- a/.github/workflows/maven.yml +++ b/.github/workflows/maven.yml @@ -40,7 +40,7 @@ jobs: - name: Build with Maven if: '!matrix.isMainBuildEnv' - run: mvn -e -B -V -Pintegration-tests clean verify + run: mvn -e -B -V clean verify -Pintegration-tests -Pjavadoc - name: Build and Analyse with Maven if: github.ref != 'refs/heads/develop' && matrix.isMainBuildEnv env: @@ -56,7 +56,7 @@ jobs: ACTOOL_IMS_IT_CLIENTSECRET: ${{ secrets.ACTOOL_IMS_IT_CLIENTSECRET }} ACTOOL_IMS_IT_PRODUCTPROFILE: ${{ vars.ACTOOL_IMS_IT_PRODUCTPROFILE }} ACTOOL_IMS_IT_USERID: ${{ vars.ACTOOL_IMS_IT_USERID }} - run: mvn -e -B -V clean verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=Netcentric_accesscontroltool -Dsonar.organization=netcentric -Dsonar.host.url=https://sonarcloud.io -DnvdApiKeyEnvironmentVariable=NVD_API_KEY -Pdependency-check,coverage-report,integration-tests + run: mvn -e -B -V clean verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=Netcentric_accesscontroltool -Dsonar.organization=netcentric -Dsonar.host.url=https://sonarcloud.io -DnvdApiKeyEnvironmentVariable=NVD_API_KEY -Pdependency-check -Pcoverage-report -Pintegration-tests -Pjavadoc - name: Build, Analyse and Deploy with Maven if: github.ref == 'refs/heads/develop' && matrix.isMainBuildEnv @@ -75,4 +75,4 @@ jobs: ACTOOL_IMS_IT_CLIENTSECRET: ${{ secrets.ACTOOL_IMS_IT_CLIENTSECRET }} ACTOOL_IMS_IT_PRODUCTPROFILE: ${{ vars.ACTOOL_IMS_IT_PRODUCTPROFILE }} ACTOOL_IMS_IT_USERID: ${{ vars.ACTOOL_IMS_IT_USERID }} - run: mvn -e -B -V clean deploy org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=Netcentric_accesscontroltool -Dsonar.organization=netcentric -Dsonar.host.url=https://sonarcloud.io -DnvdApiKeyEnvironmentVariable=NVD_API_KEY -Pdependency-check,coverage-report,integration-tests + run: mvn -e -B -V clean deploy org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=Netcentric_accesscontroltool -Dsonar.organization=netcentric -Dsonar.host.url=https://sonarcloud.io -DnvdApiKeyEnvironmentVariable=NVD_API_KEY -Pdependency-check -Pcoverage-report -Pintegration-tests -Pjavadoc diff --git a/accesscontroltool-bundle/src/main/java/biz/netcentric/cq/tools/actool/api/AcInstallationService.java b/accesscontroltool-bundle/src/main/java/biz/netcentric/cq/tools/actool/api/AcInstallationService.java index 34300d35..a5b1c4b4 100644 --- a/accesscontroltool-bundle/src/main/java/biz/netcentric/cq/tools/actool/api/AcInstallationService.java +++ b/accesscontroltool-bundle/src/main/java/biz/netcentric/cq/tools/actool/api/AcInstallationService.java @@ -25,11 +25,11 @@ public interface AcInstallationService { * Applies the configuration asynchronously. * Almost immediately returns a string with the ID of the started job. * Only one execution at a time is allowed. - * @param options + * @param options the installation options which further specify the installation * @throws IllegalStateException if another asynchronous installation is currently running * @return the job id * @since 3.6.0 - * @see #attachLogListener(String, InstallationLogListener) + * @see #attachLogListener(String, BiConsumer, Consumer) */ public String applyAsynchronously(InstallationOptions options); diff --git a/accesscontroltool-bundle/src/main/java/biz/netcentric/cq/tools/actool/api/InstallationOptionsBuilder.java b/accesscontroltool-bundle/src/main/java/biz/netcentric/cq/tools/actool/api/InstallationOptionsBuilder.java index e02f9cc0..defb7106 100644 --- a/accesscontroltool-bundle/src/main/java/biz/netcentric/cq/tools/actool/api/InstallationOptionsBuilder.java +++ b/accesscontroltool-bundle/src/main/java/biz/netcentric/cq/tools/actool/api/InstallationOptionsBuilder.java @@ -1,7 +1,5 @@ package biz.netcentric.cq.tools.actool.api; -import java.io.Serializable; - /*- * #%L * Access Control Tool Bundle @@ -35,6 +33,7 @@ public final class InstallationOptionsBuilder { /** * Creates a new builder with the given properties previously returned by {@link InstallationOptions#getPersistableProperties()}. + * @param properties the properties returned by {@link InstallationOptions#getPersistableProperties()} */ public InstallationOptionsBuilder(Map properties) { this.configurationRootPath = (String)properties.get("configurationRootPath"); diff --git a/accesscontroltool-oakindex-package/pom.xml b/accesscontroltool-oakindex-package/pom.xml index 2f4ce8c5..fb3d90dd 100644 --- a/accesscontroltool-oakindex-package/pom.xml +++ b/accesscontroltool-oakindex-package/pom.xml @@ -38,22 +38,12 @@ src/main/META-INF/vault/filter.xml true content + + + true + + - - - default-validate-package - - validate-package - - - - - true - - - - - diff --git a/pom.xml b/pom.xml index ef9f11cc..196a6932 100644 --- a/pom.xml +++ b/pom.xml @@ -562,6 +562,25 @@ + + javadoc + + + + org.apache.maven.plugins + maven-javadoc-plugin + + + attach-javadocs + + jar + + + + + + + release