Skip to content

JCR-5197: cleanup o.a.j.util.Base64 and update Javadoc #300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
reschke merged 1 commit into from
Nov 11, 2025
Merged

JCR-5197: cleanup o.a.j.util.Base64 and update Javadoc #300

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions jackrabbit-jcr-commons/src/main/java/org/apache/jackrabbit/util/Base64.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,14 @@
import java.io.Writer;
import java.io.BufferedWriter;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;

/**
* <code>Base64</code> provides Base64 encoding/decoding of strings and streams.
* <p>
* See <a href="https://datatracker.ietf.org/doc/html/rfc4648#section-4">RFC 4648, Section 4</a>.
* <p>
* See {@link java.util.Base64} for a JDK alternative.
Copy link
Member

@kwin kwin Oct 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not deprecate it in favor of Java one?

Copy link
Contributor Author

@reschke reschke Oct 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because of all the convenience methods.

Maybe we can deprecate some if the methods though.

*/
public class Base64 {

Expand All @@ -46,9 +51,7 @@ public class Base64 {

static {
// initialize decoding table
for (int i = 0; i < DECODETABLE.length; i++) {
DECODETABLE[i] = 0x7f;
}
Arrays.fill(DECODETABLE, (byte) 0x7f);
// build decoding table
for (int i = 0; i < BASE64CHARS.length; i++) {
DECODETABLE[BASE64CHARS[i]] = (byte) i;
Expand All @@ -65,11 +68,10 @@ private Base64() {
}

/**
* Base64-decodes or -encodes (see {@link #decodeOrEncode(String)}
* Base64-decodes or -encodes (see {@link #decodeOrEncode(String)})
* all the given arguments and prints the results on separate lines
* in standard output.
*
* @since Apache Jackrabbit 2.3
* @param args command line arguments to be decoded or encoded
*/
public static void main(String[] args) {
Expand All @@ -80,10 +82,9 @@ public static void main(String[] args) {

/**
* Base64-decodes or -encodes the given string, depending on whether
* or not it contains a "{base64}" prefix. If the string gets encoded,
* it contains a "{base64}" prefix. If the string gets encoded,
* the "{base64}" prefix is added to it.
*
* @since Apache Jackrabbit 2.3
* @param data string to be decoded or encoded
* @return decoded or encoded string
*/
Expand All @@ -101,7 +102,6 @@ public static String decodeOrEncode(String data) {
* If the given string is <code>null</code>, then <code>null</code>
* is returned.
*
* @since Apache Jackrabbit 2.3
* @param data string to be decoded, can be <code>null</code>
* @return the given string, possibly decoded
*/
Expand Down Expand Up @@ -233,7 +233,6 @@ public static void encode(byte[] data, int off, int len, Writer writer)
/**
* Returns the base64 representation of UTF-8 encoded string.
*
* @since Apache Jackrabbit 2.3
* @param data the string to be encoded
* @return base64-encoding of the string
*/
Expand All @@ -254,15 +253,14 @@ public static String encode(String data) {
* The given string is returned as-is if it doesn't contain a valid
* base64 encoding.
*
* @since Apache Jackrabbit 2.3
* @param data the base64-encoded data to be decoded
* @return decoded string
*/
public static String decode(String data) {
try {
ByteArrayOutputStream buffer = new ByteArrayOutputStream();
decode(data, buffer);
return new String(buffer.toByteArray(), StandardCharsets.UTF_8);
return buffer.toString(StandardCharsets.UTF_8);
} catch (IllegalArgumentException e) {
return data;
} catch (IOException e) { // should never happen
Expand Down