# owasp/owasp-java-encoder architecture

> Architecture diagram of the GitHub repository owasp/owasp-java-encoder, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/owasp/owasp-java-encoder
- Repository: https://github.com/owasp/owasp-java-encoder

## Overview

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: [`core/src/main/java/org/owasp/encoder/Encoders.java`](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/Encoders.java) (Encoder registry), [`core/src/main/java/org/owasp/encoder/Encode.java`](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/Encode.java) (Encode facade), [`core/src/main/java/org/owasp/encoder/Encoder.java`](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/Encoder.java) (Streaming encoder base), [`core/src/main/java/org/owasp/encoder/Unicode.java`](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/Unicode.java) (Unicode helpers)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Core API"]
  node_facade["Encode facade<br/>[Encode.java]"]
  node_registry["Encoder registry<br/>[Encoders.java]"]
  node_base["Streaming encoder base<br/>[Encoder.java]"]
  node_encodedwriter["Encoded writer<br/>[EncodedWriter.java]"]
end

subgraph group_contexts["Context Encoders"]
  node_html["HTML encoding<br/>[HTMLEncoder.java]"]
  node_xml["XML encoding<br/>[XMLEncoder.java]"]
  node_cdata["CDATA encoding<br/>[CDATAEncoder.java]"]
  node_xmlcomment["XML comments"]
  node_javascript["JavaScript encoding"]
  node_css["CSS encoding<br/>[CSSEncoder.java]"]
  node_uri["URI encoding<br/>[URIEncoder.java]"]
  node_json["JSON encoding<br/>[JSONEncoder.java]"]
  node_java["Java literal encoding<br/>[JavaEncoder.java]"]
  node_unicode["Unicode helpers<br/>[Unicode.java]"]
end

subgraph group_views["View Adapters"]
  node_jsp["javax JSP tags"]
  node_jakarta["Jakarta JSP tags"]
end

node_application(("Java application"))
node_view(("JSP view"))

node_application -->|"selects context"| node_facade
node_view -->|"uses tags"| node_jsp
node_view -->|"uses tags"| node_jakarta
node_jsp -->|"calls encoding"| node_facade
node_jakarta -->|"calls encoding"| node_facade
node_facade -->|"selects encoder"| node_registry
node_registry -->|"registers encoder"| node_html
node_registry -->|"registers encoder"| node_xml
node_registry -->|"registers encoder"| node_cdata
node_registry -->|"registers encoder"| node_xmlcomment
node_registry -->|"registers encoder"| node_javascript
node_registry -->|"registers encoder"| node_css
node_registry -->|"registers encoder"| node_uri
node_registry -->|"registers encoder"| node_json
node_registry -->|"registers encoder"| node_java
node_html -->|"extends"| node_base
node_xml -->|"extends"| node_base
node_javascript -->|"extends"| node_base
node_uri -->|"extends"| node_base
node_html -->|"uses character checks"| node_unicode
node_xml -->|"uses character checks"| node_unicode
node_javascript -->|"uses character checks"| node_unicode
node_uri -->|"uses character checks"| node_unicode

