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
  1. Introduction

    1. Features

    2. Components

  2. juneau-marshall

    1. Serializers

    2. Parsers

    3. SerializerGroups and ParserGroups

    4. ObjectMap and ObjectList

    5. Configurable Properties

    6. Contexts, Builders, Sessions, and PropertyStores

    7. 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. @Bean Annotation

      9. @BeanProperty Annotation

      10. @BeanConstructor Annotation

      11. @BeanIgnore Annotation

      12. @NameProperty Annotation

      13. @ParentProperty Annotation

      14. POJO Builders

      15. URIs

      16. BeanFilters

      17. Interface filters

      18. Stop Classes

      19. Bypass Serialization using Readers and InputStreams

    8. Bean Name and Dictionaries

      1. Bean Subtypes

    9. Virtual Beans

    10. Reading Continuous Streams

    11. Comparison with Jackson

    12. POJO Categories

    13. Best Practices

    14. Additional Information

      1. JSON

      2. XML

      3. HTML

      4. UON

      5. URL-Encoding

  3. juneau-marshall-rdf

  4. juneau-dto

    1. HTML5

    2. Atom

    3. Swagger

  5. juneau-svl

    1. Simple Variable Language

    2. SVL Variables

    3. VarResolvers and VarResolverSessions

    4. Other Notes

  6. juneau-config

  7. juneau-rest-server

    1. Hello World Example

    2. Class Hierarchy

    3. Instantiation

      1. RestServlet

      2. RestServletDefault

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

      14. @RestMethod.matchers()

    7. @Body

      1. Handling Form Posts

      2. Handling Multi-Part Form Posts

    8. @FormData

    9. @Query

    10. @Header

    11. Serializers

    12. Parsers

    13. Properties

    14. Transforms

    15. Guards

    16. Converters

    17. Messages

    18. Encoders

    19. SVL Variables

    20. Configuration Files

    21. Static files

    22. Client Versioning

    23. OPTIONS pages

      1. RestInfoProvider

      2. RestInfoProviderDefault

    24. @HtmlDoc

      1. Widgets

      2. UI Customization

      3. Stylesheets

    25. Default Headers

    26. Logging and Error Handling

    27. HTTP Status Codes

    28. Overloading HTTP Methods

    29. Built-in Parameters

    30. Custom Serializers and Parsers

    31. Using with OSGi

    32. Remoteable Proxies

      1. Remoteable Proxies - Client Side

      2. Remoteable Proxies - Server Side

      3. Remoteable Proxies - @Remoteable Annotation

    33. Using with Spring and Injection frameworks

    34. Using HTTP/2 features

    35. Predefined Label Beans

    36. Other Notes

  8. juneau-rest-server-jaxrs

  9. juneau-rest-client

    1. Interface Proxies Against 3rd-party REST Interfaces

  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 File

      1. Config File API

    5. Resource Classes

    6. Predefined Resource Classes

    7. RestMicroservice

      1. Extending RestMicroservice

  11. juneau-examples-core

  12. juneau-examples-rest

    1. RootResources

    2. HelloWorldResource

    3. MethodExampleResource

    4. UrlEncodedFormResource

    5. RequestEchoResource

    6. AddressBookResource

      1. Classes

      2. Demo

      3. Traversable

      4. Queryable

      5. Introspectable

      6. ClientTest

      7. Browser Tips

    7. SampleRemoteableServlet

    8. TempDirResource

    9. AtomFeedResource

    10. DockerRegistryResource

    11. TumblrParserResource

    12. PhotosResource

    13. JsonSchemaResource

    14. SqlQueryResource

    15. ConfigResource

    16. LogsResource

  13. Security Best-Practices

  14. Release Notes