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 - 7.2.0       new   updated
  1. Introduction

    1. Features

    2. Components

  2. juneau-marshall

    1. Serializers

    2. Parsers

    3. Marshalls

    4. HTTP Part Serializers

    5. HTTP Part Parsers

    6. Configurable Properties

      1. Common Serializer Properties

      2. Common Serializer Properties

      3. Common Parser Properties

    7. ObjectMap and ObjectList

    8. SerializerGroups and ParserGroups

    9. Contexts, Builders, Sessions, and PropertyStores

    10. Transforms

      1. PojoSwaps

      2. Per-media-type PojoSwaps

      3. One-way PojoSwaps

      4. @Swap Annotation

      5. Templated Swaps

      6. Swap Methods

      7. Surrogate Classes

      8. @BeanProperty Annotation

      9. @BeanProperty Annotation

      10. @BeanConstructor Annotation

      11. @BeanIgnore Annotation

      12. @NameProperty Annotation

      13. @ParentProperty Annotation

      14. POJO Builders

      15. BeanFilter Class

      16. Interface Filters

      17. Stop Classes

      18. Bypass Serialization using Readers and InputStreams

    11. Bean Names and Dictionaries

      1. Bean Subtypes

    12. Virtual Beans

    13. Non-Tree Models and Recursion Detection

    14. Parsing into Generic Models

    15. Reading Continuous Streams

    16. URIs

    17. Comparison with Jackson

    18. POJO Categories

    19. JSON Details

      1. JSON Methodology

      2. JSON Serializers

      3. Simplified JSON

      4. JSON Parsers

      5. @Json Annotation

      6. JSON-Schema Support

    20. 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

      8. XML-Schema Support

    21. 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

    22. UON Details

      1. UON Methodology

      2. UON Serializers

      3. UON Parsers

    23. URL-Encoding Details

      1. URL-Encoding Methodology

      2. URL-Encoding Serializers

      3. URL-Encoding Parsers

      4. @UrlEncoding Annotation

    24. MessagePack Details

      1. MessagePack Serializers

      2. MessagePack Parsers

    25. OpenAPI Details

      1. OpenAPI Methodology

      2. OpenAPI Serializers

      3. OpenAPI Parsers

    26. 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-svl

    1. Simple Variable Language

    2. SVL Variables

    3. VarResolvers and VarResolverSessions

    4. Other Notes

  6. juneau-config

    1. Overview

      1. Syntax Rules

    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. Config Stores

      1. ConfigMemoryStore

      2. ConfigFileStore

      3. Custom ConfigStores

      4. ConfigStore Listeners

    12. Read-only Configs

    13. Closing Configs

  7. juneau-rest-server

    1. Hello World Example

    2. Class Hierarchy

    3. Instantiation

      1. RestServlet

      2. BasicRestServlet

      3. Children

      4. Router Pages

      5. Resource Resolvers

      6. Lifecycle Hooks

    4. @RestResource

      1. Annotation Inheritance

    5. RestContext

    6. @RestMethod

      1. Java Method Parameters

      2. RestRequest

      3. RestResponse

      4. RequestBody

      5. RequestHeaders

      6. RequestQuery

      7. RequestFormData

      8. @RestMethod(path)

      9. RequestPathMatch

      10. Method Return Types

      11. ReaderResource

      12. StreamResource

      13. @RestMethod(matchers)

      14. Predefined Responses

      15. Predefined Exceptions

      16. Predefined Helper Beans

    7. restRPC

    8. OpenAPI Schema Part Parsing

    9. OpenAPI Schema Part Serializing

    10. HTTP-Part Annotations

      1. @Body

      2. @FormData

      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 Posts

    13. Serializers

    14. Parsers

    15. Properties

    16. Transforms

    17. URIs

    18. Guards

    19. Converters

    20. Messages

    21. Encoders

    22. SVL Variables

    23. Configuration Files

    24. Static files

    25. Client Versioning

    26. RestInfoProvider

      1. BasicRestInfoProvider

    27. Swagger

      1. BasicRestServlet

      2. Basic Swagger Info

      3. Tags

      4. Operations

      5. Parameters

      6. Parameter Examples

      7. Responses

      8. Response Examples

      9. Models

      10. SwaggerUI.css

    28. @HtmlDoc

      1. Widgets

      2. Predefined Widgets

      3. UI Customization

      4. Stylesheets

    29. Default Headers

    30. Logging and Error Handling

    31. HTTP Status Codes

    32. Overloading HTTP Methods

    33. Built-in Parameters

    34. Custom Serializers and Parsers

    35. Using with OSGi

    36. Serverless Unit Testing

    37. Using with Spring and Injection frameworks

    38. Using HTTP/2 features

    39. Other Notes

  8. juneau-rest-server-jaxrs

    1. Juneau JAX-RS Provider

  9. juneau-rest-client

    1. REST Proxies

      1. @RemoteResource

      2. @RemoteMethod

      3. @Body

      4. @FormData

      5. @Query

      6. @Header

      7. @Path

      8. @Request

      9. @Response

    2. SSL Support

    3. Authentication

      1. BASIC Authentication

      2. FORM-based Authentication

      3. OIDC Authentication

    4. Using Response Patterns

    5. Piping Response Output

    6. Debugging

    7. Logging

    8. Interceptors

    9. Serverless Unit Testing

    10. Other Useful Methods

  10. juneau-microservice-server

    1. Microservice Introduction

    2. Getting Started

      1. Installing in Eclipse

      2. Running in Eclipse

      3. Building and Running from Command-Line

    3. Manifest File

      1. Manifest API

    4. Config

      1. Config File API

    5. Resource Classes

    6. Predefined Resource Classes

    7. RestMicroservice

      1. Extending RestMicroservice

    8. UI Customization

  11. juneau-examples-core

  12. juneau-examples-rest

    1. RootResources

    2. HelloWorldResource

    3. SystemPropertiesResource

    4. MethodExampleResource

    5. UrlEncodedFormResource

    6. RequestEchoResource

    7. PetStoreResource

    8. AddressBookResource

    9. SampleRemoteInterfaceServlet

    10. TempDirResource

    11. AtomFeedResource

    12. DockerRegistryResource

    13. PhotosResource

    14. JsonSchemaResource

    15. SqlQueryResource

    16. ConfigResource

    17. LogsResource

  13. Security Best-Practices

    1. juneau-marshall

    2. juneau-svl

    3. juneau-rest-server