/*
* Copyright 2012-2019 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.endpoint.web;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import org.springframework.boot.actuate.endpoint.http.ActuatorMediaType;
import org.springframework.util.Assert;
Media types that are, by default, produced and consumed by an endpoint.
Author: Andy Wilkinson Since: 2.0.0
/**
* Media types that are, by default, produced and consumed by an endpoint.
*
* @author Andy Wilkinson
* @since 2.0.0
*/
public class EndpointMediaTypes {
private static final String JSON_MEDIA_TYPE = "application/json";
Default EndpointMediaTypes
for this version of Spring Boot. /**
* Default {@link EndpointMediaTypes} for this version of Spring Boot.
*/
public static final EndpointMediaTypes DEFAULT = new EndpointMediaTypes(ActuatorMediaType.V3_JSON,
ActuatorMediaType.V2_JSON, JSON_MEDIA_TYPE);
private final List<String> produced;
private final List<String> consumed;
Params: - producedAndConsumed – the default media types that are produced and consumed by an endpoint. Must not be
null
.
Since: 2.2.0
/**
* Creates a new {@link EndpointMediaTypes} with the given {@code produced} and
* {@code consumed} media types.
* @param producedAndConsumed the default media types that are produced and consumed
* by an endpoint. Must not be {@code null}.
* @since 2.2.0
*/
public EndpointMediaTypes(String... producedAndConsumed) {
this((producedAndConsumed != null) ? Arrays.asList(producedAndConsumed) : null);
}
Params: - producedAndConsumed – the default media types that are produced and consumed by an endpoint. Must not be
null
.
Since: 2.2.0
/**
* Creates a new {@link EndpointMediaTypes} with the given {@code produced} and
* {@code consumed} media types.
* @param producedAndConsumed the default media types that are produced and consumed
* by an endpoint. Must not be {@code null}.
* @since 2.2.0
*/
public EndpointMediaTypes(List<String> producedAndConsumed) {
this(producedAndConsumed, producedAndConsumed);
}
Params: - produced – the default media types that are produced by an endpoint. Must not be
null
. - consumed – the default media types that are consumed by an endpoint. Must not
/**
* Creates a new {@link EndpointMediaTypes} with the given {@code produced} and
* {@code consumed} media types.
* @param produced the default media types that are produced by an endpoint. Must not
* be {@code null}.
* @param consumed the default media types that are consumed by an endpoint. Must not
*/
public EndpointMediaTypes(List<String> produced, List<String> consumed) {
Assert.notNull(produced, "Produced must not be null");
Assert.notNull(consumed, "Consumed must not be null");
this.produced = Collections.unmodifiableList(produced);
this.consumed = Collections.unmodifiableList(consumed);
}
Returns the media types produced by an endpoint.
Returns: the produced media types
/**
* Returns the media types produced by an endpoint.
* @return the produced media types
*/
public List<String> getProduced() {
return this.produced;
}
Returns the media types consumed by an endpoint.
Returns: the consumed media types
/**
* Returns the media types consumed by an endpoint.
* @return the consumed media types
*/
public List<String> getConsumed() {
return this.consumed;
}
}