org.androidannotations.rest.spring.annotations.RequiresHeader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-spring-api Show documentation

The API jar containing the annotations

The newest version!

/**
 * Copyright (C) 2010-2016 eBusiness Information, Excilys Group
 *
 * 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 org.androidannotations.rest.spring.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 
 * Use on {@link Get}, {@link Post}, … annotated methods to inject a header in
 * the request.
 * 
 * 
 * The annotation {@link #value()} is mandatory and define the header's name you
 * want to inject.
 * 
 * 
 * To set a header's value you MUST either let your RestClient interface extends
 * of {@link org.androidannotations.rest.spring.api.RestClientHeaders
 * RestClientHeaders} or add the following method to your interface :
 * void setHeader(String name, String value).
 * 
 * 
 * You can also add the getter version to read a header value :
 * void getHeader(String name).
 * 
 * 
 * 
 * Example :
 * 
 *  * @Rest(rootUrl = "http://myserver", converters = MappingJacksonHttpMessageConverter.class)
 * public interface MyRestClient {
 * 
 * 	@Get("/events/{id}")
 * 	@RequiresHeader("myHeader")
 * 	Event getEvent(long id);
 * 
 * 	void setHeader(String name, String value);
 * 
 * 	String getHeader(String name);
 * }
 * 
 * @EBean
 * public class MyBean {
 * 
 * 	@RestService MyRestClient;
 * 
 * 	@AfterInject
 * 	public void init() {
 * 		myRestClient.setHeader("myHeader", "myValue");
 * 	}
 * }
 * 
 * 
 * 
 * 
 * @see Rest
 * @see Get
 * @see Post
 * @see Put
 * @see Delete
 * @see Head
 * @see Options
 */
@Retention(RetentionPolicy.CLASS)
@Target({ ElementType.METHOD, ElementType.TYPE })
public @interface RequiresHeader {

	/**
	 * The names of the headers.
	 * 
	 * @return the header names
	 */
	String[] value();
}