Component docs
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/fc38b2e6 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/fc38b2e6 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/fc38b2e6 Branch: refs/heads/master Commit: fc38b2e675490aab7e8cdcb079c04e5d169ebd2a Parents: d38ffcf Author: Claus Ibsen <davscl...@apache.org> Authored: Thu Jun 18 14:01:18 2015 +0200 Committer: Claus Ibsen <davscl...@apache.org> Committed: Thu Jun 18 14:01:18 2015 +0200 ---------------------------------------------------------------------- .../component/jetty/JettyHttpComponent.java | 29 ++++++++++++++++++++ 1 file changed, 29 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/fc38b2e6/components/camel-jetty-common/src/main/java/org/apache/camel/component/jetty/JettyHttpComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-jetty-common/src/main/java/org/apache/camel/component/jetty/JettyHttpComponent.java b/components/camel-jetty-common/src/main/java/org/apache/camel/component/jetty/JettyHttpComponent.java index c6c47ac..95b1185 100644 --- a/components/camel-jetty-common/src/main/java/org/apache/camel/component/jetty/JettyHttpComponent.java +++ b/components/camel-jetty-common/src/main/java/org/apache/camel/component/jetty/JettyHttpComponent.java @@ -49,6 +49,7 @@ import org.apache.camel.component.http.UrlRewrite; import org.apache.camel.spi.HeaderFilterStrategy; import org.apache.camel.spi.ManagementAgent; import org.apache.camel.spi.ManagementStrategy; +import org.apache.camel.spi.Metadata; import org.apache.camel.spi.RestConfiguration; import org.apache.camel.spi.RestConsumerFactory; import org.apache.camel.util.FileUtil; @@ -481,6 +482,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * The key password, which is used to access the certificate's key entry in the keystore (this is the same password that is supplied to the keystore command's -keypass option). */ + @Metadata(description = "The key password, which is used to access the certificate's key entry in the keystore (this is the same password that is supplied to the keystore command's -keypass option).") public void setSslKeyPassword(String sslKeyPassword) { this.sslKeyPassword = sslKeyPassword; } @@ -492,6 +494,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * The ssl password, which is required to access the keystore file (this is the same password that is supplied to the keystore command's -storepass option). */ + @Metadata(description = "The ssl password, which is required to access the keystore file (this is the same password that is supplied to the keystore command's -storepass option).") public void setSslPassword(String sslPassword) { this.sslPassword = sslPassword; } @@ -499,6 +502,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * Specifies the location of the Java keystore file, which contains the Jetty server's own X.509 certificate in a key entry. */ + @Metadata(description = "Specifies the location of the Java keystore file, which contains the Jetty server's own X.509 certificate in a key entry.") public void setKeystore(String sslKeystore) { this.sslKeystore = sslKeystore; } @@ -514,6 +518,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * This option is used to set the ErrorHandler that Jetty server uses. */ + @Metadata(description = "This option is used to set the ErrorHandler that Jetty server uses.") public void setErrorHandler(ErrorHandler errorHandler) { this.errorHandler = errorHandler; } @@ -626,6 +631,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * A map which contains per port number specific SSL connectors. */ + @Metadata(description = "A map which contains per port number specific SSL connectors.") public void setSslSocketConnectors(Map <Integer, Connector> connectors) { sslSocketConnectors = connectors; } @@ -633,6 +639,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * A map which contains per port number specific HTTP connectors. Uses the same principle as sslSocketConnectors. */ + @Metadata(description = "A map which contains per port number specific HTTP connectors. Uses the same principle as sslSocketConnectors.") public void setSocketConnectors(Map<Integer, Connector> socketConnectors) { this.socketConnectors = socketConnectors; } @@ -707,6 +714,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * To set a value for minimum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured. */ + @Metadata(description = "To set a value for minimum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured.") public void setHttpClientMinThreads(Integer httpClientMinThreads) { this.httpClientMinThreads = httpClientMinThreads; } @@ -718,6 +726,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * To set a value for maximum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured. */ + @Metadata(description = "To set a value for maximum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured.") public void setHttpClientMaxThreads(Integer httpClientMaxThreads) { this.httpClientMaxThreads = httpClientMaxThreads; } @@ -729,6 +738,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * To set a value for minimum number of threads in server thread pool. Notice that both a min and max size must be configured. */ + @Metadata(description = "To set a value for minimum number of threads in server thread pool. Notice that both a min and max size must be configured.") public void setMinThreads(Integer minThreads) { this.minThreads = minThreads; } @@ -740,6 +750,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * To set a value for maximum number of threads in server thread pool. Notice that both a min and max size must be configured. */ + @Metadata(description = "To set a value for maximum number of threads in server thread pool. Notice that both a min and max size must be configured.") public void setMaxThreads(Integer maxThreads) { this.maxThreads = maxThreads; } @@ -751,6 +762,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * To use a custom thread pool for the server. This option should only be used in special circumstances. */ + @Metadata(description = "To use a custom thread pool for the server. This option should only be used in special circumstances.") public void setThreadPool(ThreadPool threadPool) { this.threadPool = threadPool; } @@ -762,6 +774,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * If this option is true, Jetty JMX support will be enabled for this endpoint. */ + @Metadata(description = "If this option is true, Jetty JMX support will be enabled for this endpoint.") public void setEnableJmx(boolean enableJmx) { this.enableJmx = enableJmx; } @@ -773,6 +786,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * To use a custom org.apache.camel.component.jetty.JettyHttpBinding, which are used to customize how a response should be written for the producer. */ + @Metadata(description = "To use a custom org.apache.camel.component.jetty.JettyHttpBinding, which are used to customize how a response should be written for the producer.") public void setJettyHttpBinding(JettyHttpBinding jettyHttpBinding) { this.jettyHttpBinding = jettyHttpBinding; } @@ -802,6 +816,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * To use a existing configured org.eclipse.jetty.jmx.MBeanContainer if JMX is enabled that Jetty uses for registering mbeans. */ + @Metadata(description = "To use a existing configured org.eclipse.jetty.jmx.MBeanContainer if JMX is enabled that Jetty uses for registering mbeans.") public void setMbContainer(MBeanContainer mbContainer) { this.mbContainer = mbContainer; } @@ -813,6 +828,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * A map which contains general SSL connector properties. */ + @Metadata(description = "A map which contains general SSL connector properties.") public void setSslSocketConnectorProperties(Map<String, Object> sslSocketConnectorProperties) { this.sslSocketConnectorProperties = sslSocketConnectorProperties; } @@ -824,6 +840,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * A map which contains general HTTP connector properties. Uses the same principle as sslSocketConnectorProperties. */ + @Metadata(description = "A map which contains general HTTP connector properties. Uses the same principle as sslSocketConnectorProperties.") public void setSocketConnectorProperties(Map<String, Object> socketConnectorProperties) { this.socketConnectorProperties = socketConnectorProperties; } @@ -852,6 +869,10 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo * If a timeout occurs then the request will be expired and Jetty will return back a http error 503 to the client. * This option is only in use when using Jetty with the Asynchronous Routing Engine. */ + @Metadata(description = "Allows to set a timeout in millis when using Jetty as consumer (server)." + + " By default Jetty uses 30000. You can use a value of <= 0 to never expire." + + " If a timeout occurs then the request will be expired and Jetty will return back a http error 503 to the client." + + " This option is only in use when using Jetty with the Asynchronous Routing Engine.") public void setContinuationTimeout(Long continuationTimeout) { this.continuationTimeout = continuationTimeout; } @@ -863,6 +884,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * Whether or not to use Jetty continuations for the Jetty Server. */ + @Metadata(description = "Whether or not to use Jetty continuations for the Jetty Server.") public void setUseContinuation(boolean useContinuation) { this.useContinuation = useContinuation; } @@ -874,6 +896,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * To configure security using SSLContextParameters */ + @Metadata(description = "To configure security using SSLContextParameters") public void setSslContextParameters(SSLContextParameters sslContextParameters) { this.sslContextParameters = sslContextParameters; } @@ -885,6 +908,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * Allows to configure a custom value of the response buffer size on the Jetty connectors. */ + @Metadata(description = "Allows to configure a custom value of the response buffer size on the Jetty connectors.") public void setResponseBufferSize(Integer responseBufferSize) { this.responseBufferSize = responseBufferSize; } @@ -896,6 +920,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * Allows to configure a custom value of the request buffer size on the Jetty connectors. */ + @Metadata(description = "Allows to configure a custom value of the request buffer size on the Jetty connectors.") public void setRequestBufferSize(Integer requestBufferSize) { this.requestBufferSize = requestBufferSize; } @@ -907,6 +932,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * Allows to configure a custom value of the request header size on the Jetty connectors. */ + @Metadata(description = "Allows to configure a custom value of the request header size on the Jetty connectors.") public void setRequestHeaderSize(Integer requestHeaderSize) { this.requestHeaderSize = requestHeaderSize; } @@ -918,6 +944,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * Allows to configure a custom value of the response header size on the Jetty connectors. */ + @Metadata(description = "Allows to configure a custom value of the response header size on the Jetty connectors.") public void setResponseHeaderSize(Integer responseHeaderSize) { this.responseHeaderSize = responseHeaderSize; } @@ -929,6 +956,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * To use a http proxy to configure the hostname. */ + @Metadata(description = "To use a http proxy to configure the hostname.") public void setProxyHost(String proxyHost) { this.proxyHost = proxyHost; } @@ -940,6 +968,7 @@ public abstract class JettyHttpComponent extends HttpComponent implements RestCo /** * To use a http proxy to configure the port number. */ + @Metadata(description = "To use a http proxy to configure the port number.") public void setProxyPort(Integer proxyPort) { this.proxyPort = proxyPort; }
