All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

There is a newer version: 4.8.0
Show 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 use authentication * on the request. *

*

* To set the current authentication object to use, 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 setAuthentication(org.springframework.http.HttpAuthentication auth) * . *

*

* You can also add a specific method for Basic * Authentication : * setHttpBasicAuth(String username, String password) or Bearer (OAuth) authentication * : setBearerAuth(String token). *

*
* * Example : * *
 * @Rest(rootUrl = "http://myserver", converters = MappingJacksonHttpMessageConverter.class)
 * public interface MyRestClient {
 * 
 * 	@Get("/events/{id}")
 * 	@RequiresAuthentication
 * 	Event getEvent(long id);
 * 
 * 	setHttpBasicAuth(String username, String password);
 * }
 * 
 * @EBean
 * public class MyBean {
 * 
 * 	@RestService MyRestClient;
 * 
 * 	@AfterInject
 * 	public void init() {
 * 		myRestClient.setHttpBasicAuth("user", "password");
 * 	}
 * }
 * 
* *
* * @see Rest * @see Get * @see Post * @see Put * @see Delete * @see Head * @see Options */ @Retention(RetentionPolicy.CLASS) @Target({ ElementType.METHOD, ElementType.TYPE }) public @interface RequiresAuthentication { }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy