This is an automated email from the ASF dual-hosted git repository.
jamesbognar pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/juneau.git
The following commit(s) were added to refs/heads/master by this push:
new fe2d32ab8 Javadocs
fe2d32ab8 is described below
commit fe2d32ab86d602f42af564a492b89b3e00ea24b2
Author: JamesBognar <[email protected]>
AuthorDate: Sun Jun 12 18:13:43 2022 -0400
Javadocs
---
.../java/org/apache/juneau/dto/LinkString.java | 1 +
.../java/org/apache/juneau/http/HttpParts.java | 2 +-
.../juneau/http/header/SerializedHeader.java | 13 +-
.../Topics/02.juneau-marshall/24.jm.HttpParts.html | 24 +-
.../01.jm.org.apache.juneau.http.html} | 13 +-
.../02.jm.org.apache.juneau.http.annotation.html | 46 +++
.../03.jm.org.apache.juneau.http.header.html | 126 ++++++++
.../04.jm.org.apache.juneau.http.part.html} | 21 +-
.../05.jm.org.apache.juneau.http.entity.html} | 16 +-
.../06.jm.org.apache.juneau.http.resource.html} | 14 +-
.../07.jm.org.apache.juneau.http.response.html | 101 ++++++
.../08.jm.org.apache.juneau.http.remote.html} | 15 +-
juneau-doc/src/main/javadoc/overview.html | 337 ++++++++++++++++++++-
juneau-doc/src/main/javadoc/resources/docs.txt | 8 +
14 files changed, 701 insertions(+), 36 deletions(-)
diff --git
a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/LinkString.java
b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/LinkString.java
index ddf077ce8..e043d514d 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/LinkString.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/LinkString.java
@@ -25,6 +25,7 @@ import org.apache.juneau.html.*;
import org.apache.juneau.html.annotation.*;
import org.apache.juneau.httppart.*;
import org.apache.juneau.oapi.*;
+import org.apache.juneau.objecttools.*;
import org.apache.juneau.serializer.*;
/**
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HttpParts.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HttpParts.java
index 59115444c..b557d7ca0 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HttpParts.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HttpParts.java
@@ -29,7 +29,7 @@ import org.apache.juneau.httppart.*;
import org.apache.juneau.reflect.*;
/**
- * Standard predefined HTTP headers.
+ * Standard predefined HTTP parts.
*
* <ul class='seealso'>
* <li class='link'>{@doc jm.HttpParts}
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/header/SerializedHeader.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/header/SerializedHeader.java
index c6f403a2d..77b9ad30e 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/header/SerializedHeader.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/header/SerializedHeader.java
@@ -17,23 +17,12 @@ import static org.apache.juneau.internal.StringUtils.*;
import java.util.function.*;
-import org.apache.http.*;
import org.apache.juneau.httppart.*;
import org.apache.juneau.oapi.*;
import org.apache.juneau.serializer.*;
-import org.apache.juneau.urlencoding.*;
/**
- * Subclass of {@link NameValuePair} for serializing POJOs as URL-encoded form
post entries using the
- * {@link UrlEncodingSerializer class}.
- *
- * <h5 class='section'>Example:</h5>
- * <p class='bjava'>
- * NameValuePairs <jv>params</jv> = <jk>new</jk> NameValuePairs()
- * .append(<jk>new</jk> SerializedNameValuePair(<js>"myPojo"</js>,
<jv>pojo</jv>, UrlEncodingSerializer.<jsf>DEFAULT_SIMPLE</jsf>))
- * .append(<jk>new</jk>
BasicNameValuePair(<js>"someOtherParam"</js>, <js>"foobar"</js>));
- * <jv>request</jv>.setEntity(<jk>new</jk>
UrlEncodedFormEntity(<jv>params</jv>));
- * </p>
+ * TODO
*
* <ul class='seealso'>
* <li class='link'>{@doc jm.HttpParts}
diff --git a/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
index 0b03717c0..965fc17e4 100644
--- a/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
+++ b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
@@ -13,10 +13,30 @@
***************************************************************************************************************************/
-->
-{title:'HTTP Parts', created:'9.0.0', flags:'TODO'}
+{title:'HTTP Parts', created:'9.0.0'}
<div class='topic'>
<p>
- TODO
+ The {@link oaj.http} package contains a slew of useful
extensions to the Apache HttpComponents libraries
+ and define APIs used extensively in the REST server and client
APIs.
</p>
+ <ul class='javatree'>
+ <li class='jp'>{@link oaj.http} - Utility classes used for HTTP
parts/headers/entities.
+ <li class='jp'>{@link oaj.http.annotation} - Swagger-based
annotations used on both server-side APIs and client-side proxy interfaces.
+ <li class='jp'>{@link oaj.http.entity} - HTTP entity classes.
+ <li class='jp'>{@link oaj.http.header} - HTTP header classes.
+ <li class='jp'>{@link oaj.http.part} - HTTP
query/form-data/path classes.
+ <li class='jp'>{@link oaj.http.remote} - Remote proxy interface
API
+ <li class='jp'>{@link oaj.http.resource} - HTTP resource
classes.
+ <li class='jp'>{@link oaj.http.response} - HTTP response
classes.
+ </ul>
+
+ <p>
+ These APIs extend from the Apache HttpComponents libraries and
can be used with libraries based on it such
+ as Apache HttpClient. The REST Client API described later is
built on top of Apache HttpClient and many
+ of the classes defined in this package make up integral
components of that API. Likewise, the APIs
+ defined here are also used in the REST Server APIs also
described later.
+ </p>
+
+
</div>
\ No newline at end of file
diff --git a/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/01.jm.org.apache.juneau.http.html
similarity index 84%
copy from juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
copy to
juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/01.jm.org.apache.juneau.http.html
index 0b03717c0..b1652ab10 100644
--- a/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
+++
b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/01.jm.org.apache.juneau.http.html
@@ -13,10 +13,15 @@
***************************************************************************************************************************/
-->
-{title:'HTTP Parts', created:'9.0.0', flags:'TODO'}
+{title:'org.apache.juneau.http', created:'9.0.0', flags:'todo'}
<div class='topic'>
- <p>
- TODO
- </p>
+
+BasicStatusLine.java
+HttpEntities.java
+HttpHeaders.java
+HttpMethod.java
+HttpParts.java
+HttpResources.java
+HttpResponses.java
</div>
\ No newline at end of file
diff --git
a/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/02.jm.org.apache.juneau.http.annotation.html
b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/02.jm.org.apache.juneau.http.annotation.html
new file mode 100644
index 000000000..065253487
--- /dev/null
+++
b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/02.jm.org.apache.juneau.http.annotation.html
@@ -0,0 +1,46 @@
+<!--
+/***************************************************************************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+
***************************************************************************************************************************/
+ -->
+
+{title:'org.apache.juneau.http.annotation', created:'9.0.0', flags:'todo'}
+
+<div class='topic'>
+ <p>
+ The {@link oaj.http.annotation} package contains annotations
for defining both server and client side
+ APIs. The server-side APIs also use it for producing
auto-generated Swagger documentation through
+ the REST API itself.
+ </p>
+ <ul class='javatreec'>
+ <li class='ja'>{@link oaj.http.annotation.Body}
+ <li class='ja'>{@link oaj.http.annotation.Contact}
+ <li class='ja'>{@link oaj.http.annotation.ExternalDocs}
+ <li class='ja'>{@link oaj.http.annotation.FormData}
+ <li class='ja'>{@link oaj.http.annotation.HasFormData}
+ <li class='ja'>{@link oaj.http.annotation.HasQuery}
+ <li class='ja'>{@link oaj.http.annotation.Header}
+ <li class='ja'>{@link oaj.http.annotation.Items}
+ <li class='ja'>{@link oaj.http.annotation.License}
+ <li class='ja'>{@link oaj.http.annotation.Path}
+ <li class='ja'>{@link oaj.http.annotation.Query}
+ <li class='ja'>{@link oaj.http.annotation.Request}
+ <li class='ja'>{@link oaj.http.annotation.Response}
+ <li class='ja'>{@link oaj.http.annotation.Schema}
+ <li class='ja'>{@link oaj.http.annotation.StatusCode}
+ <li class='ja'>{@link oaj.http.annotation.SubItems}
+ <li class='ja'>{@link oaj.http.annotation.Tag}
+ </ul>
+ <p>
+ TODO - Examples
+ </p>
+</div>
\ No newline at end of file
diff --git
a/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/03.jm.org.apache.juneau.http.header.html
b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/03.jm.org.apache.juneau.http.header.html
new file mode 100644
index 000000000..d4856192d
--- /dev/null
+++
b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/03.jm.org.apache.juneau.http.header.html
@@ -0,0 +1,126 @@
+<!--
+/***************************************************************************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+
***************************************************************************************************************************/
+ -->
+
+{title:'org.apache.juneau.http.header', created:'9.0.0', flags:'todo'}
+
+<div class='topic'>
+ <p>
+ The {@link oaj.http.header} package contains implementations of
<c>org.apache.http.Header</c> for all common HTTP
+ headers.
+ </p>
+ <ul class='javatreec'>
+ <li class='jc'>{@link oaj.http.header.Accept}
+ <li class='jc'>{@link oaj.http.header.AcceptCharset}
+ <li class='jc'>{@link oaj.http.header.AcceptEncoding}
+ <li class='jc'>{@link oaj.http.header.AcceptLanguage}
+ <li class='jc'>{@link oaj.http.header.AcceptRanges}
+ <li class='jc'>{@link oaj.http.header.Age}
+ <li class='jc'>{@link oaj.http.header.Allow}
+ <li class='jc'>{@link oaj.http.header.Authorization}
+ <li class='jc'>{@link oaj.http.header.CacheControl}
+ <li class='jc'>{@link oaj.http.header.ClientVersion}
+ <li class='jc'>{@link oaj.http.header.Connection}
+ <li class='jc'>{@link oaj.http.header.ContentDisposition}
+ <li class='jc'>{@link oaj.http.header.ContentEncoding}
+ <li class='jc'>{@link oaj.http.header.ContentLanguage}
+ <li class='jc'>{@link oaj.http.header.ContentLength}
+ <li class='jc'>{@link oaj.http.header.ContentLocation}
+ <li class='jc'>{@link oaj.http.header.ContentRange}
+ <li class='jc'>{@link oaj.http.header.ContentType}
+ <li class='jc'>{@link oaj.http.header.Date}
+ <li class='jc'>{@link oaj.http.header.Debug}
+ <li class='jc'>{@link oaj.http.header.ETag}
+ <li class='jc'>{@link oaj.http.header.Expect}
+ <li class='jc'>{@link oaj.http.header.Expires}
+ <li class='jc'>{@link oaj.http.header.Forwarded}
+ <li class='jc'>{@link oaj.http.header.From}
+ <li class='jc'>{@link oaj.http.header.Host}
+ <li class='jc'>{@link oaj.http.header.IfMatch}
+ <li class='jc'>{@link oaj.http.header.IfModifiedSince}
+ <li class='jc'>{@link oaj.http.header.IfNoneMatch}
+ <li class='jc'>{@link oaj.http.header.IfRange}
+ <li class='jc'>{@link oaj.http.header.IfUnmodifiedSince}
+ <li class='jc'>{@link oaj.http.header.LastModified}
+ <li class='jc'>{@link oaj.http.header.Location}
+ <li class='jc'>{@link oaj.http.header.MaxForwards}
+ <li class='jc'>{@link oaj.http.header.MediaRange}
+ <li class='jc'>{@link oaj.http.header.MediaRanges}
+ <li class='jc'>{@link oaj.http.header.MediaType}
+ <li class='jc'>{@link oaj.http.header.NoTrace}
+ <li class='jc'>{@link oaj.http.header.Origin}
+ <li class='jc'>{@link oaj.http.header.Pragma}
+ <li class='jc'>{@link oaj.http.header.ProxyAuthenticate}
+ <li class='jc'>{@link oaj.http.header.ProxyAuthorization}
+ <li class='jc'>{@link oaj.http.header.Range}
+ <li class='jc'>{@link oaj.http.header.Referer}
+ <li class='jc'>{@link oaj.http.header.RetryAfter}
+ <li class='jc'>{@link oaj.http.header.Server}
+ <li class='jc'>{@link oaj.http.header.TE}
+ <li class='jc'>{@link oaj.http.header.Thrown}
+ <li class='jc'>{@link oaj.http.header.Trailer}
+ <li class='jc'>{@link oaj.http.header.TransferEncoding}
+ <li class='jc'>{@link oaj.http.header.Upgrade}
+ <li class='jc'>{@link oaj.http.header.UserAgent}
+ <li class='jc'>{@link oaj.http.header.Vary}
+ <li class='jc'>{@link oaj.http.header.Via}
+ <li class='jc'>{@link oaj.http.header.Warning}
+ <li class='jc'>{@link oaj.http.header.WwwAuthenticate}
+ </ul>
+ <p>
+ TODO - Examples
+ </p>
+ <p>
+ These headers extend from the following classes that provide
data-type specific functionality for each category of header.
+ </p>
+ <ul class='javatree'>
+ <li class='jc'>{@link oaj.http.header.BasicHeader}
+ <ul>
+ <li class='jc'>{@link
oaj.http.header.BasicBooleanHeader}
+ <li class='jc'>{@link oaj.http.header.BasicCsvHeader}
+ <li class='jc'>{@link oaj.http.header.BasicDateHeader}
+ <li class='jc'>{@link
oaj.http.header.BasicEntityTagHeader}
+ <li class='jc'>{@link
oaj.http.header.BasicEntityTagsHeader}
+ <li class='jc'>{@link
oaj.http.header.BasicIntegerHeader}
+ <li class='jc'>{@link oaj.http.header.BasicLongHeader}
+ <li class='jc'>{@link
oaj.http.header.BasicMediaRangesHeader}
+ <li class='jc'>{@link
oaj.http.header.BasicMediaTypeHeader}
+ <li class='jc'>{@link oaj.http.header.BasicStringHeader}
+ <li class='jc'>{@link
oaj.http.header.BasicStringRangesHeader}
+ <li class='jc'>{@link oaj.http.header.BasicUriHeader}
+ </ul>
+ </ul>
+ <p>
+ These subclasses provide various convenience methods to allow
for easy fluent-style coding.
+ </p>
+ <h5 class='figure'>Examples</h5>
+ <p class='bjava'>
+ | <jc>// Validates the response body content is not expired.</jc>
+ | <jv>restClient</jv>
+ | .get(<jsf>URL</jsf>)
+ | .run()
+ |
.getHeader(<js>"Expires"</js>).asDateHeader().assertZonedDateTime().isLessThan(<jk>new</jk>
Date());
+ </p>
+
+ <h5 class='topic'>HeaderList</h5>
+ <p>
+ The {@link HeaderList}
+
+
+
+HeaderList.java
+BasicHeaderIterator.java
+SerializedHeader.java
+
+</div>
\ No newline at end of file
diff --git a/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/04.jm.org.apache.juneau.http.part.html
similarity index 74%
copy from juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
copy to
juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/04.jm.org.apache.juneau.http.part.html
index 0b03717c0..f847ff082 100644
--- a/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
+++
b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/04.jm.org.apache.juneau.http.part.html
@@ -13,10 +13,23 @@
***************************************************************************************************************************/
-->
-{title:'HTTP Parts', created:'9.0.0', flags:'TODO'}
+{title:'org.apache.juneau.http.part', created:'9.0.0', flags:'todo'}
<div class='topic'>
- <p>
- TODO
- </p>
+
+BasicBooleanPart.java
+BasicCsvArrayPart.java
+BasicDatePart.java
+BasicIntegerPart.java
+BasicLongPart.java
+BasicPart.java
+BasicPartIterator.java
+BasicStringPart.java
+BasicUriPart.java
+NameValuePairable.java
+package-info.java
+PartBeanMeta.java
+PartIterator.java
+PartList.java
+SerializedPart.java
</div>
\ No newline at end of file
diff --git a/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/05.jm.org.apache.juneau.http.entity.html
similarity index 78%
copy from juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
copy to
juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/05.jm.org.apache.juneau.http.entity.html
index 0b03717c0..eb00c3c5c 100644
--- a/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
+++
b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/05.jm.org.apache.juneau.http.entity.html
@@ -13,10 +13,18 @@
***************************************************************************************************************************/
-->
-{title:'HTTP Parts', created:'9.0.0', flags:'TODO'}
+{title:'org.apache.juneau.http.entity', created:'9.0.0', flags:'todo'}
<div class='topic'>
- <p>
- TODO
- </p>
+BasicHttpEntity.java
+ByteArrayEntity.java
+FileEntity.java
+HttpEntityBuilder.java
+InputStreamEntity.java
+package-info.java
+ReaderEntity.java
+SerializedEntity.java
+SerializedEntityBuilder.java
+StringEntity.java
+
</div>
\ No newline at end of file
diff --git a/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/06.jm.org.apache.juneau.http.resource.html
similarity index 80%
copy from juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
copy to
juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/06.jm.org.apache.juneau.http.resource.html
index 0b03717c0..166f51cdb 100644
--- a/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
+++
b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/06.jm.org.apache.juneau.http.resource.html
@@ -13,10 +13,16 @@
***************************************************************************************************************************/
-->
-{title:'HTTP Parts', created:'9.0.0', flags:'TODO'}
+{title:'org.apache.juneau.http.resource', created:'9.0.0', flags:'todo'}
<div class='topic'>
- <p>
- TODO
- </p>
+BasicResource.java
+ByteArrayResource.java
+FileResource.java
+HttpResource.java
+HttpResourceBuilder.java
+InputStreamResource.java
+package-info.java
+ReaderResource.java
+StringResource.java
</div>
\ No newline at end of file
diff --git
a/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/07.jm.org.apache.juneau.http.response.html
b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/07.jm.org.apache.juneau.http.response.html
new file mode 100644
index 000000000..3ae5fccc3
--- /dev/null
+++
b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/07.jm.org.apache.juneau.http.response.html
@@ -0,0 +1,101 @@
+<!--
+/***************************************************************************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+
***************************************************************************************************************************/
+ -->
+
+{title:'org.apache.juneau.http.response', created:'9.0.0'}
+
+<div class='topic'>
+ <p>
+ The {@link oaj.http.response} package contains predefined
<c>org.apache.http.HttpResponse</c> implementations for most standard HTTP
+ responses.
+ </p>
+ <ul class='javatreec'>
+ <li class='jc'>{@link oaj.http.response.Accepted}
+ <li class='jc'>{@link oaj.http.response.AlreadyReported}
+ <li class='jc'>{@link oaj.http.response.BadRequest}
+ <li class='jc'>{@link oaj.http.response.Conflict}
+ <li class='jc'>{@link oaj.http.response.Continue}
+ <li class='jc'>{@link oaj.http.response.Created}
+ <li class='jc'>{@link oaj.http.response.EarlyHints}
+ <li class='jc'>{@link oaj.http.response.ExpectationFailed}
+ <li class='jc'>{@link oaj.http.response.FailedDependency}
+ <li class='jc'>{@link oaj.http.response.Forbidden}
+ <li class='jc'>{@link oaj.http.response.Found}
+ <li class='jc'>{@link oaj.http.response.Gone}
+ <li class='jc'>{@link oaj.http.response.HttpVersionNotSupported}
+ <li class='jc'>{@link oaj.http.response.IMUsed}
+ <li class='jc'>{@link oaj.http.response.InsufficientStorage}
+ <li class='jc'>{@link oaj.http.response.InternalServerError}
+ <li class='jc'>{@link oaj.http.response.LengthRequired}
+ <li class='jc'>{@link oaj.http.response.Locked}
+ <li class='jc'>{@link oaj.http.response.LoopDetected}
+ <li class='jc'>{@link oaj.http.response.MethodNotAllowed}
+ <li class='jc'>{@link oaj.http.response.MisdirectedRequest}
+ <li class='jc'>{@link oaj.http.response.MovedPermanently}
+ <li class='jc'>{@link oaj.http.response.MultipleChoices}
+ <li class='jc'>{@link oaj.http.response.MultiStatus}
+ <li class='jc'>{@link
oaj.http.response.NetworkAuthenticationRequired}
+ <li class='jc'>{@link oaj.http.response.NoContent}
+ <li class='jc'>{@link
oaj.http.response.NonAuthoritiveInformation}
+ <li class='jc'>{@link oaj.http.response.NotAcceptable}
+ <li class='jc'>{@link oaj.http.response.NotExtended}
+ <li class='jc'>{@link oaj.http.response.NotFound}
+ <li class='jc'>{@link oaj.http.response.NotImplemented}
+ <li class='jc'>{@link oaj.http.response.NotModified}
+ <li class='jc'>{@link oaj.http.response.Ok}
+ <li class='jc'>{@link oaj.http.response.PartialContent}
+ <li class='jc'>{@link oaj.http.response.PayloadTooLarge}
+ <li class='jc'>{@link oaj.http.response.PermanentRedirect}
+ <li class='jc'>{@link oaj.http.response.PreconditionFailed}
+ <li class='jc'>{@link oaj.http.response.PreconditionRequired}
+ <li class='jc'>{@link oaj.http.response.Processing}
+ <li class='jc'>{@link oaj.http.response.RangeNotSatisfiable}
+ <li class='jc'>{@link
oaj.http.response.RequestHeaderFieldsTooLarge}
+ <li class='jc'>{@link oaj.http.response.ResetContent}
+ <li class='jc'>{@link oaj.http.response.SeeOther}
+ <li class='jc'>{@link oaj.http.response.ServiceUnavailable}
+ <li class='jc'>{@link oaj.http.response.SwitchingProtocols}
+ <li class='jc'>{@link oaj.http.response.TemporaryRedirect}
+ <li class='jc'>{@link oaj.http.response.TooManyRequests}
+ <li class='jc'>{@link oaj.http.response.Unauthorized}
+ <li class='jc'>{@link
oaj.http.response.UnavailableForLegalReasons}
+ <li class='jc'>{@link oaj.http.response.UnprocessableEntity}
+ <li class='jc'>{@link oaj.http.response.UnsupportedMediaType}
+ <li class='jc'>{@link oaj.http.response.UpgradeRequired}
+ <li class='jc'>{@link oaj.http.response.UriTooLong}
+ <li class='jc'>{@link oaj.http.response.UseProxy}
+ <li class='jc'>{@link oaj.http.response.VariantAlsoNegotiates}
+ </ul>
+
+ <p>
+ The most common location where these responses are used are in
REST operation methods described later.
+ <h5 class='figure'>Example:</h5>
+ <p class='bjava'>
+ | <ja>@RestDelete</ja>(path=<js>"/{id}"</js>)
+ | <jk>public</jk> Ok doDelete(<ja>@Path</ja> <jk>int</jk>
<jv>id</jv>) <jk>throws</jk> NotFound, Unauthorized {
+ |
<jf>pojoService</jf>.delete(<jf>pojoService</jf>.find(<jv>id</jv>).orElseThrow(NotFound::<jk>new</jk>));
+ | <jk>return</jk> Ok.OK;
+ | }
+ </p>
+
+ <p>
+ The following classes are also provided for constructing your
own custom responses:
+ </p>
+ <ul class='javatreec'>
+ <li class='jc'>{@link oaj.http.response.BasicHttpException}
+ <li class='jc'>{@link oaj.http.response.BasicHttpResponse}
+ <li class='jc'>{@link oaj.http.response.HttpExceptionBuilder}
+ <li class='jc'>{@link oaj.http.response.HttpResponseBuilder}
+ </ul>
+</div>
\ No newline at end of file
diff --git a/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/08.jm.org.apache.juneau.http.remote.html
similarity index 64%
copy from juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
copy to
juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/08.jm.org.apache.juneau.http.remote.html
index 0b03717c0..d8a82940a 100644
--- a/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts.html
+++
b/juneau-doc/docs/Topics/02.juneau-marshall/24.jm.HttpParts/08.jm.org.apache.juneau.http.remote.html
@@ -13,10 +13,21 @@
***************************************************************************************************************************/
-->
-{title:'HTTP Parts', created:'9.0.0', flags:'TODO'}
+{title:'org.apache.juneau.http.remote', created:'9.0.0'}
<div class='topic'>
<p>
- TODO
+ The {@link oaj.http.remote} package contains the annotations
used for defining client-side remote proxies.
+ </p>
+ <ul class='javatreec'>
+ <li class='ja'>{@link oaj.http.remote.Remote}
+ <li class='ja'>{@link oaj.http.remote.RemoteGet}
+ <li class='ja'>{@link oaj.http.remote.RemotePut}
+ <li class='ja'>{@link oaj.http.remote.RemotePost}
+ <li class='ja'>{@link oaj.http.remote.RemoteDelete}
+ <li class='ja'>{@link oaj.http.remote.RemoteOp}
+ </ul>
+ <p>
+ See {@doc jrc.Proxies Proxies} for more information on use of
these annotations.
</p>
</div>
\ No newline at end of file
diff --git a/juneau-doc/src/main/javadoc/overview.html
b/juneau-doc/src/main/javadoc/overview.html
index c510d66ef..7914a7e4d 100644
--- a/juneau-doc/src/main/javadoc/overview.html
+++ b/juneau-doc/src/main/javadoc/overview.html
@@ -222,7 +222,17 @@
<li><p><a class='doclink'
href='#juneau-marshall.jm.SimpleVariableLanguage.jm.SvlOtherNotes'>Other
Notes</a></p>
</ol>
<li><p><a class='doclink'
href='#juneau-marshall.jm.Encoders'>Encoders</a><span class='update'>created:
<b>9.0.0</b></span></p>
- <li><p><a class='doclink'
href='#juneau-marshall.jm.HttpParts'>HTTP Parts</a><span
class='update'>created: <b>9.0.0</b>, <b><red>TODO</red></b></span></p>
+ <li><p><a class='doclink'
href='#juneau-marshall.jm.HttpParts'>HTTP Parts</a><span
class='update'>created: <b>9.0.0</b></span></p>
+ <ol>
+ <li><p><a class='doclink'
href='#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http'>org.apache.juneau.http</a><span
class='update'>created: <b>9.0.0</b>, <b><red>todo</red></b></span></p>
+ <li><p><a class='doclink'
href='#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.annotation'>org.apache.juneau.http.annotation</a><span
class='update'>created: <b>9.0.0</b>, <b><red>todo</red></b></span></p>
+ <li><p><a class='doclink'
href='#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.header'>org.apache.juneau.http.header</a><span
class='update'>created: <b>9.0.0</b>, <b><red>todo</red></b></span></p>
+ <li><p><a class='doclink'
href='#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.part'>org.apache.juneau.http.part</a><span
class='update'>created: <b>9.0.0</b>, <b><red>todo</red></b></span></p>
+ <li><p><a class='doclink'
href='#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.entity'>org.apache.juneau.http.entity</a><span
class='update'>created: <b>9.0.0</b>, <b><red>todo</red></b></span></p>
+ <li><p><a class='doclink'
href='#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.resource'>org.apache.juneau.http.resource</a><span
class='update'>created: <b>9.0.0</b>, <b><red>todo</red></b></span></p>
+ <li><p><a class='doclink'
href='#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.response'>org.apache.juneau.http.response</a><span
class='update'>created: <b>9.0.0</b>, <b><red>todo</red></b></span></p>
+ <li><p><a class='doclink'
href='#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.remote'>org.apache.juneau.http.remote</a><span
class='update'>created: <b>9.0.0</b>, <b><red>todo</red></b></span></p>
+ </ol>
<li><p><a class='doclink'
href='#juneau-marshall.jm.ObjectTools'>Object Tools</a><span
class='update'>created: <b>9.0.0</b></span></p>
<li><p><a class='doclink'
href='#juneau-marshall.jm.JsonDetails'>JSON Details</a></p>
<ol>
@@ -6246,13 +6256,334 @@
<!--
====================================================================================================
-->
-<h3 class='topic' onclick='toggle(this)'><a
href='#juneau-marshall.jm.HttpParts' id='juneau-marshall.jm.HttpParts'>2.24 -
HTTP Parts</a><span class='update'>created: <b>9.0.0</b>,
<b><red>TODO</red></b></span></h3>
+<h3 class='topic' onclick='toggle(this)'><a
href='#juneau-marshall.jm.HttpParts' id='juneau-marshall.jm.HttpParts'>2.24 -
HTTP Parts</a><span class='update'>created: <b>9.0.0</b></span></h3>
<div class='topic'><!-- START: 2.24 - juneau-marshall.jm.HttpParts -->
<div class='topic'>
<p>
- TODO
+ The {@link org.apache.juneau.http} package contains a slew of
useful extensions to the Apache HttpComponents libraries
+ and define APIs used extensively in the REST server and client
APIs.
+ </p>
+ <ul class='javatree'>
+ <li class='jp'>{@link org.apache.juneau.http} - Utility classes
used for HTTP parts/headers/entities.
+ <li class='jp'>{@link org.apache.juneau.http.annotation} -
Swagger-based annotations used on both server-side APIs and client-side proxy
interfaces.
+ <li class='jp'>{@link org.apache.juneau.http.entity} - HTTP
entity classes.
+ <li class='jp'>{@link org.apache.juneau.http.header} - HTTP
header classes.
+ <li class='jp'>{@link org.apache.juneau.http.part} - HTTP
query/form-data/path classes.
+ <li class='jp'>{@link org.apache.juneau.http.remote} - Remote
proxy interface API
+ <li class='jp'>{@link org.apache.juneau.http.resource} - HTTP
resource classes.
+ <li class='jp'>{@link org.apache.juneau.http.response} - HTTP
response classes.
+ </ul>
+
+ <p>
+ These APIs extend from the Apache HttpComponents libraries and
can be used with libraries based on it such
+ as Apache HttpClient. The REST Client API described later is
built on top of Apache HttpClient and many
+ of the classes defined in this package make up integral
components of that API. Likewise, the APIs
+ defined here are also used in the REST Server APIs also
described later.
+ </p>
+
+
+</div>
+
+<!--
====================================================================================================
-->
+
+<h5 class='topic' onclick='toggle(this)'><a
href='#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http'
id='juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http'>2.24.1 -
org.apache.juneau.http</a><span class='update'>created: <b>9.0.0</b>,
<b><red>todo</red></b></span></h4>
+<div class='topic'><!-- START: 2.24.1 -
juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http -->
+<div class='topic'>
+
+BasicStatusLine.java
+HttpEntities.java
+HttpHeaders.java
+HttpMethod.java
+HttpParts.java
+HttpResources.java
+HttpResponses.java
+</div>
+</div><!-- END: 2.24.1 -
juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http -->
+
+<!--
====================================================================================================
-->
+
+<h5 class='topic' onclick='toggle(this)'><a
href='#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.annotation'
id='juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.annotation'>2.24.2 -
org.apache.juneau.http.annotation</a><span class='update'>created:
<b>9.0.0</b>, <b><red>todo</red></b></span></h4>
+<div class='topic'><!-- START: 2.24.2 -
juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.annotation -->
+<div class='topic'>
+Body.java
+Contact.java
+ExternalDocs.java
+FormData.java
+HasFormData.java
+HasQuery.java
+Header.java
+Items.java
+License.java
+Path.java
+Query.java
+Request.java
+Response.java
+Schema.java
+StatusCode.java
+SubItems.java
+Tag.java
+</div>
+</div><!-- END: 2.24.2 -
juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.annotation -->
+
+<!--
====================================================================================================
-->
+
+<h5 class='topic' onclick='toggle(this)'><a
href='#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.header'
id='juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.header'>2.24.3 -
org.apache.juneau.http.header</a><span class='update'>created: <b>9.0.0</b>,
<b><red>todo</red></b></span></h4>
+<div class='topic'><!-- START: 2.24.3 -
juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.header -->
+<div class='topic'>
+
+Accept.java
+AcceptCharset.java
+AcceptEncoding.java
+AcceptLanguage.java
+AcceptRanges.java
+Age.java
+Allow.java
+Authorization.java
+BasicBooleanHeader.java
+BasicCsvHeader.java
+BasicDateHeader.java
+BasicEntityTagHeader.java
+BasicEntityTagsHeader.java
+BasicHeader.java
+BasicHeaderIterator.java
+BasicIntegerHeader.java
+BasicLongHeader.java
+BasicMediaRangesHeader.java
+BasicMediaTypeHeader.java
+BasicStringHeader.java
+BasicStringRangesHeader.java
+BasicUriHeader.java
+CacheControl.java
+ClientVersion.java
+Connection.java
+ContentDisposition.java
+ContentEncoding.java
+ContentLanguage.java
+ContentLength.java
+ContentLocation.java
+ContentRange.java
+ContentType.java
+Date.java
+Debug.java
+EntityTag.java
+EntityTags.java
+ETag.java
+Expect.java
+Expires.java
+Forwarded.java
+From.java
+Headerable.java
+HeaderBeanMeta.java
+HeaderList.java
+Host.java
+IfMatch.java
+IfModifiedSince.java
+IfNoneMatch.java
+IfRange.java
+IfUnmodifiedSince.java
+LastModified.java
+Location.java
+MaxForwards.java
+MediaRange.java
+MediaRanges.java
+MediaType.java
+NoTrace.java
+Origin.java
+package-info.java
+Pragma.java
+ProxyAuthenticate.java
+ProxyAuthorization.java
+Range.java
+Referer.java
+RetryAfter.java
+SerializedHeader.java
+Server.java
+StringRange.java
+StringRanges.java
+TE.java
+Thrown.java
+Trailer.java
+TransferEncoding.java
+Upgrade.java
+UserAgent.java
+Vary.java
+Via.java
+Warning.java
+WwwAuthenticate.java
+</div>
+</div><!-- END: 2.24.3 -
juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.header -->
+
+<!--
====================================================================================================
-->
+
+<h5 class='topic' onclick='toggle(this)'><a
href='#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.part'
id='juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.part'>2.24.4 -
org.apache.juneau.http.part</a><span class='update'>created: <b>9.0.0</b>,
<b><red>todo</red></b></span></h4>
+<div class='topic'><!-- START: 2.24.4 -
juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.part -->
+<div class='topic'>
+
+BasicBooleanPart.java
+BasicCsvArrayPart.java
+BasicDatePart.java
+BasicIntegerPart.java
+BasicLongPart.java
+BasicPart.java
+BasicPartIterator.java
+BasicStringPart.java
+BasicUriPart.java
+NameValuePairable.java
+package-info.java
+PartBeanMeta.java
+PartIterator.java
+PartList.java
+SerializedPart.java
+</div>
+</div><!-- END: 2.24.4 -
juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.part -->
+
+<!--
====================================================================================================
-->
+
+<h5 class='topic' onclick='toggle(this)'><a
href='#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.entity'
id='juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.entity'>2.24.5 -
org.apache.juneau.http.entity</a><span class='update'>created: <b>9.0.0</b>,
<b><red>todo</red></b></span></h4>
+<div class='topic'><!-- START: 2.24.5 -
juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.entity -->
+<div class='topic'>
+BasicHttpEntity.java
+ByteArrayEntity.java
+FileEntity.java
+HttpEntityBuilder.java
+InputStreamEntity.java
+package-info.java
+ReaderEntity.java
+SerializedEntity.java
+SerializedEntityBuilder.java
+StringEntity.java
+
+</div>
+</div><!-- END: 2.24.5 -
juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.entity -->
+
+<!--
====================================================================================================
-->
+
+<h5 class='topic' onclick='toggle(this)'><a
href='#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.resource'
id='juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.resource'>2.24.6 -
org.apache.juneau.http.resource</a><span class='update'>created: <b>9.0.0</b>,
<b><red>todo</red></b></span></h4>
+<div class='topic'><!-- START: 2.24.6 -
juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.resource -->
+<div class='topic'>
+BasicResource.java
+ByteArrayResource.java
+FileResource.java
+HttpResource.java
+HttpResourceBuilder.java
+InputStreamResource.java
+package-info.java
+ReaderResource.java
+StringResource.java
+</div>
+</div><!-- END: 2.24.6 -
juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.resource -->
+
+<!--
====================================================================================================
-->
+
+<h5 class='topic' onclick='toggle(this)'><a
href='#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.response'
id='juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.response'>2.24.7 -
org.apache.juneau.http.response</a><span class='update'>created: <b>9.0.0</b>,
<b><red>todo</red></b></span></h4>
+<div class='topic'><!-- START: 2.24.7 -
juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.response -->
+<div class='topic'>
+ <p>
+ The {@link org.apache.juneau.http.response} package contains
predefined <c>org.apache.http.HttpResponse</c> implementations for most
standard HTTP
+ responses.
+ </p>
+ <ul class='javatreec'>
+ <li class='jc'>{@link org.apache.juneau.http.response.Accepted}
+ <li class='jc'>{@link
org.apache.juneau.http.response.AlreadyReported}
+ <li class='jc'>{@link
org.apache.juneau.http.response.BadRequest}
+ <li class='jc'>{@link org.apache.juneau.http.response.Conflict}
+ <li class='jc'>{@link org.apache.juneau.http.response.Continue}
+ <li class='jc'>{@link org.apache.juneau.http.response.Created}
+ <li class='jc'>{@link
org.apache.juneau.http.response.EarlyHints}
+ <li class='jc'>{@link
org.apache.juneau.http.response.ExpectationFailed}
+ <li class='jc'>{@link
org.apache.juneau.http.response.FailedDependency}
+ <li class='jc'>{@link org.apache.juneau.http.response.Forbidden}
+ <li class='jc'>{@link org.apache.juneau.http.response.Found}
+ <li class='jc'>{@link org.apache.juneau.http.response.Gone}
+ <li class='jc'>{@link
org.apache.juneau.http.response.HttpVersionNotSupported}
+ <li class='jc'>{@link org.apache.juneau.http.response.IMUsed}
+ <li class='jc'>{@link
org.apache.juneau.http.response.InsufficientStorage}
+ <li class='jc'>{@link
org.apache.juneau.http.response.InternalServerError}
+ <li class='jc'>{@link
org.apache.juneau.http.response.LengthRequired}
+ <li class='jc'>{@link org.apache.juneau.http.response.Locked}
+ <li class='jc'>{@link
org.apache.juneau.http.response.LoopDetected}
+ <li class='jc'>{@link
org.apache.juneau.http.response.MethodNotAllowed}
+ <li class='jc'>{@link
org.apache.juneau.http.response.MisdirectedRequest}
+ <li class='jc'>{@link
org.apache.juneau.http.response.MovedPermanently}
+ <li class='jc'>{@link
org.apache.juneau.http.response.MultipleChoices}
+ <li class='jc'>{@link
org.apache.juneau.http.response.MultiStatus}
+ <li class='jc'>{@link
org.apache.juneau.http.response.NetworkAuthenticationRequired}
+ <li class='jc'>{@link org.apache.juneau.http.response.NoContent}
+ <li class='jc'>{@link
org.apache.juneau.http.response.NonAuthoritiveInformation}
+ <li class='jc'>{@link
org.apache.juneau.http.response.NotAcceptable}
+ <li class='jc'>{@link
org.apache.juneau.http.response.NotExtended}
+ <li class='jc'>{@link org.apache.juneau.http.response.NotFound}
+ <li class='jc'>{@link
org.apache.juneau.http.response.NotImplemented}
+ <li class='jc'>{@link
org.apache.juneau.http.response.NotModified}
+ <li class='jc'>{@link org.apache.juneau.http.response.Ok}
+ <li class='jc'>{@link
org.apache.juneau.http.response.PartialContent}
+ <li class='jc'>{@link
org.apache.juneau.http.response.PayloadTooLarge}
+ <li class='jc'>{@link
org.apache.juneau.http.response.PermanentRedirect}
+ <li class='jc'>{@link
org.apache.juneau.http.response.PreconditionFailed}
+ <li class='jc'>{@link
org.apache.juneau.http.response.PreconditionRequired}
+ <li class='jc'>{@link
org.apache.juneau.http.response.Processing}
+ <li class='jc'>{@link
org.apache.juneau.http.response.RangeNotSatisfiable}
+ <li class='jc'>{@link
org.apache.juneau.http.response.RequestHeaderFieldsTooLarge}
+ <li class='jc'>{@link
org.apache.juneau.http.response.ResetContent}
+ <li class='jc'>{@link org.apache.juneau.http.response.SeeOther}
+ <li class='jc'>{@link
org.apache.juneau.http.response.ServiceUnavailable}
+ <li class='jc'>{@link
org.apache.juneau.http.response.SwitchingProtocols}
+ <li class='jc'>{@link
org.apache.juneau.http.response.TemporaryRedirect}
+ <li class='jc'>{@link
org.apache.juneau.http.response.TooManyRequests}
+ <li class='jc'>{@link
org.apache.juneau.http.response.Unauthorized}
+ <li class='jc'>{@link
org.apache.juneau.http.response.UnavailableForLegalReasons}
+ <li class='jc'>{@link
org.apache.juneau.http.response.UnprocessableEntity}
+ <li class='jc'>{@link
org.apache.juneau.http.response.UnsupportedMediaType}
+ <li class='jc'>{@link
org.apache.juneau.http.response.UpgradeRequired}
+ <li class='jc'>{@link
org.apache.juneau.http.response.UriTooLong}
+ <li class='jc'>{@link org.apache.juneau.http.response.UseProxy}
+ <li class='jc'>{@link
org.apache.juneau.http.response.VariantAlsoNegotiates}
+ </ul>
+
+ <p>
+ The most common location where these responses are used are in
REST operation methods described later.
+ <h5 class='figure'>Example:</h5>
+ <p class='bjava'>
+ <ja>@RestDelete</ja>(path=<js>"/{id}"</js>)
+ <jk>public</jk> Ok doDelete(<ja>@Path</ja> <jk>int</jk> <jv>id</jv>)
<jk>throws</jk> NotFound, Unauthorized {
+
<jf>pojoService</jf>.delete(<jf>pojoService</jf>.find(<jv>id</jv>).orElseThrow(NotFound::<jk>new</jk>));
+ <jk>return</jk> Ok.OK;
+ }
+ </p>
+
+ <p>
+ The following classes are also provided for constructing your
own custom responses:
+ </p>
+ <ul class='javatreec'>
+ <li class='jc'>{@link
org.apache.juneau.http.response.BasicHttpException}
+ <li class='jc'>{@link
org.apache.juneau.http.response.BasicHttpResponse}
+ <li class='jc'>{@link
org.apache.juneau.http.response.HttpExceptionBuilder}
+ <li class='jc'>{@link
org.apache.juneau.http.response.HttpResponseBuilder}
+ </ul>
+</div>
+</div><!-- END: 2.24.7 -
juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.response -->
+
+<!--
====================================================================================================
-->
+
+<h5 class='topic' onclick='toggle(this)'><a
href='#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.remote'
id='juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.remote'>2.24.8 -
org.apache.juneau.http.remote</a><span class='update'>created: <b>9.0.0</b>,
<b><red>todo</red></b></span></h4>
+<div class='topic'><!-- START: 2.24.8 -
juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.remote -->
+<div class='topic'>
+ <p>
+ The {@link org.apache.juneau.http.remote} package contains the
annotations used for defining client-side remote proxies.
+ </p>
+ <ul class='javatreec'>
+ <li class='ja'>{@link org.apache.juneau.http.remote.Remote}
+ <li class='ja'>{@link org.apache.juneau.http.remote.RemoteGet}
+ <li class='ja'>{@link org.apache.juneau.http.remote.RemotePut}
+ <li class='ja'>{@link org.apache.juneau.http.remote.RemotePost}
+ <li class='ja'>{@link
org.apache.juneau.http.remote.RemoteDelete}
+ <li class='ja'>{@link org.apache.juneau.http.remote.RemoteOp}
+ </ul>
+ <p>
+ See {@doc jrc.Proxies Proxies} for more information on use of
these annotations.
</p>
</div>
+</div><!-- END: 2.24.8 -
juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.remote -->
</div><!-- END: 2.24 - juneau-marshall.jm.HttpParts -->
<!--
====================================================================================================
-->
diff --git a/juneau-doc/src/main/javadoc/resources/docs.txt
b/juneau-doc/src/main/javadoc/resources/docs.txt
index d74f3723f..4c3f53742 100644
--- a/juneau-doc/src/main/javadoc/resources/docs.txt
+++ b/juneau-doc/src/main/javadoc/resources/docs.txt
@@ -188,6 +188,14 @@ jm.XmlMethodology =
#juneau-marshall.jm.XmlDetails.jm.XmlMethodology, Overview >
jm.XmlNamespaces = #juneau-marshall.jm.XmlDetails.jm.XmlNamespaces, Overview >
juneau-marshall > XML Details > Namespaces
jm.XmlParsers = #juneau-marshall.jm.XmlDetails.jm.XmlParsers, Overview >
juneau-marshall > XML Details > XML Parsers
jm.XmlSerializers = #juneau-marshall.jm.XmlDetails.jm.XmlSerializers, Overview
> juneau-marshall > XML Details > XML Serializers
+jm.org.apache.juneau.http =
#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http, Overview >
juneau-marshall > HTTP Parts > org.apache.juneau.http
+jm.org.apache.juneau.http.annotation =
#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.annotation, Overview >
juneau-marshall > HTTP Parts > org.apache.juneau.http.annotation
+jm.org.apache.juneau.http.entity =
#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.entity, Overview >
juneau-marshall > HTTP Parts > org.apache.juneau.http.entity
+jm.org.apache.juneau.http.header =
#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.header, Overview >
juneau-marshall > HTTP Parts > org.apache.juneau.http.header
+jm.org.apache.juneau.http.part =
#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.part, Overview >
juneau-marshall > HTTP Parts > org.apache.juneau.http.part
+jm.org.apache.juneau.http.remote =
#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.remote, Overview >
juneau-marshall > HTTP Parts > org.apache.juneau.http.remote
+jm.org.apache.juneau.http.resource =
#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.resource, Overview >
juneau-marshall > HTTP Parts > org.apache.juneau.http.resource
+jm.org.apache.juneau.http.response =
#juneau-marshall.jm.HttpParts.jm.org.apache.juneau.http.response, Overview >
juneau-marshall > HTTP Parts > org.apache.juneau.http.response
jmc.Args = #juneau-microservice-core.jmc.Args, Overview >
juneau-microservice-core > Args
jmc.Config = #juneau-microservice-core.jmc.Config, Overview >
juneau-microservice-core > Config
jmc.ConsoleCommands = #juneau-microservice-core.jmc.ConsoleCommands, Overview
> juneau-microservice-core > Console Commands
