You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by gg...@apache.org on 2023/03/20 18:07:05 UTC
[mina-asyncweb] branch master updated (81474b5 -> f3ef64d)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/mina-asyncweb.git
from 81474b5 upgraded to MINA 2.0.4 and bumped up the slf4j/log4j dependencies
new a56d86e Javadoc fixes
new e41d23d Git ignore IDE folders and files
new b1d1162 Javadoc fixes
new f3ef64d Javadoc: Port package.html to package-info.java
The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.gitignore | 5 +++++
.../main/java/org/apache/ahc/HttpIoHandler.java | 16 ++++++-------
.../main/java/org/apache/ahc/ResponseFuture.java | 2 --
.../main/java/org/apache/ahc/auth/AuthPolicy.java | 6 ++---
.../java/org/apache/ahc/auth/NTCredentials.java | 2 +-
.../main/java/org/apache/ahc/auth/NTLMScheme.java | 1 -
.../java/org/apache/ahc/codec/HttpDecoder.java | 2 +-
.../org/apache/ahc/codec/HttpRequestEncoder.java | 4 ++--
.../org/apache/ahc/codec/HttpRequestMessage.java | 8 +++----
.../org/apache/ahc/codec/HttpResponseDecoder.java | 2 +-
.../codec/package-info.java} | 12 ++++------
.../main/java/org/apache/ahc/codec/package.html | 26 ----------------------
.../package-info.java} | 12 ++++------
client/src/main/java/org/apache/ahc/package.html | 26 ----------------------
.../ssl/package-info.java} | 12 ++++------
.../src/main/java/org/apache/ahc/ssl/package.html | 26 ----------------------
.../java/org/apache/ahc/util/EncodingUtil.java | 9 ++++----
.../main/java/org/apache/ahc/util/LangUtils.java | 2 +-
.../org/apache/ahc/util/ParameterFormatter.java | 16 ++++++-------
.../util/package-info.java} | 12 ++++------
.../src/main/java/org/apache/ahc/util/package.html | 26 ----------------------
.../java/org/apache/asyncweb/common/Cookie.java | 3 ++-
.../org/apache/asyncweb/common/HttpRequest.java | 16 ++++++++-----
.../apache/asyncweb/common/HttpResponseStatus.java | 7 ++++--
.../org/apache/asyncweb/common/MutableCookie.java | 3 ++-
.../apache/asyncweb/common/MutableHttpRequest.java | 2 --
.../common/codec/ChunkedBodyDecodingState.java | 17 ++++++++------
.../apache/asyncweb/server/HttpServiceHandler.java | 11 +++++----
.../apache/asyncweb/server/ServiceContainer.java | 2 +-
.../server/context/BasicKeepAliveStrategy.java | 2 +-
.../server/filter/SessionKeepAliveFilter.java | 6 ++---
.../asyncweb/server/pipeline/RequestPipeline.java | 2 +-
.../server/resolver/PatternMatchResolver.java | 4 +++-
.../asyncweb/server/resolver/ServiceResolver.java | 5 +++--
.../server/resolver/SimplePrefixResolver.java | 26 +++++++++++++---------
.../server/session/DefaultSessionAccessor.java | 9 ++++----
.../asyncweb/server/session/HttpSessionStore.java | 2 +-
.../transport/mina/SingleHttpSessionIoHandler.java | 4 +++-
.../asyncweb/server/util/LinkedPermitIssuer.java | 7 ++++--
.../apache/asyncweb/server/util/TimedPermit.java | 9 ++++----
40 files changed, 137 insertions(+), 227 deletions(-)
create mode 100644 .gitignore
copy client/src/main/java/org/apache/{asyncweb/client/AsyncHttpClientCallback.java => ahc/codec/package-info.java} (76%)
delete mode 100644 client/src/main/java/org/apache/ahc/codec/package.html
copy client/src/main/java/org/apache/{asyncweb/client/AsyncHttpClientCallback.java => ahc/package-info.java} (76%)
delete mode 100644 client/src/main/java/org/apache/ahc/package.html
copy client/src/main/java/org/apache/{asyncweb/client/AsyncHttpClientCallback.java => ahc/ssl/package-info.java} (76%)
delete mode 100644 client/src/main/java/org/apache/ahc/ssl/package.html
copy client/src/main/java/org/apache/{asyncweb/client/AsyncHttpClientCallback.java => ahc/util/package-info.java} (76%)
delete mode 100644 client/src/main/java/org/apache/ahc/util/package.html
[mina-asyncweb] 04/04: Javadoc: Port package.html to package-info.java
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mina-asyncweb.git
commit f3ef64d0c41c61facad5f23429bbf264258cd25d
Author: Gary Gregory <gg...@rocketsoftware.com>
AuthorDate: Mon Mar 20 14:07:01 2023 -0400
Javadoc: Port package.html to package-info.java
---
.../java/org/apache/ahc/codec/package-info.java | 24 ++++++++++++++++++++
.../main/java/org/apache/ahc/codec/package.html | 26 ----------------------
.../src/main/java/org/apache/ahc/package-info.java | 24 ++++++++++++++++++++
client/src/main/java/org/apache/ahc/package.html | 26 ----------------------
.../main/java/org/apache/ahc/ssl/package-info.java | 24 ++++++++++++++++++++
.../src/main/java/org/apache/ahc/ssl/package.html | 26 ----------------------
.../java/org/apache/ahc/util/package-info.java | 24 ++++++++++++++++++++
.../src/main/java/org/apache/ahc/util/package.html | 26 ----------------------
8 files changed, 96 insertions(+), 104 deletions(-)
diff --git a/client/src/main/java/org/apache/ahc/codec/package-info.java b/client/src/main/java/org/apache/ahc/codec/package-info.java
new file mode 100644
index 0000000..27db8bd
--- /dev/null
+++ b/client/src/main/java/org/apache/ahc/codec/package-info.java
@@ -0,0 +1,24 @@
+/*
+ * 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.
+ *
+ */
+
+/**
+ * Contains the classes that support messages, encoding, and decoding the HTTP protocol.
+ */
+package org.apache.ahc.codec;
diff --git a/client/src/main/java/org/apache/ahc/codec/package.html b/client/src/main/java/org/apache/ahc/codec/package.html
deleted file mode 100644
index a5b51c9..0000000
--- a/client/src/main/java/org/apache/ahc/codec/package.html
+++ /dev/null
@@ -1,26 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
-<html>
-<head>
-<!--
- ~ 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.
- -->
-</head>
-<body bgcolor="white">
-Contains the classes that support messages, encoding, and decoding the HTTP protocol.
-</body>
-</html>
diff --git a/client/src/main/java/org/apache/ahc/package-info.java b/client/src/main/java/org/apache/ahc/package-info.java
new file mode 100644
index 0000000..c569199
--- /dev/null
+++ b/client/src/main/java/org/apache/ahc/package-info.java
@@ -0,0 +1,24 @@
+/*
+ * 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.
+ *
+ */
+
+/**
+ * <h2>The primary user components for the AsyncHttpClient API.</h2>
+ */
+package org.apache.ahc;
diff --git a/client/src/main/java/org/apache/ahc/package.html b/client/src/main/java/org/apache/ahc/package.html
deleted file mode 100644
index f8c1c65..0000000
--- a/client/src/main/java/org/apache/ahc/package.html
+++ /dev/null
@@ -1,26 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
-<html>
-<head>
-<!--
- ~ 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.
- -->
-</head>
-<body bgcolor="white">
-<h2>The primary user components for the AsyncHttpClient API.</h2>
-</body>
-</html>
diff --git a/client/src/main/java/org/apache/ahc/ssl/package-info.java b/client/src/main/java/org/apache/ahc/ssl/package-info.java
new file mode 100644
index 0000000..5df5c88
--- /dev/null
+++ b/client/src/main/java/org/apache/ahc/ssl/package-info.java
@@ -0,0 +1,24 @@
+/*
+ * 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.
+ *
+ */
+
+/**
+ * SSL utility classes.
+ */
+package org.apache.ahc.ssl;
diff --git a/client/src/main/java/org/apache/ahc/ssl/package.html b/client/src/main/java/org/apache/ahc/ssl/package.html
deleted file mode 100644
index 0c18b91..0000000
--- a/client/src/main/java/org/apache/ahc/ssl/package.html
+++ /dev/null
@@ -1,26 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
-<html>
-<head>
-<!--
- ~ 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.
- -->
-</head>
-<body bgcolor="white">
-SSL utility classes.
-</body>
-</html>
diff --git a/client/src/main/java/org/apache/ahc/util/package-info.java b/client/src/main/java/org/apache/ahc/util/package-info.java
new file mode 100644
index 0000000..80363c1
--- /dev/null
+++ b/client/src/main/java/org/apache/ahc/util/package-info.java
@@ -0,0 +1,24 @@
+/*
+ * 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.
+ *
+ */
+
+/**
+ * AsynHttpClient utility and support classes.
+ */
+package org.apache.ahc.util;
diff --git a/client/src/main/java/org/apache/ahc/util/package.html b/client/src/main/java/org/apache/ahc/util/package.html
deleted file mode 100644
index ae75770..0000000
--- a/client/src/main/java/org/apache/ahc/util/package.html
+++ /dev/null
@@ -1,26 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
-<html>
-<head>
-<!--
- ~ 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.
- -->
-</head>
-<body bgcolor="white">
-AsynHttpClient utility and support classes.
-</body>
-</html>
[mina-asyncweb] 01/04: Javadoc fixes
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mina-asyncweb.git
commit a56d86ef941b8784e19a08e4f619791722b5c015
Author: Gary Gregory <gg...@rocketsoftware.com>
AuthorDate: Mon Mar 20 12:06:55 2023 -0400
Javadoc fixes
- Fix error: self-closing element not allowed
- Fix error: element not closed: table
- Fix error: unexpected text
- Fix error: no parameter
- FIx error: no summary or caption for table
- Fix error: @param name not found
---
.../main/java/org/apache/asyncweb/common/Cookie.java | 3 ++-
.../java/org/apache/asyncweb/common/HttpRequest.java | 16 +++++++++++-----
.../org/apache/asyncweb/common/HttpResponseStatus.java | 7 +++++--
.../java/org/apache/asyncweb/common/MutableCookie.java | 3 ++-
.../org/apache/asyncweb/common/MutableHttpRequest.java | 2 --
.../asyncweb/common/codec/ChunkedBodyDecodingState.java | 17 ++++++++++-------
.../org/apache/asyncweb/server/HttpServiceHandler.java | 11 +++++++----
.../org/apache/asyncweb/server/ServiceContainer.java | 2 +-
.../asyncweb/server/context/BasicKeepAliveStrategy.java | 2 +-
9 files changed, 39 insertions(+), 24 deletions(-)
diff --git a/common/src/main/java/org/apache/asyncweb/common/Cookie.java b/common/src/main/java/org/apache/asyncweb/common/Cookie.java
index b92b474..a8172b6 100644
--- a/common/src/main/java/org/apache/asyncweb/common/Cookie.java
+++ b/common/src/main/java/org/apache/asyncweb/common/Cookie.java
@@ -101,7 +101,8 @@ public interface Cookie extends Serializable, Comparable<Cookie> {
/**
* Returns if this cookie is marked as "HTTP only".
- * {@link http://www.owasp.org/index.php/HTTPOnly}
+ *
+ * @see <a href="http://www.owasp.org/index.php/">HTTPOnly</a>
*/
boolean isHttpOnly();
}
diff --git a/common/src/main/java/org/apache/asyncweb/common/HttpRequest.java b/common/src/main/java/org/apache/asyncweb/common/HttpRequest.java
index 18e4564..74a38b7 100644
--- a/common/src/main/java/org/apache/asyncweb/common/HttpRequest.java
+++ b/common/src/main/java/org/apache/asyncweb/common/HttpRequest.java
@@ -72,12 +72,15 @@ public interface HttpRequest extends HttpMessage {
/**
* Determines whether the HTTP connection should remain open
* after handling this request.
+ * <p>
* If the request is a <code>HTTP/1.1</code> request, we keep
* the connection alive unless an explicit <code>"Connection: close"</code>
- * header is sent.<br/>
+ * header is sent.
+ * </p>
+ * <p>
* Otherwise, the connection is only kept alive if an explicit
* <code>"Connection: keep-alive"</code> header is sent
- *
+ * </p>
* @return <code>true</code> if the connection should remain
* open following the handling of this request
*/
@@ -88,12 +91,15 @@ public interface HttpRequest extends HttpMessage {
* A client may set a continuation expectation when sending a request
* before continuing to send the body of a request (e.g. because it
* would be inefficient to send the whole body if the server will
- * reject the request based on the headers alone)<br/>
+ * reject the request based on the headers alone)
+ * <p>
* If this request requires a continuation response, it should be
- * sent to the client if the server is prepared to handle the request<br/>
- *
+ * sent to the client if the server is prepared to handle the request
+ * </p>
+ * <p>
* Note that if a continuation response is sent to the client, the server
* MUST ultimately also send a final status code.
+ * </p>
*
* @return <code>true</code> if this request requires a continuation
* response to be sent
diff --git a/common/src/main/java/org/apache/asyncweb/common/HttpResponseStatus.java b/common/src/main/java/org/apache/asyncweb/common/HttpResponseStatus.java
index ae8eb3f..9249535 100644
--- a/common/src/main/java/org/apache/asyncweb/common/HttpResponseStatus.java
+++ b/common/src/main/java/org/apache/asyncweb/common/HttpResponseStatus.java
@@ -228,15 +228,18 @@ public class HttpResponseStatus implements Serializable {
/**
* Returns the <code>ResponseStatus</code> with the specified
* status id.
+ * <p>
* If no status exists with the specified id, a new status is created
- * and registered based on the category applicable to the id:<br/>
+ * and registered based on the category applicable to the id:
+ * </p>
* <table border="1">
+ * <caption>Status</caption>
* <tr><td>100 - 199</td><td>Informational</td></tr>
* <tr><td>200 - 299</td><td>Successful</td></tr>
* <tr><td>300 - 399</td><td>Redirection</td></tr>
* <tr><td>400 - 499</td><td>Client Error</td></tr>
* <tr><td>500 - 599</td><td>Server Error</td></tr>
- * <table>.
+ * </table>
*
* @param id The id of the desired response status
* @return The <code>ResponseStatus</code>
diff --git a/common/src/main/java/org/apache/asyncweb/common/MutableCookie.java b/common/src/main/java/org/apache/asyncweb/common/MutableCookie.java
index d8c9216..3706bfc 100644
--- a/common/src/main/java/org/apache/asyncweb/common/MutableCookie.java
+++ b/common/src/main/java/org/apache/asyncweb/common/MutableCookie.java
@@ -65,7 +65,8 @@ public interface MutableCookie extends Cookie {
/**
* Mark the cookie a only for HTTP. Browser are supposed to block access to this cookie
* from client side code.
- * {@link http://www.owasp.org/index.php/HTTPOnly}
+ *
+ * See <a href="http://www.owasp.org/index.php/HTTPOnly">HTTPOnly</a>
*/
void setHttpOnly(boolean httpOnly);
diff --git a/common/src/main/java/org/apache/asyncweb/common/MutableHttpRequest.java b/common/src/main/java/org/apache/asyncweb/common/MutableHttpRequest.java
index 3741e03..3a877b6 100644
--- a/common/src/main/java/org/apache/asyncweb/common/MutableHttpRequest.java
+++ b/common/src/main/java/org/apache/asyncweb/common/MutableHttpRequest.java
@@ -132,8 +132,6 @@ public interface MutableHttpRequest extends MutableHttpMessage, HttpRequest {
* <li>Adds '<tt>Host</tt>' header if necessary.</li>
* <li>Adds '<tt>Content-length</tt>' header if possible.</li>
* </ol>
- *
- * @param request the request that pairs with this response
*/
void normalize();
}
diff --git a/common/src/main/java/org/apache/asyncweb/common/codec/ChunkedBodyDecodingState.java b/common/src/main/java/org/apache/asyncweb/common/codec/ChunkedBodyDecodingState.java
index cb63749..54fef7c 100644
--- a/common/src/main/java/org/apache/asyncweb/common/codec/ChunkedBodyDecodingState.java
+++ b/common/src/main/java/org/apache/asyncweb/common/codec/ChunkedBodyDecodingState.java
@@ -34,16 +34,19 @@ import org.apache.mina.filter.codec.statemachine.SkippingState;
/**
* A decoder which decodes the body of HTTP Requests having
* a "chunked" transfer-coding.
- *
+ * <p>
* This decoder does <i>not</i> decode trailing entity-headers - it simply
* discards them. Tomcat currently does the same - so this is probably
- * the most stable approach for now.<br/>
+ * the most stable approach for now.
+ * </p>
+ * <p>
* If the need arises to decode them in the future, we simply need to employ a
* <code>HttpHeaderDecoder</code> following the last chunk - yielding
- * headers for the encountered trailing entity-headers.<p/>
- *
+ * headers for the encountered trailing entity-headers.
+ * </p>
+ * <p>
* This decoder decodes the following format:
- *
+ * </p>
* <pre>
* Chunked-Body = *chunk
* last-chunk
@@ -59,12 +62,12 @@ import org.apache.mina.filter.codec.statemachine.SkippingState;
* chunk-data = chunk-size(OCTET)
* trailer = *(entity-header CRLF)
* </pre>
- *
+ * <p>
* <code>ChunkedBodyDecoder</code> employs a <code>SharedBytesAllocator</code>
* to enable the content of each decoded chunk to contribute to a single
* <code>Bytes</code>. This enables all chunks to be read without requiring
* copying.
- *
+ * </p>
* @author The Apache MINA Project (dev@mina.apache.org)
*/
public abstract class ChunkedBodyDecodingState extends DecodingStateMachine {
diff --git a/server/src/main/java/org/apache/asyncweb/server/HttpServiceHandler.java b/server/src/main/java/org/apache/asyncweb/server/HttpServiceHandler.java
index bee7bf7..d1f9766 100644
--- a/server/src/main/java/org/apache/asyncweb/server/HttpServiceHandler.java
+++ b/server/src/main/java/org/apache/asyncweb/server/HttpServiceHandler.java
@@ -54,9 +54,10 @@ public class HttpServiceHandler implements HttpServiceFilter {
* Adds an <code>HttpService</code> against a service name.
* The service will be invoked this handlers associated
* <code>ServiceResolver</code> resolves a request to the
- * specified service name.<br/>
- *
+ * specified service name.
+ * <p>
* Any existing registration against the given name is overwritten.
+ * </p>
*
* @param name The service name
* @param httpService The service
@@ -73,7 +74,7 @@ public class HttpServiceHandler implements HttpServiceFilter {
/**
* Remove an <code>HttpService</code> which was previously added.
*
- * @param String name The key name of the HttpService you want to remove
+ * @param name The key name of the HttpService you want to remove
*/
public void removeHttpService(String name) {
HttpService service = serviceMap.remove(name);
@@ -98,10 +99,12 @@ public class HttpServiceHandler implements HttpServiceFilter {
/**
* Attempts to resolve the specified request to an <code>HttpService</code>
* known to this handler by employing this handlers associated
- * <code>ServiceResolver</code>.<br/>
+ * <code>ServiceResolver</code>.
+ * <p>
* If an <code>HttpService</code> is located for the request, it is provided
* with the request. Otherwise, a <code>404</code> response is committed
* for the request
+ * </p>
*/
public void handleRequest(NextFilter next, HttpServiceContext context)
throws Exception {
diff --git a/server/src/main/java/org/apache/asyncweb/server/ServiceContainer.java b/server/src/main/java/org/apache/asyncweb/server/ServiceContainer.java
index 59dd123..075b5ed 100644
--- a/server/src/main/java/org/apache/asyncweb/server/ServiceContainer.java
+++ b/server/src/main/java/org/apache/asyncweb/server/ServiceContainer.java
@@ -69,7 +69,7 @@ public interface ServiceContainer {
* as it passes through the container.
* The accessor is shutdown when this container is stopped
*
- * @param sessionAccessor The accessor
+ * @param accessor The accessor
*/
void setSessionAccessor( HttpSessionAccessor accessor);
diff --git a/server/src/main/java/org/apache/asyncweb/server/context/BasicKeepAliveStrategy.java b/server/src/main/java/org/apache/asyncweb/server/context/BasicKeepAliveStrategy.java
index 91a384b..515e84b 100644
--- a/server/src/main/java/org/apache/asyncweb/server/context/BasicKeepAliveStrategy.java
+++ b/server/src/main/java/org/apache/asyncweb/server/context/BasicKeepAliveStrategy.java
@@ -49,7 +49,7 @@ public class BasicKeepAliveStrategy implements KeepAliveStrategy {
* This method returns true iff either:
* <ul>
* <li>The request is not committed</li>
- * </u>
+ * </ul>
* or (in order):
* <ul>
* <li>The status of a response does not force closure</li>
[mina-asyncweb] 02/04: Git ignore IDE folders and files
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mina-asyncweb.git
commit e41d23d7cf7c50ba45cb12e06e65177e06011b43
Author: Gary Gregory <gg...@rocketsoftware.com>
AuthorDate: Mon Mar 20 12:07:09 2023 -0400
Git ignore IDE folders and files
---
.gitignore | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..775af3a
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,5 @@
+/.idea/
+**/.settings/
+**/.project
+**/.classpath
+**/target/
\ No newline at end of file
[mina-asyncweb] 03/04: Javadoc fixes
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mina-asyncweb.git
commit b1d116255da509e75da505f2aaafbf04899e6e97
Author: Gary Gregory <gg...@rocketsoftware.com>
AuthorDate: Mon Mar 20 14:06:53 2023 -0400
Javadoc fixes
- Fix error: self-closing element not allowed
- Fix error: element not closed: table
- Fix error: unexpected text
- Fix error: no parameter
- FIx error: no summary or caption for table
- Fix error: @param name not found
---
.../main/java/org/apache/ahc/HttpIoHandler.java | 16 ++++++-------
.../main/java/org/apache/ahc/ResponseFuture.java | 2 --
.../main/java/org/apache/ahc/auth/AuthPolicy.java | 6 ++---
.../java/org/apache/ahc/auth/NTCredentials.java | 2 +-
.../main/java/org/apache/ahc/auth/NTLMScheme.java | 1 -
.../java/org/apache/ahc/codec/HttpDecoder.java | 2 +-
.../org/apache/ahc/codec/HttpRequestEncoder.java | 4 ++--
.../org/apache/ahc/codec/HttpRequestMessage.java | 8 +++----
.../org/apache/ahc/codec/HttpResponseDecoder.java | 2 +-
.../java/org/apache/ahc/util/EncodingUtil.java | 9 ++++----
.../main/java/org/apache/ahc/util/LangUtils.java | 2 +-
.../org/apache/ahc/util/ParameterFormatter.java | 16 ++++++-------
.../server/filter/SessionKeepAliveFilter.java | 6 ++---
.../asyncweb/server/pipeline/RequestPipeline.java | 2 +-
.../server/resolver/PatternMatchResolver.java | 4 +++-
.../asyncweb/server/resolver/ServiceResolver.java | 5 +++--
.../server/resolver/SimplePrefixResolver.java | 26 +++++++++++++---------
.../server/session/DefaultSessionAccessor.java | 9 ++++----
.../asyncweb/server/session/HttpSessionStore.java | 2 +-
.../transport/mina/SingleHttpSessionIoHandler.java | 4 +++-
.../asyncweb/server/util/LinkedPermitIssuer.java | 7 ++++--
.../apache/asyncweb/server/util/TimedPermit.java | 9 ++++----
22 files changed, 77 insertions(+), 67 deletions(-)
diff --git a/client/src/main/java/org/apache/ahc/HttpIoHandler.java b/client/src/main/java/org/apache/ahc/HttpIoHandler.java
index 9c2f581..2d60420 100644
--- a/client/src/main/java/org/apache/ahc/HttpIoHandler.java
+++ b/client/src/main/java/org/apache/ahc/HttpIoHandler.java
@@ -31,8 +31,8 @@ import org.apache.ahc.codec.HttpResponseMessage;
import org.apache.ahc.util.MonitoringEvent;
import org.apache.ahc.util.NameValuePair;
import org.apache.asyncweb.common.HttpMethod;
-import org.apache.mina.core.session.IdleStatus;
import org.apache.mina.core.service.IoHandlerAdapter;
+import org.apache.mina.core.session.IdleStatus;
import org.apache.mina.core.session.IoSession;
@@ -86,7 +86,7 @@ public class HttpIoHandler extends IoHandlerAdapter {
/**
* Stub for handling sessionOpened events.
*
- * @see org.apache.mina.core.IoHandlerAdapter#sessionOpened(org.apache.mina.core.IoSession)
+ * @see IoHandlerAdapter#sessionOpened(IoSession)
*/
public void sessionOpened(IoSession ioSession) throws Exception {
}
@@ -94,9 +94,9 @@ public class HttpIoHandler extends IoHandlerAdapter {
/**
* Handler for receiving a response from a remote server.
*
- * @param ioSession the {@link org.apache.mina.core.IoSession} representing the connection to the server.
+ * @param ioSession the {@link IoSession} representing the connection to the server.
* @param object the {@link HttpResponseMessage} object
- * @see org.apache.mina.core.IoHandlerAdapter#messageReceived(org.apache.mina.core.IoSession,java.lang.Object)
+ * @see IoHandlerAdapter#messageReceived(IoSession,java.lang.Object)
*/
public void messageReceived(IoSession ioSession, Object object) throws Exception {
@@ -182,9 +182,9 @@ public class HttpIoHandler extends IoHandlerAdapter {
/**
* Handler for receiving a notification that an Exception occurred in the communication with the server
*
- * @param ioSession the {@link org.apache.mina.core.IoSession} representing the connection to the server.
+ * @param ioSession the {@link IoSession} representing the connection to the server.
* @param throwable the {@link java.lang.Throwable} object representing the exception that occurred
- * @see org.apache.mina.core.IoHandlerAdapter#exceptionCaught(org.apache.mina.core.IoSession,java.lang.Throwable)
+ * @see IoHandlerAdapter#exceptionCaught(IoSession,java.lang.Throwable)
*/
public void exceptionCaught(IoSession ioSession, Throwable throwable) throws Exception {
//Clean up if any in-proccess decoding was occurring
@@ -207,8 +207,8 @@ public class HttpIoHandler extends IoHandlerAdapter {
/**
* Handler for notifying that a connection was closed to the remote server.
*
- * @param ioSession the {@link org.apache.mina.core.IoSession} representing the connection to the server.
- * @see org.apache.mina.core.IoHandlerAdapter#sessionClosed(org.apache.mina.core.IoSession)
+ * @param ioSession the {@link IoSession} representing the connection to the server.
+ * @see IoHandlerAdapter#sessionClosed(IoSession)
*/
public void sessionClosed(IoSession ioSession) throws Exception {
//Clean up if any in-proccess decoding was occurring
diff --git a/client/src/main/java/org/apache/ahc/ResponseFuture.java b/client/src/main/java/org/apache/ahc/ResponseFuture.java
index 98f6cbe..698df1d 100755
--- a/client/src/main/java/org/apache/ahc/ResponseFuture.java
+++ b/client/src/main/java/org/apache/ahc/ResponseFuture.java
@@ -57,8 +57,6 @@ public class ResponseFuture extends FutureTask<HttpResponseMessage>
*
* @param queue optional completion queue. If not null, this future will be
* placed in the queue on completion.
- * @param callback optional callback object. If not null, the callback will
- * be invoked at proper stages on completion.
*/
public ResponseFuture(HttpRequestMessage request,
BlockingQueue<ResponseFuture> queue) {
diff --git a/client/src/main/java/org/apache/ahc/auth/AuthPolicy.java b/client/src/main/java/org/apache/ahc/auth/AuthPolicy.java
index 511890b..2532be4 100644
--- a/client/src/main/java/org/apache/ahc/auth/AuthPolicy.java
+++ b/client/src/main/java/org/apache/ahc/auth/AuthPolicy.java
@@ -35,8 +35,7 @@ public class AuthPolicy {
* The key used to look up the list of IDs of supported {@link AuthScheme
* authentication schemes} in their order of preference. The scheme IDs are
* stored in a {@link java.util.Collection} as {@link java.lang.String}s.
- * <p/>
- * <p/>
+ * <p>
* If several schemes are returned in the <tt>WWW-Authenticate</tt>
* or <tt>Proxy-Authenticate</tt> header, this parameter defines which
* {@link AuthScheme authentication schemes} takes precedence over others.
@@ -82,8 +81,7 @@ public class AuthPolicy {
* the given identifier. If a class with the given ID already exists it will be overridden.
* This ID is the same one used to retrieve the {@link AuthScheme authentication scheme}
* from {@link #getAuthScheme(String)}.
- * <p/>
- * <p/>
+ * <p>
* Please note that custom authentication preferences, if used, need to be updated accordingly
* for the new {@link AuthScheme authentication scheme} to take effect.
* </p>
diff --git a/client/src/main/java/org/apache/ahc/auth/NTCredentials.java b/client/src/main/java/org/apache/ahc/auth/NTCredentials.java
index 55db402..2604e0f 100644
--- a/client/src/main/java/org/apache/ahc/auth/NTCredentials.java
+++ b/client/src/main/java/org/apache/ahc/auth/NTCredentials.java
@@ -46,7 +46,7 @@ public class NTCredentials extends UsernamePasswordCredentials {
/**
* Default constructor.
*
- * @deprecated Do not use. Null user name, domain & host no longer allowed
+ * @deprecated Do not use. Null user name, domain and host no longer allowed
*/
public NTCredentials() {
super();
diff --git a/client/src/main/java/org/apache/ahc/auth/NTLMScheme.java b/client/src/main/java/org/apache/ahc/auth/NTLMScheme.java
index 5a32746..e694146 100644
--- a/client/src/main/java/org/apache/ahc/auth/NTLMScheme.java
+++ b/client/src/main/java/org/apache/ahc/auth/NTLMScheme.java
@@ -137,7 +137,6 @@ public class NTLMScheme implements AuthScheme {
/**
* Returns the authentication parameter with the given name, if available.
- * <p/>
* <p>There are no valid parameters for NTLM authentication so this method always returns
* <tt>null</tt>.</p>
*
diff --git a/client/src/main/java/org/apache/ahc/codec/HttpDecoder.java b/client/src/main/java/org/apache/ahc/codec/HttpDecoder.java
index 55722d8..2e2dbfd 100644
--- a/client/src/main/java/org/apache/ahc/codec/HttpDecoder.java
+++ b/client/src/main/java/org/apache/ahc/codec/HttpDecoder.java
@@ -270,7 +270,7 @@ public class HttpDecoder {
*
* @param cookieStr the cookie <code>String</code> header line
*
- * @return the decoded <code>Cookie</cookie>
+ * @return the decoded <code>Cookie</code>
*
* @throws Exception if any exception occurs
* @see Cookie
diff --git a/client/src/main/java/org/apache/ahc/codec/HttpRequestEncoder.java b/client/src/main/java/org/apache/ahc/codec/HttpRequestEncoder.java
index a514af5..bf118b0 100644
--- a/client/src/main/java/org/apache/ahc/codec/HttpRequestEncoder.java
+++ b/client/src/main/java/org/apache/ahc/codec/HttpRequestEncoder.java
@@ -78,10 +78,10 @@ public class HttpRequestEncoder extends ProtocolEncoderAdapter {
/**
* Method responsible for encoding a HttpRequestMessage into raw bytes.
*
- * @param ioSession the {@link org.apache.mina.core.IoSession} representing the connection to the server.
+ * @param ioSession the {@link IoSession} representing the connection to the server.
* @param message the {@link HttpRequestMessage} object
* @param out {@link org.apache.mina.filter.codec.ProtocolEncoderOutput} used for output
- * @see org.apache.mina.filter.codec.ProtocolEncoder#encode(org.apache.mina.core.IoSession, java.lang.Object, org.apache.mina.filter.codec.ProtocolEncoderOutput)
+ * @see org.apache.mina.filter.codec.ProtocolEncoder#encode(IoSession, java.lang.Object, org.apache.mina.filter.codec.ProtocolEncoderOutput)
*/
public void encode(IoSession ioSession, Object message, ProtocolEncoderOutput out) throws Exception {
HttpRequestMessage msg = (HttpRequestMessage)message;
diff --git a/client/src/main/java/org/apache/ahc/codec/HttpRequestMessage.java b/client/src/main/java/org/apache/ahc/codec/HttpRequestMessage.java
index e08286b..9c82672 100644
--- a/client/src/main/java/org/apache/ahc/codec/HttpRequestMessage.java
+++ b/client/src/main/java/org/apache/ahc/codec/HttpRequestMessage.java
@@ -136,7 +136,7 @@ public class HttpRequestMessage extends HttpMessage {
/**
* Gets the request method.
*
- * @return the request method. Defaults to {@link #REQUEST_GET} if not set.
+ * @return the request method. Defaults to {@link HttpMethod#GET} if not set.
*/
public HttpMethod getRequestMethod() {
return requestMethod;
@@ -169,9 +169,9 @@ public class HttpRequestMessage extends HttpMessage {
* Sets the request method.
*
* @param requestMethod the new request method
- * @throws ProtocolException if the request method is not of type {@link #REQUEST_GET},
- * {@link #REQUEST_POST},{@link #REQUEST_HEAD},{@link #REQUEST_OPTIONS},
- * {@link #REQUEST_PUT},{@link #REQUEST_DELETE}, or {@link #REQUEST_TRACE}
+ * @throws ProtocolException if the request method is not of type {@link HttpMethod#GET},
+ * {@link HttpMethod#POST},{@link HttpMethod#HEAD},{@link HttpMethod#OPTIONS},
+ * {@link HttpMethod#PUT},{@link HttpMethod#DELETE}, or {@link HttpMethod#TRACE}
*/
public void setRequestMethod(HttpMethod requestMethod) throws ProtocolException {
this.requestMethod = requestMethod;
diff --git a/client/src/main/java/org/apache/ahc/codec/HttpResponseDecoder.java b/client/src/main/java/org/apache/ahc/codec/HttpResponseDecoder.java
index 6809a01..7ce2508 100644
--- a/client/src/main/java/org/apache/ahc/codec/HttpResponseDecoder.java
+++ b/client/src/main/java/org/apache/ahc/codec/HttpResponseDecoder.java
@@ -38,7 +38,7 @@ public class HttpResponseDecoder extends CumulativeProtocolDecoder {
/**
* Decodes the raw HTTP response from a server into a {@link HttpResponseMessage} object.
*
- * @param ioSession the {@link org.apache.mina.core.IoSession} representing the connection to the server.
+ * @param ioSession the {@link IoSession} representing the connection to the server.
* @param in the <code>ByteBuffer</code> that contains the raw bytes from the server
* @param out {@link org.apache.mina.filter.codec.ProtocolDecoderOutput} used for output
*
diff --git a/client/src/main/java/org/apache/ahc/util/EncodingUtil.java b/client/src/main/java/org/apache/ahc/util/EncodingUtil.java
index d58fddb..f88f418 100644
--- a/client/src/main/java/org/apache/ahc/util/EncodingUtil.java
+++ b/client/src/main/java/org/apache/ahc/util/EncodingUtil.java
@@ -49,17 +49,18 @@ public final class EncodingUtil {
/**
* Form-urlencoding routine.
- * <p/>
+ * <p>
* The default encoding for all forms is `application/x-www-form-urlencoded'.
* A form data set is represented in this media type as follows:
- * <p/>
+ * </p>
+ * <p>
* The form field names and values are escaped: space characters are replaced
* by `+', and then reserved characters are escaped as per [URL]; that is,
* non-alphanumeric characters are replaced by `%HH', a percent sign and two
* hexadecimal digits representing the ASCII code of the character. Line breaks,
* as in multi-line text field values, are represented as CR LF pairs, i.e. `%0D%0A'.
- * <p/>
- * <p/>
+ * </p>
+ * <p>
* if the given charset is not supported, ISO-8859-1 is used instead.
* </p>
*
diff --git a/client/src/main/java/org/apache/ahc/util/LangUtils.java b/client/src/main/java/org/apache/ahc/util/LangUtils.java
index 2bbc10f..5a73028 100644
--- a/client/src/main/java/org/apache/ahc/util/LangUtils.java
+++ b/client/src/main/java/org/apache/ahc/util/LangUtils.java
@@ -23,7 +23,7 @@ package org.apache.ahc.util;
* A set of utility methods to help produce consistent Object#equals(Object) and
* Object#hashCode methods.
*
- * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
+ * @author oleg at ural.ru Oleg Kalnichevski
*/
public final class LangUtils {
diff --git a/client/src/main/java/org/apache/ahc/util/ParameterFormatter.java b/client/src/main/java/org/apache/ahc/util/ParameterFormatter.java
index 80dc613..6aecbd6 100644
--- a/client/src/main/java/org/apache/ahc/util/ParameterFormatter.java
+++ b/client/src/main/java/org/apache/ahc/util/ParameterFormatter.java
@@ -28,26 +28,26 @@ package org.apache.ahc.util;
* <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6">Section 3.6</a>
* of <a href="http://www.w3.org/Protocols/rfc2616/rfc2616.txt">RFC 2616</a>
* </p>
- * <h>2.1 Augmented BNF</h>
+ * <h2>2.1 Augmented BNF</h2>
* <p>
* Many HTTP/1.1 header field values consist of words separated by LWS or special
* characters. These special characters MUST be in a quoted string to be used within
* a parameter value (as defined in section 3.6).
- * <p>
- * <pre>
+ * </p>
+ * <pre>{@code
* token = 1*<any CHAR except CTLs or separators>
* separators = "(" | ")" | "<" | ">" | "@"
* | "," | ";" | ":" | "\" | <">
* | "/" | "[" | "]" | "?" | "="
* | "{" | "}" | SP | HT
- * </pre>
+ * }</pre>
* <p>
* A string of text is parsed as a single word if it is quoted using double-quote marks.
* </p>
- * <pre>
+ * <pre>{@code
* quoted-string = ( <"> *(qdtext | quoted-pair ) <"> )
* qdtext = <any TEXT except <">>
- * </pre>
+ * }</pre>
* <p>
* The backslash character ("\") MAY be used as a single-character quoting mechanism only
* within quoted-string and comment constructs.
@@ -55,7 +55,7 @@ package org.apache.ahc.util;
* <pre>
* quoted-pair = "\" CHAR
* </pre>
- * <h>3.6 Transfer Codings</h>
+ * <h2>3.6 Transfer Codings</h2>
* <p>
* Parameters are in the form of attribute/value pairs.
* </p>
@@ -65,7 +65,7 @@ package org.apache.ahc.util;
* value = token | quoted-string
* </pre>
*
- * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
+ * @author oleg at ural.ru Oleg Kalnichevski
*
*/
public class ParameterFormatter {
diff --git a/server/src/main/java/org/apache/asyncweb/server/filter/SessionKeepAliveFilter.java b/server/src/main/java/org/apache/asyncweb/server/filter/SessionKeepAliveFilter.java
index 2c72fe5..b42b1d6 100644
--- a/server/src/main/java/org/apache/asyncweb/server/filter/SessionKeepAliveFilter.java
+++ b/server/src/main/java/org/apache/asyncweb/server/filter/SessionKeepAliveFilter.java
@@ -29,11 +29,11 @@ import org.apache.asyncweb.server.HttpServiceFilter;
* A <code>ServiceHandler</code> which causes any existing session associated with
* each request it handles to be renewed.
* This causes sessions attached to requests to be renewed per-request - even if
- * the request does not cause session access to occur.<br/>
- *
+ * the request does not cause session access to occur.
+ * <p>
* This handler does not need to be installed for deployments which do not employ
* sessions
- *
+ * </p>
*/
public class SessionKeepAliveFilter implements HttpServiceFilter
{
diff --git a/server/src/main/java/org/apache/asyncweb/server/pipeline/RequestPipeline.java b/server/src/main/java/org/apache/asyncweb/server/pipeline/RequestPipeline.java
index ea76fbc..09d8ba2 100644
--- a/server/src/main/java/org/apache/asyncweb/server/pipeline/RequestPipeline.java
+++ b/server/src/main/java/org/apache/asyncweb/server/pipeline/RequestPipeline.java
@@ -35,7 +35,7 @@ public interface RequestPipeline {
* of the specified response becoming available.
* If the associated request has not been previously added to this pipeline,
* it joins the pipeline at the back of the queue: All previously added
- * requests must be responded to before the new request can take its turn<br/>
+ * requests must be responded to before the new request can take its turn.
*/
public void releaseResponse(HttpServiceContext context);
diff --git a/server/src/main/java/org/apache/asyncweb/server/resolver/PatternMatchResolver.java b/server/src/main/java/org/apache/asyncweb/server/resolver/PatternMatchResolver.java
index 1fbf498..3d05886 100644
--- a/server/src/main/java/org/apache/asyncweb/server/resolver/PatternMatchResolver.java
+++ b/server/src/main/java/org/apache/asyncweb/server/resolver/PatternMatchResolver.java
@@ -31,9 +31,11 @@ import org.slf4j.LoggerFactory;
/**
* A <code>ServiceResolver</code> which maps request URIs to service names. An
* pattern match is required on a request URI to a service name for returning
- * the matching service. Pattern are in the {@link Pattern} format.<br/>
+ * the matching service. Pattern are in the {@link Pattern} format.
+ * <p>
* For example : "/hello/.*" will match all the URI begining by the string
* "/hello/".
+ * </p>
*
* @author The Apache MINA Project (dev@mina.apache.org)
*/
diff --git a/server/src/main/java/org/apache/asyncweb/server/resolver/ServiceResolver.java b/server/src/main/java/org/apache/asyncweb/server/resolver/ServiceResolver.java
index 1dfd7ba..13484be 100644
--- a/server/src/main/java/org/apache/asyncweb/server/resolver/ServiceResolver.java
+++ b/server/src/main/java/org/apache/asyncweb/server/resolver/ServiceResolver.java
@@ -30,10 +30,11 @@ public interface ServiceResolver {
/**
* Determines the name of the <code>HttpService</code> to be employed
- * to service a given <code>HttpRequest</code>.<br/>
- *
+ * to service a given <code>HttpRequest</code>.
+ * <p>
* If no service can be resolved for the specified request, this method
* should return <code>null</code>.
+ * </p>
*
* @param request The request for which a service name is required
* @return The name of the <code>HttpService</code> which
diff --git a/server/src/main/java/org/apache/asyncweb/server/resolver/SimplePrefixResolver.java b/server/src/main/java/org/apache/asyncweb/server/resolver/SimplePrefixResolver.java
index a738050..80983b2 100644
--- a/server/src/main/java/org/apache/asyncweb/server/resolver/SimplePrefixResolver.java
+++ b/server/src/main/java/org/apache/asyncweb/server/resolver/SimplePrefixResolver.java
@@ -26,19 +26,22 @@ import org.slf4j.LoggerFactory;
/**
* A very simple resolver which simply uses the full URI after
* stripping an optional prefix as the name of the service.
- *
+ * <p>
* <code>SimplePrefixResolver</code> is useful when a very
* naming scheme is used - and allows services to be resolved
- * "dynamically" without any global configuration.<br/>
- * </br>
+ * "dynamically" without any global configuration.
+ * </p>
+ * <p>
* Request URIs which do not begin with the configured prefix are
- * not resolved.<br/>
- * <br/>
+ * not resolved.
+ * </p>
+ * <p>
* For example, suppose all <code>HttpService</code>s are addressed
* under the prefix <code>/services/</code>. We would then map as
- * follows for the following URIs:<br/>
- * <br/>
+ * follows for the following URIs:
+ * </p>
* <table border="1" cellpadding="2">
+ * <caption>Example Mappings</caption>
* <tr><td>URI</td><td>Service Name</td></tr>
* <tr><td>/services/serviceA</td><td>serviceA</td></tr>
* <tr><td>/services/serviceB</td><td>serviceB</td></tr>
@@ -59,9 +62,10 @@ public class SimplePrefixResolver implements ServiceResolver {
* Sets the prefix associated with this resolver.
* URIs which begin with the specified prefix are resolved to the URI
* with the prefix stripped. URIs which do not begin with the specified
- * prefix are not resolved.<br/>
- * <br/>
+ * prefix are not resolved.
+ * <p>
* If a prefix is not set, requests are resolved to their URI value.
+ * </p>
*
* @param uriPrefix The uri prefix to apply
*/
@@ -73,10 +77,12 @@ public class SimplePrefixResolver implements ServiceResolver {
/**
* Resolves the name of the service to be employed for the specified request.
* If this resolver is not configured with a prefix, the request resoves to
- * the request URI.<br/>
+ * the request URI.
+ * <p>
* Otherwise, if the request URI begins with the configured prefix, the request
* resolves to the URI with the prefix stripped. If the request URI does not
* begin with the configured prefix, the request is unresolved
+ * </p>
*
* @param request The request to resolve to a service name
* @return The resolved service name, or <code>null</code> if
diff --git a/server/src/main/java/org/apache/asyncweb/server/session/DefaultSessionAccessor.java b/server/src/main/java/org/apache/asyncweb/server/session/DefaultSessionAccessor.java
index 90cfc6c..11acf6f 100644
--- a/server/src/main/java/org/apache/asyncweb/server/session/DefaultSessionAccessor.java
+++ b/server/src/main/java/org/apache/asyncweb/server/session/DefaultSessionAccessor.java
@@ -28,13 +28,12 @@ import org.slf4j.LoggerFactory;
/**
* A simple <code>SessionAccessor</code> implementation which acts as a facade
* to an employed <code>SessionIdentifier</code>, <code>SessionKeyFactory</code>
- * and <code>SessionStore</code>.<br/>
- *
+ * and <code>SessionStore</code>.
+ * <p>
* A Default identifier and key factory is employed by this accessor, but the
* implementations used can be switched (if required) using the appropriate
- * setter methods.<br/>
- *
- *
+ * setter methods.
+ * </p>
*/
public class DefaultSessionAccessor implements HttpSessionAccessor {
diff --git a/server/src/main/java/org/apache/asyncweb/server/session/HttpSessionStore.java b/server/src/main/java/org/apache/asyncweb/server/session/HttpSessionStore.java
index b60cfcf..030e787 100644
--- a/server/src/main/java/org/apache/asyncweb/server/session/HttpSessionStore.java
+++ b/server/src/main/java/org/apache/asyncweb/server/session/HttpSessionStore.java
@@ -54,7 +54,7 @@ public interface HttpSessionStore {
/**
* Locates an existing session with the specified key.
* Any store which employs session time-outs should perform the appropriate
- * action to mark the session as recently used before returning it.<br/>
+ * action to mark the session as recently used before returning it.
*
* @param key The key for which a session is required
* @return The session, or <code>null</code> if no session was found with
diff --git a/server/src/main/java/org/apache/asyncweb/server/transport/mina/SingleHttpSessionIoHandler.java b/server/src/main/java/org/apache/asyncweb/server/transport/mina/SingleHttpSessionIoHandler.java
index e5ab613..322bcc1 100644
--- a/server/src/main/java/org/apache/asyncweb/server/transport/mina/SingleHttpSessionIoHandler.java
+++ b/server/src/main/java/org/apache/asyncweb/server/transport/mina/SingleHttpSessionIoHandler.java
@@ -246,8 +246,10 @@ public class SingleHttpSessionIoHandler implements SingleSessionIoHandler
/**
* Invoked when data wrote has been fully written.
* If we have scheduled closure after sending a final response, we will
- * be provided with the <code>CLOSE_MARKER</code> as our marker object.<br/>
+ * be provided with the <code>CLOSE_MARKER</code> as our marker object.
+ * <p>
* This signals us to schedule closure of the connection
+ * </p>
*
* @param message The marker provided when writing data. If this is
* our closure marker, we schedule closure of the connection
diff --git a/server/src/main/java/org/apache/asyncweb/server/util/LinkedPermitIssuer.java b/server/src/main/java/org/apache/asyncweb/server/util/LinkedPermitIssuer.java
index 2e8fe63..cf56a5d 100644
--- a/server/src/main/java/org/apache/asyncweb/server/util/LinkedPermitIssuer.java
+++ b/server/src/main/java/org/apache/asyncweb/server/util/LinkedPermitIssuer.java
@@ -32,12 +32,15 @@ import org.apache.asyncweb.server.util.TimedPermit;
/**
* A <code>TimedPermitIssuer</code> which stores all issued permits in a linked
* list.
+ * <p>
* As a permit is renewed, its lifetime is extended and it is simply moved to the
* back of the list (As <code>LinkedPermitIssuer</code> uses a fixed lifetime for
- * all permits and renewals).<br/>
+ * all permits and renewals).
+ * </p>
+ * <p>
* Each permit issued by this issuer has direct access to its place in the list -
* allowing constant time renewals.
- *
+ * </p>
*
*/
public class LinkedPermitIssuer implements TimedPermitIssuer
diff --git a/server/src/main/java/org/apache/asyncweb/server/util/TimedPermit.java b/server/src/main/java/org/apache/asyncweb/server/util/TimedPermit.java
index de5cd5f..98a09b0 100644
--- a/server/src/main/java/org/apache/asyncweb/server/util/TimedPermit.java
+++ b/server/src/main/java/org/apache/asyncweb/server/util/TimedPermit.java
@@ -24,8 +24,6 @@ package org.apache.asyncweb.server.util;
* A <code>TimedPermit</code> is issued for a target object by a <code>TimedPermitIssue</code>.
* When the time limit (determined by the issuer) is reached, any listeners attached to
* the issuer are notified.
- *
- *
*/
public interface TimedPermit {
@@ -33,11 +31,14 @@ public interface TimedPermit {
* Extends the lifetime of this permit.
* This is typically used as a "keep-alive" mechanism. For example, if a permit is
* issued to manage the idle expiry time of an http session, the permit might be
- * extended each time the client issues a request associated with the session.<br/>
+ * extended each time the client issues a request associated with the session.
+ * <p>
* The amount of time added to the lifetime of this permit by invoking this method
* is determined by the <code>TimedPermitIssuer</code> which issued this permit.
- *
+ * </p>
+ * <p>
* Invoking this method has no effect if this permit is already expired
+ * </p>
*/
public void renew();