How owasp/owasp-java-encoder works
OWASP Java Encoder is a dependency-free Java library for contextual output encoding, with optional JSP and Jakarta tag adapters. The main workflow is application code (or a view tag) selecting an output context, calling the core facade, and writing encoded text; callers supply trusted surrounding syntax. The graph covers the documented HTML, XML, JavaScript, CSS, URI, JSON, and Java-string contexts. Source excerpts are partial, so adapter internals and some encoder-to-base-class links are represented only where the index or README supports them.
Main entry points: Encoders.java Encoder registry · Encode.java Encode facade · Encoder.java Streaming encoder base · Unicode.java Unicode helpers
Components 18
Core API
- Encode facade
core/src/main/java/org/owasp/encoder/Encode.java - Encoder registry
core/src/main/java/org/owasp/encoder/Encoders.java - Streaming encoder base
core/src/main/java/org/owasp/encoder/Encoder.java - Encoded writer
core/src/main/java/org/owasp/encoder/EncodedWriter.java
Context Encoders
- HTML encoding
core/src/main/java/org/owasp/encoder/HTMLEncoder.java - XML encoding
core/src/main/java/org/owasp/encoder/XMLEncoder.java - CDATA encoding
core/src/main/java/org/owasp/encoder/CDATAEncoder.java - XML comments
core/src/main/java/org/owasp/encoder/XMLCommentEncoder.java - JavaScript encoding
core/src/main/java/org/owasp/encoder/JavaScriptEncoder.java - CSS encoding
core/src/main/java/org/owasp/encoder/CSSEncoder.java - URI encoding
core/src/main/java/org/owasp/encoder/URIEncoder.java - JSON encoding
core/src/main/java/org/owasp/encoder/JSONEncoder.java - Java literal encoding
core/src/main/java/org/owasp/encoder/JavaEncoder.java - Unicode helpers
core/src/main/java/org/owasp/encoder/Unicode.java
View Adapters
- javax JSP tags
jsp/src/main/java/org/owasp/encoder/tag - Jakarta JSP tags
jakarta/src/main/java/org/owasp/encoder/tag
Other components
- Java application
- JSP view
Connections 23
- Java application → Encode facade: selects context
README.md - JSP view → javax JSP tags: uses tags
README.md - JSP view → Jakarta JSP tags: uses tags
README.md - javax JSP tags → Encode facade: calls encoding
jsp/src/main/java/org/owasp/encoder/tag/ForHtmlTag.java - Jakarta JSP tags → Encode facade: calls encoding
jakarta/src/main/java/org/owasp/encoder/tag/ForHtmlAttributeTag.java - Encode facade → Encoder registry: selects encoder
core/src/main/java/org/owasp/encoder/Encode.java - Encoder registry → HTML encoding: registers encoder
core/src/main/java/org/owasp/encoder/Encoders.java - Encoder registry → XML encoding: registers encoder
core/src/main/java/org/owasp/encoder/Encoders.java - Encoder registry → CDATA encoding: registers encoder
core/src/main/java/org/owasp/encoder/Encoders.java - Encoder registry → XML comments: registers encoder
core/src/main/java/org/owasp/encoder/Encoders.java - Encoder registry → JavaScript encoding: registers encoder
core/src/main/java/org/owasp/encoder/Encoders.java - Encoder registry → CSS encoding: registers encoder
core/src/main/java/org/owasp/encoder/Encoders.java - Encoder registry → URI encoding: registers encoder
core/src/main/java/org/owasp/encoder/Encoders.java - Encoder registry → JSON encoding: registers encoder
core/src/main/java/org/owasp/encoder/Encoders.java - Encoder registry → Java literal encoding: registers encoder
core/src/main/java/org/owasp/encoder/Encoders.java - HTML encoding → Streaming encoder base: extends
core/src/main/java/org/owasp/encoder/HTMLEncoder.java - XML encoding → Streaming encoder base: extends
core/src/main/java/org/owasp/encoder/XMLEncoder.java - JavaScript encoding → Streaming encoder base: extends
core/src/main/java/org/owasp/encoder/JavaScriptEncoder.java - URI encoding → Streaming encoder base: extends
core/src/main/java/org/owasp/encoder/URIEncoder.java - HTML encoding → Unicode helpers: uses character checks
core/src/main/java/org/owasp/encoder/HTMLEncoder.java - XML encoding → Unicode helpers: uses character checks
core/src/main/java/org/owasp/encoder/XMLEncoder.java - JavaScript encoding → Unicode helpers: uses character checks
core/src/main/java/org/owasp/encoder/JavaScriptEncoder.java - URI encoding → Unicode helpers: uses character checks
core/src/main/java/org/owasp/encoder/URIEncoder.java