com.github.mkopylec.charon.configuration.CharonProperties Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of charon-spring-boot-starter Show documentation
Show all versions of charon-spring-boot-starter Show documentation
Reverse proxy implementation in form of Spring Boot starter.
package com.github.mkopylec.charon.configuration;
import java.util.ArrayList;
import java.util.List;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.springframework.boot.context.properties.ConfigurationProperties;
import static org.apache.commons.lang3.builder.ToStringStyle.NO_CLASS_NAME_STYLE;
import static org.springframework.core.Ordered.LOWEST_PRECEDENCE;
/**
* Charon configuration properties.
*/
@ConfigurationProperties("charon")
public class CharonProperties {
/**
* Charon servlet filter order.
*/
private int filterOrder = LOWEST_PRECEDENCE;
/**
* Properties responsible for timeouts while forwarding HTTP requests.
*/
private Timeout timeout = new Timeout();
/**
* Properties responsible for retrying of HTTP requests forwarding.
*/
private Retrying retrying = new Retrying();
/**
* Properties responsible for collecting metrics during HTTP requests forwarding.
*/
private Metrics metrics = new Metrics();
/**
* Properties responsible for proxy mappings updates.
*/
private MappingsUpdate mappingsUpdate = new MappingsUpdate();
/**
* Properties responsible for tracing HTTP requests proxying processes.
*/
private Tracing tracing = new Tracing();
/**
* List of proxy mappings.
*/
private List mappings = new ArrayList<>();
public int getFilterOrder() {
return filterOrder;
}
public void setFilterOrder(int filterOrder) {
this.filterOrder = filterOrder;
}
public Timeout getTimeout() {
return timeout;
}
public void setTimeout(Timeout timeout) {
this.timeout = timeout;
}
public Retrying getRetrying() {
return retrying;
}
public void setRetrying(Retrying retrying) {
this.retrying = retrying;
}
public Metrics getMetrics() {
return metrics;
}
public void setMetrics(Metrics metrics) {
this.metrics = metrics;
}
public MappingsUpdate getMappingsUpdate() {
return mappingsUpdate;
}
public void setMappingsUpdate(MappingsUpdate mappingsUpdate) {
this.mappingsUpdate = mappingsUpdate;
}
public Tracing getTracing() {
return tracing;
}
public void setTracing(Tracing tracing) {
this.tracing = tracing;
}
public List getMappings() {
return mappings;
}
public void setMappings(List mappings) {
this.mappings = mappings;
}
public static class Timeout {
/**
* Connect timeout for HTTP requests forwarding.
*/
private int connect = 500;
/**
* Read timeout for HTTP requests forwarding.
*/
private int read = 2000;
public int getConnect() {
return connect;
}
public void setConnect(int connect) {
this.connect = connect;
}
public int getRead() {
return read;
}
public void setRead(int read) {
this.read = read;
}
}
public static class Retrying {
public static final String MAPPING_NAME_RETRY_ATTRIBUTE = "mapping-name";
/**
* Maximum number of HTTP request forward tries.
*/
private int maxAttempts = 1;
public int getMaxAttempts() {
return maxAttempts;
}
public void setMaxAttempts(int maxAttempts) {
this.maxAttempts = maxAttempts;
}
}
public static class Metrics {
/**
* Flag for enabling and disabling collecting metrics during HTTP requests forwarding.
*/
private boolean enabled = false;
/**
* Global metrics names prefix.
*/
private String namesPrefix = "charon";
/**
* Properties responsible for logging collected metrics.
*/
private LoggingReporter loggingReporter = new LoggingReporter();
public boolean isEnabled() {
return enabled;
}
public void setEnabled(boolean enabled) {
this.enabled = enabled;
}
public String getNamesPrefix() {
return namesPrefix;
}
public void setNamesPrefix(String namesPrefix) {
this.namesPrefix = namesPrefix;
}
public LoggingReporter getLoggingReporter() {
return loggingReporter;
}
public void setLoggingReporter(LoggingReporter loggingReporter) {
this.loggingReporter = loggingReporter;
}
public static class LoggingReporter {
/**
* Flag for enabling and disabling reporting metrics via application logger.
*/
private boolean enabled = false;
/**
* Metrics reporting via logger interval in seconds.
*/
private int reportingIntervalInSeconds = 60;
public boolean isEnabled() {
return enabled;
}
public void setEnabled(boolean enabled) {
this.enabled = enabled;
}
public int getReportingIntervalInSeconds() {
return reportingIntervalInSeconds;
}
public void setReportingIntervalInSeconds(int reportingIntervalInSeconds) {
this.reportingIntervalInSeconds = reportingIntervalInSeconds;
}
}
}
public static class MappingsUpdate {
/**
* Flag for enabling and disabling triggering mappings updates on non-HTTP errors occurred during HTTP requests forwarding.
*/
private boolean enabled = false;
public boolean isEnabled() {
return enabled;
}
public void setEnabled(boolean enabled) {
this.enabled = enabled;
}
}
public static class Tracing {
/**
* Flag for enabling and disabling tracing HTTP requests proxying processes.
*/
private boolean enabled = false;
public boolean isEnabled() {
return enabled;
}
public void setEnabled(boolean enabled) {
this.enabled = enabled;
}
}
public static class Mapping {
/**
* Name of the mapping.
*/
private String name;
/**
* Path for mapping incoming HTTP requests URIs.
*/
private String path = "/";
/**
* List of destination hosts where HTTP requests will be forwarded.
*/
private List destinations = new ArrayList<>();
/**
* Flag for enabling and disabling asynchronous HTTP request forwarding.
*/
private boolean asynchronous = false;
/**
* Flag for enabling and disabling mapped path stripping from forwarded request URI.
*/
private boolean stripPath = true;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getPath() {
return path;
}
public void setPath(String path) {
this.path = path;
}
public List getDestinations() {
return destinations;
}
public void setDestinations(List destinations) {
this.destinations = destinations;
}
public boolean isAsynchronous() {
return asynchronous;
}
public void setAsynchronous(boolean asynchronous) {
this.asynchronous = asynchronous;
}
public boolean isStripPath() {
return stripPath;
}
public void setStripPath(boolean stripPath) {
this.stripPath = stripPath;
}
public Mapping copy() {
Mapping clone = new Mapping();
clone.setName(name);
clone.setPath(path);
clone.setDestinations(destinations == null ? null : new ArrayList<>(destinations));
clone.setAsynchronous(asynchronous);
clone.setStripPath(stripPath);
return clone;
}
@Override
public String toString() {
return new ToStringBuilder(this, NO_CLASS_NAME_STYLE)
.append("name", name)
.append("path", path)
.append("destinations", destinations)
.append("asynchronous", asynchronous)
.append("stripPath", stripPath)
.toString();
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy