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

/**
 * 
 * Apply @{@link Rest} on an interface to create a RestService class that will
 * contain implementation of rest calls related to the methods you define in the
 * interface.
 * 
 * 
 * You should then inject your RestService class by using {@link RestService}
 * annotation in any enhanced classes.
 * 
 * 
 * Note: Implementation is based on Spring Android Rest-template library. So you MUST have the
 * library in your classpath and we highly recommend you to take some time to
 * read this document and understand how the library works.
 * 
 * 
 * 
 * Example :
 * 
 *  * @Rest(rootUrl = "http://myserver", converters = MappingJacksonHttpMessageConverter.class)
 * public interface MyRestClient {
 * 
 * 	@Get("/events/{id}")
 * 	Event getEvent(long id);
 * 
 * 	@Post("/events/new")
 * 	void newEvent(@Body Event event);
 * }
 * 
 * @EBean
 * public class MyBean {
 * 
 * 	@RestService
 * 	MyRestClient myRestClient;
 *
 * 	@RestService
 * 	void singleInjection2(MyRestClient myRestClient) {
 * 		// do stuff
 * 	}
 *
 * 	void multiInjection(@RestService MyRestClient myRestClient, @RestService AnotherRestClient anotherRestClient) {
 * 		// do stuff
 * 	}
 *
 * 	public void getEvent(long id) {
 * 		return myRestClient.getEvent(id);
 * 	}
 * }
 * 
 * 
 * 
 * 
 * @see Rest
 */
@Retention(RetentionPolicy.CLASS)
@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER })
public @interface RestService {
}