This is an automated email from the ASF dual-hosted git repository. jamesbognar pushed a commit to branch docs in repository https://gitbox.apache.org/repos/asf/juneau.git
commit 4a555b11b5c78ef20b3d05691787db6e9c3e4c40 Author: james.bognar <[email protected]> AuthorDate: Sun May 3 08:19:12 2026 -0400 Doc updates --- pages/topics/01.04.RestServer.md | 1 - pages/topics/02.17a.LargeDatasetStreaming.md | 10 +++------- pages/topics/10.03.05.Deployment.md | 2 +- pages/topics/10.05.02.PartMarshallers.md | 3 --- pages/topics/10.05.04.DefaultParts.md | 12 +++++------- pages/topics/10.14.StaticFiles.md | 5 ++--- pages/topics/10.15.ClientVersioning.md | 2 -- pages/topics/10.19.LoggingAndDebugging.md | 10 ++-------- pages/topics/10.25.ResponseProcessors.md | 2 -- pages/topics/10.27.SerializingUris.md | 10 +++++----- pages/topics/20.05.JuneauShadedRestServerSpringboot.md | 18 +++++++----------- 11 files changed, 25 insertions(+), 50 deletions(-) diff --git a/pages/topics/01.04.RestServer.md b/pages/topics/01.04.RestServer.md index 23ba1899da..82e45a1f3f 100644 --- a/pages/topics/01.04.RestServer.md +++ b/pages/topics/01.04.RestServer.md @@ -236,7 +236,6 @@ public interface BasicUniversalConfig extends DefaultConfig, DefaultHtmlConfig { // Overridable context classes. contextClass=RestContext.class, - restChildrenClass=RestChildren.class, restOpContextClass=RestOpContext.class, restOperationsClass=RestOperations.class ) diff --git a/pages/topics/02.17a.LargeDatasetStreaming.md b/pages/topics/02.17a.LargeDatasetStreaming.md index a8040f416c..d06da5fec2 100644 --- a/pages/topics/02.17a.LargeDatasetStreaming.md +++ b/pages/topics/02.17a.LargeDatasetStreaming.md @@ -359,13 +359,9 @@ public class JuneauStreamingConfig { @Rest public class EmployeeResource extends BasicSpringRestServlet { - @Inject - private ApplicationContext appCtx; - - @Override - protected BeanContext.Builder createBeanContext(RestContext.Builder rcBuilder) { - return super.createBeanContext(rcBuilder) - .beanStore(new SpringBeanStore(appCtx)); + @RestInject(name="beanStore") + public static BeanStore beanStore(ApplicationContext appCtx) { + return new SpringBeanStore(appCtx); } } ``` diff --git a/pages/topics/10.03.05.Deployment.md b/pages/topics/10.03.05.Deployment.md index 9b8ee6f2f1..971ec2c03e 100644 --- a/pages/topics/10.03.05.Deployment.md +++ b/pages/topics/10.03.05.Deployment.md @@ -17,7 +17,7 @@ The only requirement is that the class be annotated with @Rest and have one of t already Spring Beans: - `public T()` -- `public T(RestContext.Builder)` +- `public T(RestContext)` ::: diff --git a/pages/topics/10.05.02.PartMarshallers.md b/pages/topics/10.05.02.PartMarshallers.md index af35562fa7..748d5ad62b 100644 --- a/pages/topics/10.05.02.PartMarshallers.md +++ b/pages/topics/10.05.02.PartMarshallers.md @@ -26,9 +26,6 @@ This can be done by overriding the part marshallers through the following APIs: <node-0><java-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/Rest.html" target="_blank">Rest</a></java-annotation></node-0> <node-1><java-method-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/Rest.html#partSerializer()" target="_blank">partSerializer</a></java-method-annotation></node-1> <node-1><java-method-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/Rest.html#partParser()" target="_blank">partParser</a></java-method-annotation></node-1> -<node-0><java-class><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html" target="_blank">RestContext.Builder</a></java-class></node-0> -<node-1><java-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#partSerializer(org.apache.juneau.httppart.HttpPartSerializer)" target="_blank">partSerializer(HttpPartSerializer)</a></java-method></node-1> -<node-1><java-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#partParser(org.apache.juneau.httppart.HttpPartParser)" target="_blank">partParser(HttpPartParser)</a></java-method></node-1> </tree> The OpenAPI marshallers themselves also have the ability to support UON notation for individual parts via the schema diff --git a/pages/topics/10.05.04.DefaultParts.md b/pages/topics/10.05.04.DefaultParts.md index 7107dda4eb..7516c1eca4 100644 --- a/pages/topics/10.05.04.DefaultParts.md +++ b/pages/topics/10.05.04.DefaultParts.md @@ -75,11 +75,9 @@ public MyRestServlet extends BasicRestServlet { ``` ::: -Default parts can also be specified programmatically through any of the following methods: +Default parts can also be supplied programmatically via named beans using +<a href="/site/apidocs/org/apache/juneau/rest/annotation/RestInject.html" target="_blank">@RestInject</a> +(for example `name="defaultRequestHeaders"`, `name="defaultResponseHeaders"`, `name="defaultRequestAttributes"`, +`name="defaultRequestFormData"`, `name="defaultRequestQueryData"`). -<tree> -<node-0><java-class><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html" target="_blank">RestContext.Builder</a></java-class></node-0> -<node-1><javac-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#defaultAccept(java.lang.String)" target="_blank">defaultAccept(String)</a></javac-method> <javac-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#defaultCharset(java.nio.charset.Charset)" target="_blank">defaultCharset(Charset)</a></javac-method> <javac-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#defaultContentType(java.lang.String)" [...] -<node-0><java-class><a href="/site/apidocs/org/apache/juneau/rest/RestOpContext.Builder.html" target="_blank">RestOpContext.Builder</a></java-class></node-0> -<node-1><javac-method><a href="/site/apidocs/org/apache/juneau/rest/RestOpContext.Builder.html#defaultRequestAttributes()" target="_blank">defaultRequestAttributes()</a></javac-method> <javac-method><a href="/site/apidocs/org/apache/juneau/rest/RestOpContext.Builder.html#defaultRequestAttributes(org.apache.juneau.rest.httppart.NamedAttribute...)" target="_blank">defaultRequestAttributes(NamedAttribute...)</a></javac-method> <javac-method><a href="/site/apidocs/org/apache/juneau/rest/Rest [...] -</tree> \ No newline at end of file +In 9.5+, prefer annotation attributes and `@RestInject`-named beans over the legacy builder APIs. \ No newline at end of file diff --git a/pages/topics/10.14.StaticFiles.md b/pages/topics/10.14.StaticFiles.md index b79b17880f..45b5f66d0e 100644 --- a/pages/topics/10.14.StaticFiles.md +++ b/pages/topics/10.14.StaticFiles.md @@ -41,7 +41,6 @@ StaticFiles Static files can be configured programmatically through the following APIs: <tree> -<node-0><java-class><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html" target="_blank">RestContext.Builder</a></java-class></node-0> -<node-1><java-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#staticFiles(org.apache.juneau.rest.staticfile.StaticFiles)" target="_blank">staticFiles(StaticFiles)</a></java-method></node-1> -<node-1><java-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#staticFiles()" target="_blank">staticFiles()</a></java-method></node-1> +<node-0><java-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/RestInject.html" target="_blank">RestInject</a></java-annotation></node-0> +<node-1><java-method-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/RestInject.html#name()" target="_blank">name="staticFiles"</a></java-method-annotation></node-1> </tree> \ No newline at end of file diff --git a/pages/topics/10.15.ClientVersioning.md b/pages/topics/10.15.ClientVersioning.md index a05c7ee078..4fca51be59 100644 --- a/pages/topics/10.15.ClientVersioning.md +++ b/pages/topics/10.15.ClientVersioning.md @@ -13,8 +13,6 @@ The APIs involved with defining client version headers are: <node-1><java-method-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/Rest.html#clientVersionHeader()" target="_blank">clientVersionHeader</a></java-method-annotation></node-1> <node-0><java-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/RestOp.html" target="_blank">RestOp</a></java-annotation></node-0> <node-1><java-method-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/RestOp.html#clientVersion()" target="_blank">clientVersion</a></java-method-annotation></node-1> -<node-0><java-class><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html" target="_blank">RestContext.Builder</a></java-class></node-0> -<node-1><java-method-annotation><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#clientVersionHeader(java.lang.String)" target="_blank">clientVersionHeader(String)</a></java-method-annotation></node-1> </tree> :::tip Example diff --git a/pages/topics/10.19.LoggingAndDebugging.md b/pages/topics/10.19.LoggingAndDebugging.md index 42254f219c..4e336c4bc3 100644 --- a/pages/topics/10.19.LoggingAndDebugging.md +++ b/pages/topics/10.19.LoggingAndDebugging.md @@ -64,8 +64,6 @@ Debugging can also be enabled programmatically with the use of the following API <tree> <node-0><java-class><a href="/site/apidocs/org/apache/juneau/rest/debug/DebugEnablement.html" target="_blank">DebugEnablement</a></java-class></node-0> <node-1><javac-class><a href="/site/apidocs/org/apache/juneau/rest/debug/BasicDebugEnablement.html" target="_blank">BasicDebugEnablement</a></javac-class></node-1> -<node-0><java-class><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html" target="_blank">RestContext.Builder</a></java-class></node-0> -<node-1><javac-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#debugEnablement()" target="_blank">debugEnablement()</a></javac-method> <javac-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#debugEnablement(java.lang.Class)" target="_blank">debugEnablement(Class)</a></javac-method> <javac-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#debugEnablement(org.apache.juneau.rest.debug.DebugEnablement)" ta [...] </tree> HTTP calls can be logged with the following levels of granularity: @@ -135,8 +133,6 @@ It can be changed through any of the following: <tree> <node-0><java-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/Rest.html" target="_blank">Rest</a></java-annotation></node-0> <node-1><javac-method-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/Rest.html#callLogger()" target="_blank">callLogger()</a></javac-method-annotation></node-1> -<node-0><java-class><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html" target="_blank">RestContext.Builder</a></java-class></node-0> -<node-1><javac-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#callLogger()" target="_blank">callLogger()</a></javac-method> <javac-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#callLogger(java.lang.Class)" target="_blank">callLogger(Class)</a></javac-method> <javac-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#callLogger(org.apache.juneau.rest.logger.CallLogger)" target="_blank">callLogger(Call [...] </tree> The call logger uses logging rules to map requests to logging detail levels. @@ -180,10 +176,8 @@ Stack trace hashes are controlled by the <a href="/site/apidocs/org/apache/junea which is configured via the following: <tree> -<node-0><java-class><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html" target="_blank">RestContext.Builder</a></java-class></node-0> -<node-1><java-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#thrownStore()" target="_blank">thrownStore()</a></java-method></node-1> -<node-1><java-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#thrownStore(java.lang.Class)" target="_blank">thrownStore(Class)</a></java-method></node-1> -<node-1><java-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#thrownStore(org.apache.juneau.rest.stats.ThrownStore)" target="_blank">thrownStore(ThrownStore)</a></java-method></node-1> +<node-0><java-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/RestInject.html" target="_blank">RestInject</a></java-annotation></node-0> +<node-1><java-method-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/RestInject.html#name()" target="_blank">name="thrownStore"</a></java-method-annotation></node-1> </tree> :::note diff --git a/pages/topics/10.25.ResponseProcessors.md b/pages/topics/10.25.ResponseProcessors.md index a426ae5ace..b5fb332514 100644 --- a/pages/topics/10.25.ResponseProcessors.md +++ b/pages/topics/10.25.ResponseProcessors.md @@ -24,8 +24,6 @@ Custom response processors can be associated with REST resources via the followi <tree> <node-0><java-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/Rest.html" target="_blank">Rest</a></java-annotation></node-0> <node-1><javac-method-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/Rest.html#responseProcessors()" target="_blank">responseProcessors</a></javac-method-annotation></node-1> -<node-0><java-class><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html" target="_blank">RestContext.Builder</a></java-class></node-0> -<node-1><javac-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#responseProcessors()" target="_blank">responseProcessors()</a></javac-method></node-1> </tree> Response processors can be used to process POJOs that cannot normally be handled through Juneau serializers, or because diff --git a/pages/topics/10.27.SerializingUris.md b/pages/topics/10.27.SerializingUris.md index 16cefea462..af9900dee4 100644 --- a/pages/topics/10.27.SerializingUris.md +++ b/pages/topics/10.27.SerializingUris.md @@ -68,11 +68,11 @@ When requested as JSON, it produces the following result: URI resolution is controlled by the following settings: <tree> -<node-0><java-class><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html" target="_blank">RestContext.Builder</a></java-class></node-0> -<node-1><java-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#uriAuthority(java.lang.String)" target="_blank">uriAuthority(String)</a></java-method></node-1> -<node-1><java-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#uriContext(java.lang.String)" target="_blank">uriContext(String)</a></java-method></node-1> -<node-1><java-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#uriRelativity(org.apache.juneau.UriRelativity)" target="_blank">uriRelativity(UriRelativity)</a></java-method></node-1> -<node-1><java-method><a href="/site/apidocs/org/apache/juneau/rest/RestContext.Builder.html#uriResolution(org.apache.juneau.UriResolution)" target="_blank">uriResolution(UriResolution)</a></java-method></node-1> +<node-0><java-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/Rest.html" target="_blank">Rest</a></java-annotation></node-0> +<node-1><java-method-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/Rest.html#uriAuthority()" target="_blank">uriAuthority</a></java-method-annotation></node-1> +<node-1><java-method-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/Rest.html#uriContext()" target="_blank">uriContext</a></java-method-annotation></node-1> +<node-1><java-method-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/Rest.html#uriRelativity()" target="_blank">uriRelativity</a></java-method-annotation></node-1> +<node-1><java-method-annotation><a href="/site/apidocs/org/apache/juneau/rest/annotation/Rest.html#uriResolution()" target="_blank">uriResolution</a></java-method-annotation></node-1> </tree> URIs are resolved by both regular and part serializers. diff --git a/pages/topics/20.05.JuneauShadedRestServerSpringboot.md b/pages/topics/20.05.JuneauShadedRestServerSpringboot.md index 83058f2312..3aa003a080 100644 --- a/pages/topics/20.05.JuneauShadedRestServerSpringboot.md +++ b/pages/topics/20.05.JuneauShadedRestServerSpringboot.md @@ -123,18 +123,14 @@ public class PetResource extends SpringRestServlet { ```java import org.springframework.context.annotation.Configuration; -import org.apache.juneau.rest.springboot.JuneauRestInitializer; +import org.apache.juneau.rest.annotation.Rest; -@Configuration -public class JuneauConfig implements JuneauRestInitializer { - - @Override - public void init(SpringRestServletBuilder builder) { - builder - .defaultAccept("application/json") - .defaultContentType("application/json") - .maxInput("10M"); - } +@Rest( + defaultAccept="application/json", + defaultContentType="application/json", + maxInput="10M" +) +public class MyResource extends SpringRestServlet { } ```
