From 60073ef9ba4b6a4a5cf2f98b74491c3dab297f94 Mon Sep 17 00:00:00 2001 From: Pavel Horal Date: Wed, 21 Feb 2024 12:51:03 +0100 Subject: [PATCH] Fix site build and deploy to GH Pages. --- .github/workflows/deploy.yml | 38 ++++++++++++++++++ audit/pom.xml | 6 --- .../forgerock/bloomfilter/package-info.java | 33 +++++++++++---- commons-bom/pom.xml | 11 +++-- doc-maven/doc-maven-plugin/pom.xml | 1 - pom.xml | 22 +++++----- src/site/resources/favicon.ico | Bin 0 -> 2462 bytes src/site/site.xml | 23 +++++++++++ 8 files changed, 102 insertions(+), 32 deletions(-) create mode 100644 .github/workflows/deploy.yml create mode 100644 src/site/resources/favicon.ico create mode 100644 src/site/site.xml diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 000000000..46aeee53b --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,38 @@ +name: deploy + +on: + push: + branches: + - main + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-java@v4 + with: + java-version: 17 + - uses: actions/cache@v4 + with: + path: ~/.m2 + key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }} + restore-keys: ${{ runner.os }}-m2 + - run: mvn -Pmetrics site site:deploy + - uses: actions/configure-pages@v4 + - uses: actions/upload-pages-artifact@v3 + with: + path: './target/deploy/' + - uses: actions/deploy-pages@v4 diff --git a/audit/pom.xml b/audit/pom.xml index 36ea18943..2d426c8c3 100644 --- a/audit/pom.xml +++ b/audit/pom.xml @@ -74,12 +74,6 @@ super-csv ${supercsv.version} - - - javax.servlet - javax.servlet-api - provided - diff --git a/bloomfilter/bloomfilter-core/src/main/java/org/forgerock/bloomfilter/package-info.java b/bloomfilter/bloomfilter-core/src/main/java/org/forgerock/bloomfilter/package-info.java index 9113c1c08..a2f671e2b 100644 --- a/bloomfilter/bloomfilter-core/src/main/java/org/forgerock/bloomfilter/package-info.java +++ b/bloomfilter/bloomfilter-core/src/main/java/org/forgerock/bloomfilter/package-info.java @@ -15,18 +15,23 @@ */ /** - *

ForgeRock Bloom Filters

+ *

ForgeRock Bloom Filters

+ * + *

* Implementations of thread-safe, scalable and rolling Bloom Filters. These are Set-like data structures that can * scale to very large numbers of entries while only using a small amount of memory (a few bits) per element. The * trade-off is that the set membership operation may report false positives (i.e., it may claim that an item is a * member of the set when it isn't). The probability of false positives can be tuned by increasing the amount of * memory used. - *

+ * + *

* The {@link org.forgerock.bloomfilter.BloomFilter} interface describes the general contract of bloom filters in * more detail, and the {@link org.forgerock.bloomfilter.BloomFilters} utility class provides static factory and * builder methods for constructing bloom filters for various requirements. * - *

Example

+ * + *

Example:

+ * * 
{@code
  *     BloomFilter blacklistedSessions = BloomFilters.create(Funnels.stringFunnel(UTF8))
  *              .withInitialCapacity(10000)         // Initial size
@@ -42,7 +47,9 @@
  *     }
  * }
* - *

Scalable and Rolling Bloom Filters

+ *

Scalable and Rolling Bloom Filters

+ * + *

* Beyond fixed-capacity Bloom Filters, whose probability of false positives rapidly increases once they have reached * capacity, this package also provides scalable and rolling Bloom Filters. The former are an * efficient and flexible implementation of the classic Information Processing Letters, 101(6), p.255–261, 2007. The latter are a * time-limited variation on this idea, whereby buckets in the scalable bloom filter can expire over time, freeing up * memory. The buckets are then recycled ensuring that memory usage is kept reasonable. - *

+ * + *

* Scalable Bloom Filters are useful for storing sets of objects where you do not know a priori the number * of elements you might need to store. By dynamically expanding the capacity of the Bloom Filter, as well as * reducing the false positive probability of subsequent buckets according to a geometric series, the Scalable Bloom @@ -60,13 +68,18 @@ * {@link org.forgerock.bloomfilter.BloomFilters.BloomFilterBuilder#withCapacityGrowthFactor(double)} builder methods * to configure the scale factors for capacity and false positive probability in these implementations. The defaults * (0.8 and 2.0 respectively) provide a good trade off of memory growth and performance. - *

+ * + *

* Rolling Bloom Filters allow elements in a Bloom Filter to expire over time. Use the {@link * org.forgerock.bloomfilter.BloomFilters.BloomFilterBuilder#withExpiryStrategy(org.forgerock.bloomfilter.ExpiryStrategy)} * method to configure how elements in your Bloom Filter will expire. By default, elements do not expire. * - *

Concurrency Strategies

+ *

Concurrency Strategies

+ * + *

* The implementations provided are currently all thread-safe, and adopt a flexible approach to concurrency control. + * + *

* Two concurrency strategies are currently supported: *

+ * + *

* Use the {@link org.forgerock.bloomfilter.BloomFilters.BloomFilterBuilder#withConcurrencyStrategy(org.forgerock.bloomfilter.ConcurrencyStrategy)} * method to specify the concurrency strategy to use. The default is COPY_ON_WRITE. * - *

Write Batching

+ *

Write Batching

+ * + *

* To compensate for the relatively poor performance of COPY_ON_WRITE concurrency (see previous section), the * implementation supports write batching. When enabled, individual calls to the {@link * org.forgerock.bloomfilter.BloomFilter#add(java.lang.Object)} method will be buffered in a traditional concurrent diff --git a/commons-bom/pom.xml b/commons-bom/pom.xml index 577bae338..373b7e8fe 100644 --- a/commons-bom/pom.xml +++ b/commons-bom/pom.xml @@ -36,6 +36,13 @@ https://wrensecurity.org + + + local + file:${maven.multiModuleProjectDirectory}/target/deploy/commons-bom + + + 2.10.9 3.19.0 @@ -673,8 +680,4 @@ - - - 22.6.0 - diff --git a/doc-maven/doc-maven-plugin/pom.xml b/doc-maven/doc-maven-plugin/pom.xml index 4f83ecd6e..b7490edd4 100644 --- a/doc-maven/doc-maven-plugin/pom.xml +++ b/doc-maven/doc-maven-plugin/pom.xml @@ -365,7 +365,6 @@ org.apache.maven.plugins maven-plugin-plugin - ${mavenPluginPluginVersion} diff --git a/pom.xml b/pom.xml index 4d9ef6b52..450bbd823 100644 --- a/pom.xml +++ b/pom.xml @@ -54,7 +54,7 @@ https://github.com/WrenSecurity/wrensec-commons scm:git:git://github.com/WrenSecurity/wrensec-commons.git scm:git:git@github.com:WrenSecurity/wrensec-commons.git - 22.6.0 + HEAD @@ -89,7 +89,7 @@ 1.7.6 - 3.1.0 + 1.2.0 @@ -104,6 +104,13 @@ + + + local + file:${maven.multiModuleProjectDirectory}/target/deploy/ + + + commons-bom audit @@ -134,16 +141,5 @@ - - - - org.apache.maven.plugins - maven-javadoc-plugin - - - -Xdoclint:none - - - diff --git a/src/site/resources/favicon.ico b/src/site/resources/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..9b35119cab89c8bbed7b4aa4756278b49f4bbeac GIT binary patch literal 2462 zcmbu9T}TvB6vyvq`BB*BXEV<3&WsThTIlZF1ND$CX_02BWTlnWLunrt3KfX?(FcW= z7MYr&phOS#5Jev^1=~~hP%lCdA_dV?Qj{+n)ZWhQ%(}bct~={2|DCya{^xfNch0?p zaQNeSg8wqPo=ivFZX6^Tj%!pOU5&Sh8Ou zpE)z~emgVih`MU?Im#DVI1(2tHYBbf)lM8~Yh-7}`gUg~d_g{={I*t_T|NL}b!v!t zkpnerBT@OnLdqArAiKf~;=yUK9zOl> zqRm5jS2gk(_UAZ=`v}-hl?V8p6I2=M!upZ_d>XkmD2DoovPP3b<+t3{`MZ40g6q>g z%a^W|BfrPsGhCligRkXyh*~fO^6&WgLYWh+M>+hy-wgf?NLLf7GWa5hUlhdGa<~>s zfa|jf`TwX;mH^fx#d`m1{nIi4@-2=k_kINNOXl#WaC`t&ftvS#iR0o4_D_{>kBPPY zvwVAV9>_f|>`$$KwDtEQqY|an?bjqe*P^szHsS^1egfj5DV^W=0qo}q$TtTA{AX{G zlZ)y_4Wa5#%OgUAUV^xHNnrn;Z3XE{67H{G0sfQvAiL>D5chCczelhCOfg88b{qRw zTc4k*{5a}b!zBl?c2ws#NFcQj2l)5yQjFPmU~eYK|D^N#-DcyX@q^THQRnxKMB_K>!TwAD`G%V+cRS6- zM(fA(A(<+D3!X84o`o^Oq1&aZGTYBWz_N@e<|} PL$6OAc>fxt8AkpC3U_R` literal 0 HcmV?d00001 diff --git a/src/site/site.xml b/src/site/site.xml new file mode 100644 index 000000000..aed30b3d7 --- /dev/null +++ b/src/site/site.xml @@ -0,0 +1,23 @@ + + + + +

+ + + +