com.hpe.caf.autoscale.endpoint.Headers Maven / Gradle / Ivy
/*
* Copyright 2015-2018 Micro Focus or one of its affiliates.
*
* 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
*
* 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 com.hpe.caf.autoscale.endpoint;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Expands headers supplied in the {@code value}. Variables are permitted as values.
*
* @Headers("Content-Type: application/xml")
* interface SoapApi {
* ...
* @RequestLine(action="GET" request="/")
* @Headers("Cache-Control: max-age=640000")
* ...
*
* @RequestLine(action="POST" request="/")
* @Headers({
* "X-Foo: Bar",
* "X-Ping: {token}"
* }) void post(@Param("token") String token);
* ...
*
*
Note: Headers do not overwrite each other. All headers with the same name will be included in the request.
*
Relationship to JAXRS
The following two forms are identical.
Feign:
*
* @RequestLine(action="GET" request="/")
* @Headers({
* "X-Ping: {token}"
* }) void post(@Named("token") String token);
* ...
*
*
JAX-RS:
*
* @POST @Path("/")
* void post(@HeaderParam("X-Ping") String token);
* ...
*
*/
@Target({METHOD, TYPE})
@Retention(RUNTIME)
public @interface Headers
{
String[] value();
}