click node_facade "https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/Encode.java"
click node_registry "https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/Encoders.java"
click node_base "https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/Encoder.java"
click node_encodedwriter "https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/EncodedWriter.java"
click node_html "https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/HTMLEncoder.java"
click node_xml "https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/XMLEncoder.java"
click node_cdata "https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/CDATAEncoder.java"
click node_xmlcomment "https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/XMLCommentEncoder.java"
click node_javascript "https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/JavaScriptEncoder.java"
click node_css "https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/CSSEncoder.java"
click node_uri "https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/URIEncoder.java"
click node_json "https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/JSONEncoder.java"
click node_java "https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/JavaEncoder.java"
click node_unicode "https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/Unicode.java"
click node_jsp "https://github.com/owasp/owasp-java-encoder/tree/main/jsp/src/main/java/org/owasp/encoder/tag"
click node_jakarta "https://github.com/owasp/owasp-java-encoder/tree/main/jakarta/src/main/java/org/owasp/encoder/tag"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_facade,node_registry,node_base,node_encodedwriter,node_view toneBlue
class node_html,node_xml,node_cdata,node_xmlcomment,node_javascript,node_css,node_uri,node_json,node_java,node_unicode toneAmber
class node_jsp,node_jakarta toneMint
class node_application toneIndigo
```

## Components

### Core API

- [Encode facade](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/Encode.java): `core/src/main/java/org/owasp/encoder/Encode.java`
- [Encoder registry](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/Encoders.java): `core/src/main/java/org/owasp/encoder/Encoders.java`
- [Streaming encoder base](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/Encoder.java): `core/src/main/java/org/owasp/encoder/Encoder.java`
- [Encoded writer](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/EncodedWriter.java): `core/src/main/java/org/owasp/encoder/EncodedWriter.java`

### Context Encoders

- [HTML encoding](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/HTMLEncoder.java): `core/src/main/java/org/owasp/encoder/HTMLEncoder.java`
- [XML encoding](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/XMLEncoder.java): `core/src/main/java/org/owasp/encoder/XMLEncoder.java`
- [CDATA encoding](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/CDATAEncoder.java): `core/src/main/java/org/owasp/encoder/CDATAEncoder.java`
- [XML comments](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/XMLCommentEncoder.java): `core/src/main/java/org/owasp/encoder/XMLCommentEncoder.java`
- [JavaScript encoding](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/JavaScriptEncoder.java): `core/src/main/java/org/owasp/encoder/JavaScriptEncoder.java`
- [CSS encoding](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/CSSEncoder.java): `core/src/main/java/org/owasp/encoder/CSSEncoder.java`
- [URI encoding](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/URIEncoder.java): `core/src/main/java/org/owasp/encoder/URIEncoder.java`
- [JSON encoding](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/JSONEncoder.java): `core/src/main/java/org/owasp/encoder/JSONEncoder.java`
- [Java literal encoding](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/JavaEncoder.java): `core/src/main/java/org/owasp/encoder/JavaEncoder.java`
- [Unicode helpers](https://github.com/owasp/owasp-java-encoder/blob/main/core/src/main/java/org/owasp/encoder/Unicode.java): `core/src/main/java/org/owasp/encoder/Unicode.java`

### View Adapters

- [javax JSP tags](https://github.com/owasp/owasp-java-encoder/tree/main/jsp/src/main/java/org/owasp/encoder/tag): `jsp/src/main/java/org/owasp/encoder/tag`
- [Jakarta JSP tags](https://github.com/owasp/owasp-java-encoder/tree/main/jakarta/src/main/java/org/owasp/encoder/tag): `jakarta/src/main/java/org/owasp/encoder/tag`

### Other components

- **Java application**
- **JSP view**

## Connections

- Java application → Encode facade: selects context (evidence: `README.md`)
- JSP view → javax JSP tags: uses tags (evidence: `README.md`)
- JSP view → Jakarta JSP tags: uses tags (evidence: `README.md`)
- javax JSP tags → Encode facade: calls encoding (evidence: `jsp/src/main/java/org/owasp/encoder/tag/ForHtmlTag.java`)
- Jakarta JSP tags → Encode facade: calls encoding (evidence: `jakarta/src/main/java/org/owasp/encoder/tag/ForHtmlAttributeTag.java`)
- Encode facade → Encoder registry: selects encoder (evidence: `core/src/main/java/org/owasp/encoder/Encode.java`)
- Encoder registry → HTML encoding: registers encoder (evidence: `core/src/main/java/org/owasp/encoder/Encoders.java`)
- Encoder registry → XML encoding: registers encoder (evidence: `core/src/main/java/org/owasp/encoder/Encoders.java`)
- Encoder registry → CDATA encoding: registers encoder (evidence: `core/src/main/java/org/owasp/encoder/Encoders.java`)
- Encoder registry → XML comments: registers encoder (evidence: `core/src/main/java/org/owasp/encoder/Encoders.java`)
- Encoder registry → JavaScript encoding: registers encoder (evidence: `core/src/main/java/org/owasp/encoder/Encoders.java`)
- Encoder registry → CSS encoding: registers encoder (evidence: `core/src/main/java/org/owasp/encoder/Encoders.java`)
- Encoder registry → URI encoding: registers encoder (evidence: `core/src/main/java/org/owasp/encoder/Encoders.java`)
- Encoder registry → JSON encoding: registers encoder (evidence: `core/src/main/java/org/owasp/encoder/Encoders.java`)
- Encoder registry → Java literal encoding: registers encoder (evidence: `core/src/main/java/org/owasp/encoder/Encoders.java`)
- HTML encoding → Streaming encoder base: extends (evidence: `core/src/main/java/org/owasp/encoder/HTMLEncoder.java`)
- XML encoding → Streaming encoder base: extends (evidence: `core/src/main/java/org/owasp/encoder/XMLEncoder.java`)
- JavaScript encoding → Streaming encoder base: extends (evidence: `core/src/main/java/org/owasp/encoder/JavaScriptEncoder.java`)
- URI encoding → Streaming encoder base: extends (evidence: `core/src/main/java/org/owasp/encoder/URIEncoder.java`)
- HTML encoding → Unicode helpers: uses character checks (evidence: `core/src/main/java/org/owasp/encoder/HTMLEncoder.java`)
- XML encoding → Unicode helpers: uses character checks (evidence: `core/src/main/java/org/owasp/encoder/XMLEncoder.java`)
- JavaScript encoding → Unicode helpers: uses character checks (evidence: `core/src/main/java/org/owasp/encoder/JavaScriptEncoder.java`)
- URI encoding → Unicode helpers: uses character checks (evidence: `core/src/main/java/org/owasp/encoder/URIEncoder.java`)
