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 - 8.2.0

  1. Introduction

    1. Features8.1.0-updated

    2. Components

  2. juneau-marshall

    1. Serializers

    2. Parsers

    3. Marshalls

    4. Java Beans Support8.2.0-new

      1. @Bean Annotation8.2.0-updated

      2. @Beanp Annotation8.1.0-updated, 8.1.2-updated

      3. @Beanc Annotation8.1.0-updated, 8.1.2-updated

      4. @BeanIgnore Annotation

      5. @NameProperty Annotation

      6. @ParentProperty Annotation

      7. POJO Builders

      8. BeanFilter Class

      9. Interface Filters

      10. Stop Classes

      11. Bypass Serialization using Readers and InputStreams

    5. HTTP Part Serializers8.2.0-updated

    6. HTTP Part Parsers8.2.0-updated

    7. Configurable Properties8.1.3-updated

    8. Configurable Annotations8.1.0-new, 8.1.3-updated, 8.2.0-updated

    9. OMap and OListupdated-8.2.0

    10. SerializerGroups and ParserGroups

    11. Contexts, Builders, Sessions, and PropertyStores

    12. Transforms

      1. Swaps8.1.0-updated,8.2.0-updated

      2. Default PojoSwaps

      3. Auto-detected POJO swaps8.1.0-new

      4. Per-media-type Swaps8.1.0-updated,8.2.0-updated

      5. One-way Swaps

      6. @Swap Annotation8.0.0-updated

      7. Templated Swaps

      8. Surrogate Classes

    13. Dynamically Applied Annotations8.1.3-new

    14. Bean Names and Dictionaries

      1. Bean Subtypes

    15. Virtual Beans

    16. Non-Tree Models and Recursion Detection

    17. Parsing into Generic Modelsupdated-8.2.0

    18. Reading Continuous Streams

    19. URIs

    20. Comparison with Jackson

    21. POJO Categories

    22. JSON Details

      1. JSON Methodology

      2. JSON Serializers

      3. Simplified JSON

      4. JSON Parsers

      5. @Json Annotation

      6. JSON-Schema Support

    23. XML Details

      1. XML Methodology

      2. XML Serializers

      3. XML Parsers

      4. @Bean(typeName) Annotation

      5. @Xml(childName) Annotation

      6. @Xml(format) Annotation

      7. Namespaces

    24. HTML Details

      1. HTML Methodology

      2. HTML Serializers

      3. HTML Parsers

      4. @Html Annotation

      5. @Html(render) Annotation

      6. HtmlDocSerializer

      7. BasicHtmlDocTemplate

      8. Custom Templates

      9. HTML-Schema Support

    25. UON Details

      1. UON Methodology

      2. UON Serializers

      3. UON Parsers

    26. URL-Encoding Details

      1. URL-Encoding Methodology

      2. URL-Encoding Serializers

      3. URL-Encoding Parsers

      4. @UrlEncoding Annotation

    27. MessagePack Details

      1. MessagePack Serializers

      2. MessagePack Parsers

    28. OpenAPI Details8.2.0-updated

      1. OpenAPI Methodology8.2.0-updated

      2. OpenAPI Serializers8.2.0-updated

      3. OpenAPI Parsers8.2.0-updated

    29. Simple Variable Language

      1. SVL Variables8.0.0-updated, 8.1.0-updated

      2. VarResolvers and VarResolverSessions

      3. VarResolver.DEFAULT8.1.0-new

      4. Other Notes

    30. Best Practices

  3. juneau-marshall-rdf

    1. RDF Details

      1. RDF Serializers

      2. RDF Parsers

      3. @Rdf Annotation

      4. Namespaces

      5. URI Properties

      6. Root Property

      7. Typed Literals

  4. juneau-dto

    1. HTML5

    2. Atom

    3. Swagger

    4. Swagger UI

  5. juneau-config

    1. Overview

    2. Entry Types

      1. Primitive Types

      2. POJOs

      3. Arrays

      4. Collections

      5. Binary Data

    3. Variables

      1. Logic Variables

    4. Encoded Entries

    5. Section Maps

    6. Section Beans

    7. Section Interfaces

    8. Setting Values

      1. File System Changes

      2. Custom Entry Serialization

      3. Setting Values in Bulk

    9. Listeners

    10. Serializing

    11. Imports8.1.0-updated

    12. Config Stores

      1. ConfigMemoryStore

      2. ConfigFileStore

      3. Custom ConfigStores

      4. ConfigStore Listeners

    13. Read-only Configs

    14. Closing Configs

    15. System Default Config8.0.0-new, 8.1.0-updated

  6. juneau-rest-server

    1. Hello World Example

    2. Class Hierarchy8.1.0-updated

    3. Instantiation

      1. RestServlet

      2. BasicRestServlet8.1.0-updated

      3. BasicRest8.1.0-new

      4. Children

      5. BasicRestServletGroup8.1.0-updated

      6. BasicRestGroup8.1.0-new

      7. Resource Resolvers

      8. Lifecycle Hooks

    4. @Rest8.1.2-updated

      1. Annotation Inheritance

      2. @Rest(path)8.1.0-new, 8.1.2-updated

    5. RestContext

    6. @RestMethod

      1. Java Method Parameters

      2. RestRequest

      3. RestResponse

      4. RequestBody

      5. RequestHeaders

      6. RequestAttributes8.1.0-new

      7. RequestQuery

      8. RequestFormData

      9. @RestMethod(path)

      10. RequestPathMatch

      11. Method Return Types

      12. ReaderResource (TODO)

      13. StreamResource (TODO)

      14. @RestMethod(matchers)

      15. Predefined Responses

      16. Predefined Exceptions

      17. Predefined Helper Beans

    7. REST/RPC8.0.0-updated

    8. OpenAPI Schema Part Parsing

    9. OpenAPI Schema Part Serializing

    10. HTTP-Part Annotations

      1. @Body8.1.0-updated

      2. @FormData8.1.0-updated

      3. @HasFormData

      4. @Query

      5. @HasQuery

      6. @Header

      7. @Path

      8. @Request

      9. @Response

      10. @ResponseHeader

      11. @ResponseStatus

    11. Handling Form Posts

    12. Handling Multi-Part Form Posts8.0.0-updated

    13. Serializers

    14. Parsers

    15. Configurable Properties8.1.0-updated

    16. Configurable Annotations8.1.0-new

    17. Transforms8.1.0-updated

    18. URIs

    19. Guards

    20. Role guards8.1.0-new

    21. Converters

    22. Messages8.2.0-updated

    23. Encoders

    24. SVL Variables

    25. Configuration Files

    26. Static files

    27. Client Versioning

    28. RestInfoProvider

      1. BasicRestInfoProvider

    29. Swagger

      1. BasicRestServlet8.1.0-updated

      2. Basic Swagger Info

      3. Tags

      4. Operations

      5. Parameters

      6. Parameter Examples8.1.0-updated

      7. Responses

      8. Response Examples

      9. Models

      10. SwaggerUI.css

    30. REST method execution statistics8.1.3-new

    31. @HtmlDocConfig8.1.0-updated

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

      2. Widgets

      3. Predefined Widgets

      4. UI Customization

      5. Stylesheets8.1.0-updated

    32. Default Headers

    33. Logging / Debugging8.1.0-new,8.2.0-updated

    34. HTTP Status Codes

    35. Overloading HTTP Methods

    36. Built-in Parameters

    37. Custom Serializers and Parsers

    38. Using with OSGi

    39. Using with Spring and Injection frameworks

    40. Using HTTP/2 features

    41. Other Notes

  7. juneau-rest-server-jaxrs

    1. Juneau JAX-RS Provider

  8. juneau-rest-server-springboot8.0.0-new

    1. Overview8.0.0-new

    2. Child Resources8.1.0-new

  9. juneau-rest-client8.2.0-updated

    1. POJO Marshalling8.2.0-new

    2. Request Headers8.2.0-new

    3. Request Query Parameters8.2.0-new

    4. Request Form Data8.2.0-new

    5. Request Body8.2.0-new

    6. Response Status8.2.0-new

    7. Response Headers8.2.0-new

    8. Response Body8.2.0-new

    9. Custom Call Handlers8.2.0-new

    10. Interceptors8.2.0-new

    11. REST Proxies8.2.0-updated

      1. @Remote8.1.2-updated,8.2.0-updated

      2. @RemoteMethod8.2.0-updated

      3. @Body8.2.0-updated

      4. @FormData8.2.0-updated

      5. @Query8.2.0-updated

      6. @Header8.2.0-updated

      7. @Path8.2.0-updated

      8. @Request

      9. @Response

      10. Dual-purpose (end-to-end) interfaces8.0.0-new

    12. Logging and Debugging8.2.0-new

    13. Customizing HttpClient8.2.0-new

    14. Extending RestClient8.2.0-new

    15. Authentication8.2.0-updated

  10. juneau-rest-mock8.1.0-new,8.2.0-updated

    1. MockRestClient8.2.0-new

  11. juneau-microservice-core8.0.0-new, 8.1.2-deprecated

    1. Microservice Overview8.0.0-new, 8.1.2-deprecated

    2. Lifecycle Methods8.0.0-new, 8.1.2-deprecated

    3. Args8.0.0-new, 8.1.2-deprecated

    4. Manifest8.0.0-new, 8.1.2-deprecated

    5. Config8.0.0-new, 8.1.2-deprecated

    6. System properties8.0.0-new, 8.1.2-deprecated

    7. VarResolver8.0.0-new, 8.1.2-deprecated

    8. Console Commands8.0.0-new, 8.1.2-deprecated

    9. Logging8.0.0-new, 8.1.2-deprecated

    10. Listeners8.0.0-new, 8.1.2-deprecated

  12. juneau-microservice-jetty8.0.0-new, 8.1.2-deprecated

    1. Overview8.0.0-new, 8.1.2-deprecated

    2. Lifecycle Methods8.0.0-new, 8.1.2-deprecated

    3. Resource Classes8.0.0-new, 8.1.2-deprecated

    4. Predefined Resource Classes8.0.0-new, 8.1.2-deprecated

    5. Config8.0.0-new, 8.1.2-deprecated

    6. Jetty.xml file8.0.0-new, 8.1.2-deprecated

    7. UI Customization8.0.0-new, 8.1.2-deprecated

    8. Extending JettyMicroservice8.0.0-new, 8.1.2-deprecated

  13. my-jetty-microservice8.0.0-new, 8.1.2-deprecated

    1. Installing in Eclipse8.0.0-updated, 8.1.2-deprecated

    2. Running in Eclipse8.0.0-updated, 8.1.2-deprecated

    3. Building and Running from Command-Line8.0.0-updated, 8.1.2-deprecated

  14. my-springboot-microservice8.0.0-new

    1. Installing in Eclipse8.0.0-new

    2. Running in Eclipse8.0.0-new

    3. Building and Running from Command-Line8.0.0-new

  15. juneau-examples-core8.0.0-updated

    1. Installing in Eclipse8.0.0-new

    2. Examples8.0.0-new

  16. juneau-examples-rest8.0.0-updated

    1. RootResources8.0.0-updated, 8.1.0-updated

    2. HelloWorldResource8.0.0-updated

    3. DtoExamples8.0.0-new, 8.1.0-updated

    4. ConfigResource

    5. LogsResource

  17. juneau-examples-rest-jetty8.0.0-new, 8.1.2-deprecated

    1. Installing in Eclipse8.0.0-new,8.1.2-deprecated

    2. Running in Eclipse8.0.0-new,8.1.2-deprecated

    3. Building and Running from Command-Line8.0.0-new,8.1.2-deprecated

  18. juneau-examples-rest-springboot8.0.0-new

    1. Installing in Eclipse8.0.0-new

    2. Running in Eclipse8.0.0-new

    3. Building and Running from Command-Line8.0.0-new

    4. Deploying to Heroku8.0.0-new

  19. juneau-pestore8.2.0-new

    1. Installing in Eclipse8.2.0-new

    2. Running Petstore manually8.2.0-new

    3. Building and Running from Command-Line (Using Dockerfiles)8.2.0-new

    4. About Petstore App
      8.2.0-new

  20. Glossaries8.1.3-new

    1. Language Support8.1.3-new

    2. Annotations8.1.3-new

    3. Configurable Properties8.1.3-new

  21. Security Best-Practices

    1. juneau-marshall

    2. juneau-svl

    3. juneau-rest-server