org.apache.camel.RuntimeConfiguration Maven / Gradle / Ivy
/*
* 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.
*/
package org.apache.camel;
/**
* Various runtime configuration options used by {@link org.apache.camel.CamelContext} and {@link Route}
* for cross cutting functions such as tracing, delayer, stream cache and the like.
*/
public interface RuntimeConfiguration {
/**
* Sets whether stream caching is enabled or not (default is disabled).
*
* @param cache whether stream caching is enabled or not
*/
void setStreamCaching(Boolean cache);
/**
* Returns whether stream cache is enabled
*
* @return true if stream cache is enabled
*/
Boolean isStreamCaching();
/**
* Sets whether tracing is enabled or not (default is disabled).
*
* @param tracing whether to enable tracing.
*/
void setTracing(Boolean tracing);
/**
* Returns whether tracing enabled
*
* To use tracing then this must be enabled on startup to be installed in the CamelContext.
*
* @return true if tracing is enabled
*/
Boolean isTracing();
/**
* Tracing pattern to match which node EIPs to trace.
* For example to match all To EIP nodes, use to*.
* The pattern matches by node and route id's
* Multiple patterns can be separated by comma.
*/
String getTracingPattern();
/**
* Tracing pattern to match which node EIPs to trace.
* For example to match all To EIP nodes, use to*.
* The pattern matches by node and route id's
* Multiple patterns can be separated by comma.
*/
void setTracingPattern(String tracePattern);
/**
* Sets whether backlog tracing is enabled or not (default is disabled).
*
* To use backlog tracing then this must be enabled on startup to be installed in the CamelContext.
*
* @param backlogTrace whether to enable backlog tracing.
* @see #setTracing(Boolean)
*/
void setBacklogTracing(Boolean backlogTrace);
/**
* Returns whether backlog tracing is enabled.
*
* @return true if backlog tracing is enabled
*/
Boolean isBacklogTracing();
/**
* Sets whether debugging (will use backlog if no custom debugger has been configured)
* is enabled or not (default is disabled).
*
* To use debugging then this must be enabled on startup to be installed in the CamelContext.
*
* @param debugging whether to enable debugging.
*/
void setDebugging(Boolean debugging);
/**
* Returns whether debugging is enabled.
*
* @return true if debugging is enabled
*/
Boolean isDebugging();
/**
* Sets whether message history is enabled or not (default is disabled).
*
* @param messageHistory whether message history is enabled
*/
void setMessageHistory(Boolean messageHistory);
/**
* Returns whether message history is enabled
*
* @return true if message history is enabled
*/
Boolean isMessageHistory();
/**
* Sets whether security mask for Logging is enabled or not (default is disabled).
*
* @param logMask true if mask is enabled
*/
void setLogMask(Boolean logMask);
/**
* Gets whether security mask for Logging is enabled or not.
*
* @return true if mask is enabled
*/
Boolean isLogMask();
/**
* Sets whether to log exhausted message body with message history.
*
* @param logExhaustedMessageBody whether message body should be logged
*/
void setLogExhaustedMessageBody(Boolean logExhaustedMessageBody);
/**
* Returns whether to log exhausted message body with message history.
*
* @return true if logging of message body is enabled
*/
Boolean isLogExhaustedMessageBody();
/**
* Sets a delay value in millis that a message is delayed at every step it takes in the route path,
* slowing the process down to better observe what is occurring
*
* Is disabled by default
*
* @param delay delay in millis
*/
void setDelayer(Long delay);
/**
* Gets the delay value
*
* @return delay in millis, or null if disabled
*/
Long getDelayer();
/**
* Sets whether the object should automatically start when Camel starts.
*
* Important: Currently only routes can be disabled, as {@link CamelContext}s are always started.
*
* Note: When setting auto startup false on {@link CamelContext} then that takes precedence
* and no routes is started. You would need to start {@link CamelContext} explicit using
* the {@link org.apache.camel.CamelContext#start()} method, to start the context, and then
* you would need to start the routes manually using {@link org.apache.camel.spi.RouteController#startRoute(String)}.
*
* Default is true to always start up.
*
* @param autoStartup whether to start up automatically.
*/
void setAutoStartup(Boolean autoStartup);
/**
* Gets whether the object should automatically start when Camel starts.
*
* Important: Currently only routes can be disabled, as {@link CamelContext}s are always started.
*
* Default is true to always start up.
*
* @return true if object should automatically start
*/
Boolean isAutoStartup();
/**
* Sets the ShutdownRoute option for routes.
*
* @param shutdownRoute the option to use.
*/
void setShutdownRoute(ShutdownRoute shutdownRoute);
/**
* Gets the option to use when shutting down the route.
*
* @return the option
*/
ShutdownRoute getShutdownRoute();
/**
* Sets the ShutdownRunningTask option to use when shutting down a route.
*
* @param shutdownRunningTask the option to use.
*/
void setShutdownRunningTask(ShutdownRunningTask shutdownRunningTask);
/**
* Gets the ShutdownRunningTask option in use when shutting down a route.
*
* @return the option
*/
ShutdownRunningTask getShutdownRunningTask();
/**
* Sets whether to allow access to the original message from Camel's error handler,
* or from {@link org.apache.camel.spi.UnitOfWork#getOriginalInMessage()}.
*
* Turning this off can optimize performance, as defensive copy of the original message is not needed.
*
* @param allowUseOriginalMessage the option to use.
*/
void setAllowUseOriginalMessage(Boolean allowUseOriginalMessage);
/**
* Gets whether access to the original message from Camel's error handler,
* or from {@link org.apache.camel.spi.UnitOfWork#getOriginalInMessage()} is allowed.
*
* @return the option
*/
Boolean isAllowUseOriginalMessage();
/**
* Whether to use case sensitive or insensitive headers.
*
* Important: When using case sensitive (this is set to false).
* Then the map is case sensitive which means headers such as content-type and Content-Type are
* two different keys which can be a problem for some protocols such as HTTP based, which rely on case insensitive headers.
* However case sensitive implementations can yield faster performance. Therefore use case sensitive implementation with care.
*/
Boolean isCaseInsensitiveHeaders();
/**
* Whether to use case sensitive or insensitive headers.
*
* Important: When using case sensitive (this is set to false).
* Then the map is case sensitive which means headers such as content-type and Content-Type are
* two different keys which can be a problem for some protocols such as HTTP based, which rely on case insensitive headers.
* However case sensitive implementations can yield faster performance. Therefore use case sensitive implementation with care.
*/
void setCaseInsensitiveHeaders(Boolean caseInsensitiveHeaders);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy