org.androidannotations.rest.spring.api

Interface RestClientHeaders

public interface RestClientHeaders

A @Rest interface implementing this interface will automatically have the implementations of these methods generated.

See Also:

Rest, RequiresCookie, RequiresHeader, RequiresAuthentication

Method Summary

Modifier and Type	Method and Description
String	getCookie(String name) Gets a cookie by name.
String	getHeader(String name) Gets a header by name.
void	setAuthentication(org.springframework.http.HttpAuthentication auth) Sets the authentication object.
void	setBearerAuth(String token) Sets the Authorization: Bearer header as documented in RFC6750
void	setCookie(String name, String value) Sets a cookie by name.
void	setHeader(String name, String value) Sets a header by name.
void	setHttpBasicAuth(String user, String password) Sets the basic authentication user/password.

Method Detail

getCookie

String getCookie(String name)

Gets a cookie by name.

Parameters:

name - Name of the cookie

Returns:

the cookie value.

See Also:

RequiresCookie

setCookie

void setCookie(String name,
               String value)

Sets a cookie by name.

Parameters:

name - Name of the cookie

value - Value of the cookie

See Also:

RequiresCookie

getHeader

String getHeader(String name)

Gets a header by name.

Parameters:

name - Name of the header

Returns:

the header value.

See Also:

RequiresHeader

setHeader

void setHeader(String name,
               String value)

Sets a header by name.

Parameters:

name - Name of the header

value - Value of the header

See Also:

RequiresHeader

setAuthentication

void setAuthentication(org.springframework.http.HttpAuthentication auth)

Sets the authentication object.

Parameters:

auth - Authentication data

See Also:

RequiresAuthentication

setHttpBasicAuth

void setHttpBasicAuth(String user,
                      String password)

Sets the basic authentication user/password.

Parameters:

user - Name of the user

password - Password of the user

See Also:

RequiresAuthentication

setBearerAuth

void setBearerAuth(String token)

Sets the Authorization: Bearer header as documented in RFC6750

Parameters:

token - Token used for authentication

See Also:

RequiresAuthentication