Documentation

All user documentation in Juneau is provided through Javadocs.

The Javadocs overview document provides a general overview for all of Juneau. The package-level documents that link from the overview provide in-depth information on subtopics.

Table of Contents - 9.0-B1

  1. Overview

    1. Core Overviewcreated: 9.0.0

    2. DTO Library Overviewcreated: 9.0.0

    3. Config API Overviewcreated: 9.0.0

    4. REST Overviewcreated: 9.0.0

    5. REST Server Overview

    6. REST Client Overviewcreated: 9.0.0

    7. General Designcreated: 9.0.0

  2. juneau-marshall

    1. Bean Contextsupdated: 9.0.0

    2. Serializers and Parsersupdated: 9.0.0

    3. Marshalls

    4. Java Beans Supportcreated: 8.2.0, updated: 9.0.0

      1. @Bean Annotationupdated: 8.2.0,9.0.0

      2. @Beanp Annotationupdated: 8.1.0,8.1.2,9.0.0

      3. @Beanc Annotationupdated: 8.1.0,8.1.2

      4. @BeanIgnore Annotation

      5. @NameProperty Annotation

      6. @ParentProperty Annotation

      7. POJO Buildersupdated: 9.0.0

      8. Bypass Serialization using Readers and InputStreams

    5. HTTP Part Serializers and Parsersupdated: 8.2.0,9.0.0

    6. Context Settingsupdated: 8.1.3,9.0.0

    7. Context Annotationscreated: 8.1.0, updated: 8.1.3,8.2.0,9.0.0

    8. JsonMap and JsonListupdated: 8.2.0

    9. Complex Data Typescreated: 9.0.0

    10. SerializerSets and ParserSetsupdated: 9.0.0

    11. Swapsupdated: 9.0.0

      1. Default Swaps

      2. Auto-detected swapscreated: 8.1.0

      3. Per-media-type Swapsupdated: 8.1.0,8.2.0

      4. One-way Swaps

      5. @Swap Annotationupdated: 8.0.0,9.0.0

      6. Templated Swaps

      7. Surrogate Classes

    12. Dynamically Applied Annotationscreated: 8.1.3, updated: 9.0.0

    13. Bean Names and Dictionariesupdated: 9.0.0

      1. Bean Subtypes

    14. Virtual Beansupdated: 9.0.0

    15. Non-Tree Models and Recursion Detectionupdated: 9.0.0

    16. Parsing into Generic Modelsupdated: 8.2.0

    17. Reading Continuous Streamsupdated: 9.0.0

    18. URIsupdated: 9.0.0

    19. Comparison with Jacksonupdated: 9.0.0

    20. POJO Categories

    21. Fluent Assertionscreated: 9.0.0

    22. Simple Variable Language

      1. SVL Variablesupdated: 8.0.0,8.1.0

      2. VarResolvers and VarResolverSessionsupdated: 9.0.0

      3. VarResolver.DEFAULTcreated: 8.1.0

      4. Other Notes

    23. Encoderscreated: 9.0.0

    24. HTTP Partscreated: 9.0.0

      1. org.apache.juneau.httpcreated: 9.0.0

      2. org.apache.juneau.http.annotationcreated: 9.0.0

      3. org.apache.juneau.http.headercreated: 9.0.0

      4. org.apache.juneau.http.partcreated: 9.0.0

      5. org.apache.juneau.http.entitycreated: 9.0.0

      6. org.apache.juneau.http.resourcecreated: 9.0.0

      7. org.apache.juneau.http.responsecreated: 9.0.0

      8. org.apache.juneau.http.remotecreated: 9.0.0

    25. Object Toolscreated: 9.0.0

    26. JSON Details

      1. JSON Methodology

      2. JSON Serializersupdated: 9.0.0

      3. Simplified JSONupdated: 9.0.0

      4. JSON Parsersupdated: 9.0.0

      5. @Json Annotation

    27. JSON-Schema Support

    28. XML Details

      1. XML Methodology

      2. XML Serializersupdated: 9.0.0

      3. XML Parsersupdated: 9.0.0

      4. @Bean(typeName) Annotation

      5. @Xml(childName) Annotation

      6. @Xml(format) Annotation

      7. Namespaces

    29. HTML Details

      1. HTML Methodology

      2. HTML Serializersupdated: 9.0.0

      3. HTML Parsersupdated: 9.0.0

      4. @Html Annotation

      5. @Html(render) Annotation

      6. HtmlDocSerializerupdated: 9.0.0

      7. BasicHtmlDocTemplate

      8. Custom Templates

    30. HTML-Schema Support

    31. UON Details

      1. UON Methodology

      2. UON Serializersupdated: 9.0.0

      3. UON Parsersupdated: 9.0.0

    32. URL-Encoding Details

      1. URL-Encoding Methodology

      2. URL-Encoding Serializersupdated: 9.0.0

      3. URL-Encoding Parsersupdated: 9.0.0

      4. @UrlEncoding Annotation

    33. MessagePack Details

      1. MessagePack Serializersupdated: 9.0.0

      2. MessagePack Parsersupdated: 9.0.0

    34. OpenAPI Detailsupdated: 8.2.0

      1. OpenAPI Methodologyupdated: 8.2.0

      2. OpenAPI Serializersupdated: 8.2.0,9.0.0

      3. OpenAPI Parsersupdated: 8.2.0,9.0.0

    35. Best Practices

  3. juneau-marshall-rdf

    1. RDF Details

      1. RDF Serializersupdated: 9.0.0

      2. RDF Parsersupdated: 9.0.0

      3. @Rdf Annotation

      4. Namespacesupdated: 9.0.0

      5. URI Propertiesupdated: 9.0.0

      6. Root Propertyupdated: 9.0.0

      7. Typed Literalsupdated: 9.0.0

  4. juneau-dto

    1. HTML5

    2. Atom

    3. Swagger

    4. Swagger UI

  5. juneau-config

    1. Overviewupdated: 9.0.0

      1. Syntax Rules

    2. Reading Entriesupdated: 9.0.0

      1. POJOsupdated: 9.0.0

      2. Arrays

      3. Java Collection Framework Objectsupdated: 9.0.0

      4. Binary Dataupdated: 9.0.0

    3. Variablesupdated: 9.0.0

      1. Logic Variables

    4. Modded/Encoded Entriesupdated: 9.0.0

    5. Sectionsupdated: 9.0.0

    6. Setting Values

      1. File System Changes

      2. Custom Entry Serialization

      3. Setting Values in Bulk

    7. Listeners

    8. Serializingupdated: 9.0.0

    9. Importsupdated: 8.1.0

    10. Config Storesupdated: 9.0.0

      1. MemoryStore

      2. FileStoreupdated: 9.0.0

      3. Custom ConfigStoresupdated: 9.0.0

      4. ConfigStore Listeners

    11. Read-only Configsupdated: 9.0.0

    12. Closing Configs

    13. System Default Configcreated: 8.0.0, updated: 8.1.0

  6. juneau-rest-serverupdated: 9.0.0

    1. Overviewcreated: 9.0.0

    2. @Rest-Annotated Classesupdated: 8.1.2,9.0.0

      1. Predefined Classesupdated: 9.0.0

      2. Child Resourcesupdated: 9.0.0

      3. Path Variablesupdated: 9.0.0

      4. Deploymentupdated: 9.0.0

      5. Lifecycle Hooksupdated: 9.0.0

    3. @RestOp-Annotated Methodsupdated: 9.0.0

      1. Inferred HTTP Methods and Pathsupdated: 9.0.0

      2. Java Method Parametersupdated: 9.0.0

      3. Java Method Return Typesupdated: 9.0.0

      4. Java Method Throwable Typesupdated: 9.0.0

      5. Path Patternsupdated: 9.0.0

      6. Matchersupdated: 9.0.0

      7. Overloading HTTP Methods

      8. Additional Informationupdated: 9.0.0

    4. HTTP Partsupdated: 9.0.0

      1. Part Marshallersupdated: 8.1.0,9.0.0

      2. HTTP Part Annotationsupdated: 8.1.0,9.0.0

      3. Default Partscreated: 9.0.0

      4. @Request Beansupdated: 8.1.0,9.0.0

      5. @Response Beansupdated: 8.1.0,9.0.0

      6. HTTP Part APIscreated: 9.0.0

    5. Marshallingupdated: 9.0.0

    6. Form Postsupdated: 9.0.0

    7. Guardsupdated: 9.0.0

    8. Convertersupdated: 9.0.0

    9. Localized Messagesupdated: 8.2.0,9.0.0

    10. Encodersupdated: 9.0.0

    11. Configuration Filesupdated: 9.0.0

    12. SVL Variablesupdated: 9.0.0

    13. Static filesupdated: 9.0.0

    14. Client Versioningupdated: 9.0.0

    15. Swagger

      1. BasicRestServlet/BasicRestObjectupdated: 8.1.0,9.0.0

      2. Basic Swagger Infoupdated: 9.0.0

      3. Tags

      4. Operations

      5. Parametersupdated: 9.0.0

      6. Responses

      7. Modelsupdated: 9.0.0

      8. SwaggerUI.css

    16. REST method execution statisticscreated: 8.1.3, updated: 9.0.0

    17. @HtmlDocConfigupdated: 8.1.0,9.0.0

      1. User Interfaces (UI) vs. Developer Interfaces (DI)

      2. Widgetsupdated: 9.0.0

      3. Predefined Widgetsupdated: 9.0.0

      4. UI Customizationupdated: 9.0.0

      5. Stylesheetsupdated: 8.1.0,9.0.0

    18. Logging / Debuggingcreated: 9.0.0

    19. HTTP Status Codesupdated: 9.0.0

    20. Built-in Parametersupdated: 9.0.0

    21. Using with OSGi

    22. RestContextcreated: 9.0.0

    23. RestOpContextcreated: 9.0.0

    24. Response Processorscreated: 9.0.0

    25. REST/RPCupdated: 8.0.0,9.0.0

    26. Serializing URIsupdated: 9.0.0

    27. Utility Beanscreated: 9.0.0

    28. Using with HTML Beanscreated: 9.0.0

    29. Other Notes

  7. juneau-rest-server-rdf

  8. juneau-rest-server-jaxrs

    1. Juneau JAX-RS Provider

  9. juneau-rest-server-springbootcreated: 8.0.0, updated: 9.0.0

    1. Overviewcreated: 8.0.0, updated: 9.0.0

  10. juneau-rest-clientupdated: 9.0.0

    1. POJO Marshallingcreated: 8.2.0, updated: 9.0.0

    2. Request Partscreated: 8.2.0, updated: 9.0.0

    3. Request Contentcreated: 8.2.0, updated: 9.0.0

    4. Response Statuscreated: 8.1.0, updated: 9.0.0

    5. Response Headerscreated: 8.2.0, updated: 9.0.0

    6. Response Contentcreated: 8.2.0, updated: 9.0.0

    7. Custom Call Handlerscreated: 8.2.0, updated: 9.0.0

    8. Interceptorscreated: 8.2.0

    9. REST Proxiescreated: 8.2.0, updated: 9.0.0

      1. @Remoteupdated: 9.0.0

      2. @RemoteOpupdated: 9.0.0

      3. @Contentupdated: 9.0.0

      4. @FormDataupdated: 9.0.0

      5. @Queryupdated: 9.0.0

      6. @Headerupdated: 9.0.0

      7. @Pathupdated: 9.0.0

      8. @Requestupdated: 9.0.0

      9. @Responseupdated: 9.0.0

      10. Dual-purpose (end-to-end) interfacescreated: 8.0.0

    10. Logging and Debuggingcreated: 8.2.0, updated: 9.0.0

    11. Customizing HttpClientcreated: 8.2.0, updated: 9.0.0

    12. Extending RestClientcreated: 8.2.0

    13. Authenticationupdated: 8.2.0

      1. BASIC Authentication

      2. FORM-based Authentication

      3. OIDC Authentication

  11. juneau-rest-mockcreated: 8.1.0, updated: 8.2.0

    1. MockRestClientcreated: 8.2.0, updated: 9.0.0

  12. juneau-microservice-corecreated: 8.1.0, deprecated: 8.1.2

    1. Microservice Overviewcreated: 8.0.0, deprecated: 8.1.2

    2. Lifecycle Methodscreated: 8.0.0, deprecated: 8.1.2

    3. Argscreated: 8.0.0, deprecated: 8.1.2

    4. Manifestcreated: 8.0.0, deprecated: 8.1.2

    5. Configcreated: 8.0.0, deprecated: 8.1.2

    6. System propertiescreated: 8.0.0, deprecated: 8.1.2

    7. VarResolvercreated: 8.0.0, deprecated: 8.1.2

    8. Console Commandscreated: 8.0.0, deprecated: 8.1.2

    9. Listenerscreated: 8.0.0, deprecated: 8.1.2

  13. juneau-microservice-jettycreated: 8.1.0, deprecated: 8.1.2

    1. Overviewcreated: 8.0.0, deprecated: 8.1.2

    2. Lifecycle Methodscreated: 8.0.0, deprecated: 8.1.2

    3. Resource Classescreated: 8.0.0, deprecated: 8.1.2

    4. Predefined Resource Classescreated: 8.0.0, deprecated: 8.1.2

    5. Configcreated: 8.0.0, deprecated: 8.1.2

    6. Jetty.xml filecreated: 8.0.0, deprecated: 8.1.2

    7. UI Customizationcreated: 8.0.0, deprecated: 8.1.2

    8. Extending JettyMicroservicecreated: 8.0.0, deprecated: 8.1.2

  14. my-jetty-microservicecreated: 8.1.0, deprecated: 8.1.2

    1. Installing in Eclipsecreated: 8.0.0, deprecated: 8.1.2

    2. Running in Eclipsecreated: 8.0.0, deprecated: 8.1.2

    3. Building and Running from Command-Linecreated: 8.0.0, deprecated: 8.1.2

  15. my-springboot-microservicecreated: 8.0.0

    1. Installing in Eclipsecreated: 8.0.0

    2. Running in Eclipsecreated: 8.0.0

    3. Building and Running from Command-Linecreated: 8.0.0

  16. juneau-pestorecreated: 8.2.0, todo

  17. Glossariescreated: 8.1.3

    1. Language Supportcreated: 8.1.3

    2. Annotationscreated: 8.1.3

  18. Security Best-Practices

    1. juneau-marshallcreated: 8.2.0

    2. juneau-svlcreated: 8.2.0

    3. juneau-rest-servercreated: 8.2.0