org.androidannotations.rest.spring.annotations.SetsCookie 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

There is a newer version: 4.8.0

/**
 * 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 retrieve and store
 * cookies from the HTTP response.
 * 
 * 
 * The annotation {@link #value()} is mandatory and define a list of cookie's
 * names you want to keep.
 * 
 * 
 * Each stored cookies can be re-used with {@link RequiresCookie} and
 * {@link RequiresCookieInUrl} annotations. The getCookie method
 * will also be able to read these cookies.
 * 
 * 
 * 
 * Example :
 * 
 *  * @Rest(rootUrl = "http://myserver", converters = MappingJacksonHttpMessageConverter.class)
 * public interface MyRestClient {
 * 
 * 	@Get("/events/{id}")
 * 	@SetsCookie(("token"()
 * 	Event getEvent(long id);
 * 
 * 	@Put("/events/update/")
 * 	@RequiresCookie("token")
 * 	void updateEvent(@Body Event event);
 * }
 * 
 * 
 * 
 * 
 * @see Rest
 * @see RequiresCookie
 * @see SetsCookie
 */
@Retention(RetentionPolicy.CLASS)
@Target({ ElementType.METHOD, ElementType.TYPE })
public @interface SetsCookie {

	/**
	 * The names of the cookies to be kept.
	 * 
	 * @return the cookie names
	 */
	String[] value();
}