IGNITE-15175 Fixed javadoc in Rest module. Fixes #319
diff --git a/check-rules/checkstyle-disabled-modules.xml b/check-rules/checkstyle-disabled-modules.xml
index 6c62f17..2d01111 100644
--- a/check-rules/checkstyle-disabled-modules.xml
+++ b/check-rules/checkstyle-disabled-modules.xml
@@ -26,6 +26,5 @@
<suppress files="[/\\]examples[/\\]" checks=".*" />
<suppress files="[/\\]modules/cli[/\\]" checks=".*" />
<suppress files="[/\\]modules/raft-client[/\\]" checks=".*" />
- <suppress files="[/\\]modules/rest[/\\]" checks=".*" />
<suppress files="[/\\]modules/runner[/\\]" checks=".*" />
</suppressions>
diff --git a/modules/rest/src/main/java/org/apache/ignite/rest/ErrorResult.java b/modules/rest/src/main/java/org/apache/ignite/rest/ErrorResult.java
index 0cd7558..2e4943c 100644
--- a/modules/rest/src/main/java/org/apache/ignite/rest/ErrorResult.java
+++ b/modules/rest/src/main/java/org/apache/ignite/rest/ErrorResult.java
@@ -39,6 +39,8 @@
}
/**
+ * Returns error type describing the class of the error occurred.
+ *
* @return Error type describing the class of the error occurred.
*/
public String type() {
@@ -46,6 +48,8 @@
}
/**
+ * Returns user-friendly error message.
+ *
* @return User-friendly error message.
*/
public String message() {
diff --git a/modules/rest/src/main/java/org/apache/ignite/rest/RestModule.java b/modules/rest/src/main/java/org/apache/ignite/rest/RestModule.java
index c8338ae..326cf28 100644
--- a/modules/rest/src/main/java/org/apache/ignite/rest/RestModule.java
+++ b/modules/rest/src/main/java/org/apache/ignite/rest/RestModule.java
@@ -141,6 +141,7 @@
*
* @param router Dispatcher of http requests.
* @return Future which will be notified when this channel is closed.
+ * @throws RuntimeException if this module cannot be bound to a port.
*/
private ChannelFuture startRestEndpoint(Router router) {
RestView restConfigurationView = nodeCfgRegistry.getConfiguration(RestConfiguration.KEY).value();
diff --git a/modules/rest/src/main/java/org/apache/ignite/rest/netty/RestApiHandler.java b/modules/rest/src/main/java/org/apache/ignite/rest/netty/RestApiHandler.java
index af9bb83..212cc6a 100644
--- a/modules/rest/src/main/java/org/apache/ignite/rest/netty/RestApiHandler.java
+++ b/modules/rest/src/main/java/org/apache/ignite/rest/netty/RestApiHandler.java
@@ -47,13 +47,15 @@
* It receives http request, process it by {@link Router} and produce http response.
*/
public class RestApiHandler extends SimpleChannelInboundHandler<HttpObject> {
- /** */
+ /** Ignite logger. */
private final IgniteLogger log = IgniteLogger.forClass(getClass());
/** Requests' router. */
private final Router router;
/**
+ * Creates a new instance of API handler.
+ *
* @param router Router.
*/
public RestApiHandler(Router router) {
diff --git a/modules/rest/src/main/java/org/apache/ignite/rest/netty/RestApiHttpRequest.java b/modules/rest/src/main/java/org/apache/ignite/rest/netty/RestApiHttpRequest.java
index 62b5352..ca4d7fb 100644
--- a/modules/rest/src/main/java/org/apache/ignite/rest/netty/RestApiHttpRequest.java
+++ b/modules/rest/src/main/java/org/apache/ignite/rest/netty/RestApiHttpRequest.java
@@ -32,6 +32,8 @@
private final Map<String, String> qryParams;
/**
+ * Creates a new instance of http request.
+ *
* @param req Request.
* @param qryParams Query params.
*/
diff --git a/modules/rest/src/main/java/org/apache/ignite/rest/netty/RestApiHttpResponse.java b/modules/rest/src/main/java/org/apache/ignite/rest/netty/RestApiHttpResponse.java
index 4ff2a6d..89a63d7 100644
--- a/modules/rest/src/main/java/org/apache/ignite/rest/netty/RestApiHttpResponse.java
+++ b/modules/rest/src/main/java/org/apache/ignite/rest/netty/RestApiHttpResponse.java
@@ -81,6 +81,8 @@
}
/**
+ * Returns content in a form of raw bytes.
+ *
* @return Content.
*/
public byte[] content() {
@@ -108,6 +110,8 @@
}
/**
+ * Returns protocol version.
+ *
* @return Protocol version
*/
public HttpVersion protocolVersion() {
@@ -126,6 +130,8 @@
}
/**
+ * Returns mutable response headers.
+ *
* @return Mutable response headers.
*/
public HttpHeaders headers() {
diff --git a/modules/rest/src/main/java/org/apache/ignite/rest/netty/RestApiInitializer.java b/modules/rest/src/main/java/org/apache/ignite/rest/netty/RestApiInitializer.java
index 8ff84fc..77f8415 100644
--- a/modules/rest/src/main/java/org/apache/ignite/rest/netty/RestApiInitializer.java
+++ b/modules/rest/src/main/java/org/apache/ignite/rest/netty/RestApiInitializer.java
@@ -33,6 +33,8 @@
private final Router router;
/**
+ * Creates a new instance of initializer.
+ *
* @param router Router.
*/
public RestApiInitializer(Router router) {
diff --git a/modules/rest/src/main/java/org/apache/ignite/rest/netty/package-info.java b/modules/rest/src/main/java/org/apache/ignite/rest/netty/package-info.java
new file mode 100755
index 0000000..72d9589
--- /dev/null
+++ b/modules/rest/src/main/java/org/apache/ignite/rest/netty/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+/**
+ * This package contains classes that represent inbound requests, outbound responses and main REST handler.
+ */
+package org.apache.ignite.rest.netty;
diff --git a/modules/rest/src/main/java/org/apache/ignite/rest/package-info.java b/modules/rest/src/main/java/org/apache/ignite/rest/package-info.java
new file mode 100755
index 0000000..1955cae
--- /dev/null
+++ b/modules/rest/src/main/java/org/apache/ignite/rest/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+/**
+ * This package contains an implementation of Ignite component related to REST interface.
+ */
+package org.apache.ignite.rest;
diff --git a/modules/rest/src/main/java/org/apache/ignite/rest/presentation/hocon/package-info.java b/modules/rest/src/main/java/org/apache/ignite/rest/presentation/hocon/package-info.java
new file mode 100755
index 0000000..dd069db
--- /dev/null
+++ b/modules/rest/src/main/java/org/apache/ignite/rest/presentation/hocon/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+/**
+ * This package contains classes related to HOCON representation.
+ */
+package org.apache.ignite.rest.presentation.hocon;
diff --git a/modules/rest/src/main/java/org/apache/ignite/rest/presentation/package-info.java b/modules/rest/src/main/java/org/apache/ignite/rest/presentation/package-info.java
new file mode 100755
index 0000000..289ac60
--- /dev/null
+++ b/modules/rest/src/main/java/org/apache/ignite/rest/presentation/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * 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 a base interface that provides the ability to convert representation to other formats.
+ */
+package org.apache.ignite.rest.presentation;
diff --git a/modules/rest/src/main/java/org/apache/ignite/rest/routes/Route.java b/modules/rest/src/main/java/org/apache/ignite/rest/routes/Route.java
index 2ef2613..1243bce 100644
--- a/modules/rest/src/main/java/org/apache/ignite/rest/routes/Route.java
+++ b/modules/rest/src/main/java/org/apache/ignite/rest/routes/Route.java
@@ -46,6 +46,8 @@
private final BiConsumer<RestApiHttpRequest, RestApiHttpResponse> hnd;
/**
+ * Create a new URI route with the given parameters.
+ *
* @param route Route.
* @param method Method.
* @param acceptType Accept type.
@@ -86,8 +88,10 @@
}
/**
+ * Returns {@code true} if route matches the request, else otherwise.
+ *
* @param s Content type.
- * @return true if route matches the request, else otherwise.
+ * @return {@code true} if route matches the request, else otherwise.
*/
private boolean matchContentType(String s) {
return (acceptType == null) || (acceptType.equals(s));
@@ -125,6 +129,7 @@
*
* @param uri Input URI.
* @return Map of decoded params.
+ * @throws IllegalArgumentException if provided URI is incorrect.
*/
private Map<String, String> paramsDecode(String uri) {
var receivedParts = new ArrayDeque<>(Arrays.asList(uri.split("/")));
diff --git a/modules/rest/src/main/java/org/apache/ignite/rest/routes/Router.java b/modules/rest/src/main/java/org/apache/ignite/rest/routes/Router.java
index b79ee90..ba8180c 100644
--- a/modules/rest/src/main/java/org/apache/ignite/rest/routes/Router.java
+++ b/modules/rest/src/main/java/org/apache/ignite/rest/routes/Router.java
@@ -42,7 +42,7 @@
*/
public class Router {
/** Routes. */
- private/*public*/ final List<Route> routes;
+ private final List<Route> routes;
/**
* Creates a new router with the given list of {@code routes}.
diff --git a/modules/rest/src/main/java/org/apache/ignite/rest/routes/package-info.java b/modules/rest/src/main/java/org/apache/ignite/rest/routes/package-info.java
new file mode 100755
index 0000000..9690fb2
--- /dev/null
+++ b/modules/rest/src/main/java/org/apache/ignite/rest/routes/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+/**
+ * This package contains classes that represent URI routers and their dispatching.
+ */
+package org.apache.ignite.rest.routes;
