You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2019/10/29 15:30:16 UTC
[camel] 02/02: Polished
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
commit e94e235ce55f398d7f6fe854a52b76a169ed6b75
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Tue Oct 29 16:06:33 2019 +0100
Polished
---
.../apache/camel/component/extension/ComponentExtension.java | 4 ++--
.../api/management/mbean/ComponentVerifierExtension.java | 12 ++++++++++--
2 files changed, 12 insertions(+), 4 deletions(-)
diff --git a/core/camel-api/src/main/java/org/apache/camel/component/extension/ComponentExtension.java b/core/camel-api/src/main/java/org/apache/camel/component/extension/ComponentExtension.java
index b4c7917..c5e1f62 100644
--- a/core/camel-api/src/main/java/org/apache/camel/component/extension/ComponentExtension.java
+++ b/core/camel-api/src/main/java/org/apache/camel/component/extension/ComponentExtension.java
@@ -19,10 +19,10 @@ package org.apache.camel.component.extension;
/**
* Marker interface for component extensions.
* <p/>
- * An extension is a feature provided by the component such as ComponentVerifier,
- * ServiceMetaData.
+ * An extension is a feature provided by the component such as ComponentVerifier.
*/
public interface ComponentExtension {
+
/**
* Access the underlying concrete ComponentExtension implementation to
* provide access to further features.
diff --git a/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ComponentVerifierExtension.java b/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ComponentVerifierExtension.java
index e410508..a5de932 100644
--- a/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ComponentVerifierExtension.java
+++ b/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ComponentVerifierExtension.java
@@ -33,7 +33,6 @@ import org.apache.camel.api.management.mbean.ComponentVerifierExtension.Verifica
* interface is {@link ManagedComponentMBean#verify(String, Map)} which takes a scope and a set of parameters which should be verified.
* <p/>
* The return value is a {@link ComponentVerifierExtension.Result} of the verification
- *
*/
public final class ComponentVerifierExtension {
@@ -89,6 +88,7 @@ public final class ComponentVerifierExtension {
* The scope defines how the parameters should be verified.
*/
public enum Scope {
+
/**
* Only validate the parameters for their <em>syntactic</em> soundness. Verifications in this scope should
* be as fast as possible
@@ -275,7 +275,7 @@ public final class ComponentVerifierExtension {
*/
StandardCode UNSUPPORTED_SCOPE = new StandardErrorCode("UNSUPPORTED_SCOPE");
/**
- * The requested {@link Component} is not supported
+ * The requested Component is not supported
*/
StandardCode UNSUPPORTED_COMPONENT = new StandardErrorCode("UNSUPPORTED_COMPONENT");
/**
@@ -288,6 +288,7 @@ public final class ComponentVerifierExtension {
* Interface defining an attribute which is a key for the detailed error messages.
*/
interface Attribute extends Serializable {
+
/**
* Name of the attribute. All uppercase for standard attributes and all lower case for custom attributes.
* Separator between words is an underscore.
@@ -311,11 +312,13 @@ public final class ComponentVerifierExtension {
* Attributes for details about an exception that was raised
*/
interface ExceptionAttribute extends Attribute {
+
/**
* The exception object that has been thrown. Note that this can be a complex
* object and can cause large content when e.g. serialized as JSON
*/
ExceptionAttribute EXCEPTION_INSTANCE = new ExceptionErrorAttribute("EXCEPTION_INSTANCE");
+
/**
* The exception class
*/
@@ -326,14 +329,17 @@ public final class ComponentVerifierExtension {
* HTTP related error details
*/
interface HttpAttribute extends Attribute {
+
/**
* The erroneous HTTP code that occurred
*/
HttpAttribute HTTP_CODE = new HttpErrorAttribute("HTTP_CODE");
+
/**
* HTTP response's body
*/
HttpAttribute HTTP_TEXT = new HttpErrorAttribute("HTTP_TEXT");
+
/**
* If given as details, specifies that a redirect happened and the
* content of this detail is the redirect URL
@@ -345,10 +351,12 @@ public final class ComponentVerifierExtension {
* Group related details
*/
interface GroupAttribute extends Attribute {
+
/**
* Group name
*/
GroupAttribute GROUP_NAME = new GroupErrorAttribute("GROUP_NAME");
+
/**
* Options for the group
*/