org.springframework.boot.actuate.trace.http.Include Maven / Gradle / Ivy
/*
* Copyright 2012-2018 the original author or authors.
*
* Licensed 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
*
* https://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.springframework.boot.actuate.trace.http;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Set;
/**
* Include options for HTTP tracing.
*
* @author Wallace Wadge
* @since 2.0.0
*/
public enum Include {
/**
* Include request headers.
*/
REQUEST_HEADERS,
/**
* Include response headers.
*/
RESPONSE_HEADERS,
/**
* Include "Cookie" header (if any) in request headers and "Set-Cookie" (if any) in
* response headers.
*/
COOKIE_HEADERS,
/**
* Include authorization header (if any).
*/
AUTHORIZATION_HEADER,
/**
* Include the principal.
*/
PRINCIPAL,
/**
* Include the remote address.
*/
REMOTE_ADDRESS,
/**
* Include the session ID.
*/
SESSION_ID,
/**
* Include the time taken to service the request in milliseconds.
*/
TIME_TAKEN;
private static final Set DEFAULT_INCLUDES;
static {
Set defaultIncludes = new LinkedHashSet<>();
defaultIncludes.add(Include.REQUEST_HEADERS);
defaultIncludes.add(Include.RESPONSE_HEADERS);
defaultIncludes.add(Include.COOKIE_HEADERS);
defaultIncludes.add(Include.TIME_TAKEN);
DEFAULT_INCLUDES = Collections.unmodifiableSet(defaultIncludes);
}
/**
* Return the default {@link Include}.
* @return the default include.
*/
public static Set defaultIncludes() {
return DEFAULT_INCLUDES;
}
}