Skip to content
This repository was archived by the owner on Feb 26, 2023. It is now read-only.

Expand some @Rest doc #1458

Merged
yDelouis merged 1 commit into from
Jun 10, 2015
Merged

Expand some @Rest doc #1458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions ...ons-api/src/main/java/org/androidannotations/annotations/rest/RequiresAuthentication.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,12 @@
* .
* </p>
* <p>
* You can also add this specific method for <a
* You can also add a specific method for <a
* href="https://en.wikipedia.org/wiki/Basic_access_authentication">Basic
* Authentication</a> :
* <code>setHttpBasicAuth(String username, String password)</code>.
* <code>setHttpBasicAuth(String username, String password)</code> or <a
* href="https://tools.ietf.org/html/rfc6750" >Bearer (OAuth) authentication</a>
* : <code>setBearerAuth(String token)</code>.
* </p>
* <blockquote>
*
Expand Down
2 changes: 2 additions & 0 deletions ...nnotations-api/src/main/java/org/androidannotations/api/rest/RestClientErrorHandling.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
/**
* A @Rest interface implementing this interface will automatically have the
* implementations of this method generated.
*
* @see org.androidannotations.annotations.rest.Rest
*/
public interface RestClientErrorHandling {
/**
Expand Down
19 changes: 19 additions & 0 deletions ...droidannotations-api/src/main/java/org/androidannotations/api/rest/RestClientHeaders.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@
/**
* A @Rest interface implementing this interface will automatically have the
* implementations of these methods generated.
*
* @see org.androidannotations.annotations.rest.Rest
* @see org.androidannotations.annotations.rest.RequiresCookie
* @see org.androidannotations.annotations.rest.RequiresHeader
* @see org.androidannotations.annotations.rest.RequiresAuthentication
*/
public interface RestClientHeaders {

Expand All @@ -29,6 +34,8 @@ public interface RestClientHeaders {
* @param name
* Name of the cookie
* @return the cookie value.
*
* @see org.androidannotations.annotations.rest.RequiresCookie
*/
String getCookie(String name);

Expand All @@ -39,6 +46,8 @@ public interface RestClientHeaders {
* Name of the cookie
* @param value
* Value of the cookie
*
* @see org.androidannotations.annotations.rest.RequiresCookie
*/
void setCookie(String name, String value);

Expand All @@ -48,6 +57,8 @@ public interface RestClientHeaders {
* @param name
* Name of the header
* @return the header value.
*
* @see org.androidannotations.annotations.rest.RequiresHeader
*/
String getHeader(String name);

Expand All @@ -58,6 +69,8 @@ public interface RestClientHeaders {
* Name of the header
* @param value
* Value of the header
*
* @see org.androidannotations.annotations.rest.RequiresHeader
*/
void setHeader(String name, String value);

Expand All @@ -66,6 +79,8 @@ public interface RestClientHeaders {
*
* @param auth
* Authentication data
*
* @see org.androidannotations.annotations.rest.RequiresAuthentication
*/
void setAuthentication(HttpAuthentication auth);

Expand All @@ -76,6 +91,8 @@ public interface RestClientHeaders {
* Name of the user
* @param password
* Password of the user
*
* @see org.androidannotations.annotations.rest.RequiresAuthentication
*/
void setHttpBasicAuth(String user, String password);

Expand All @@ -84,6 +101,8 @@ public interface RestClientHeaders {
*
* @param token
* Token used for authentication
*
* @see org.androidannotations.annotations.rest.RequiresAuthentication
*/
void setBearerAuth(String token);
}
2 changes: 2 additions & 0 deletions ...droidannotations-api/src/main/java/org/androidannotations/api/rest/RestClientRootUrl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
/**
* A @Rest interface implementing this interface will automatically have the
* implementations of these methods generated.
*
* @see org.androidannotations.annotations.rest.Rest
*/
public interface RestClientRootUrl {
/**
Expand Down
2 changes: 2 additions & 0 deletions ...droidannotations-api/src/main/java/org/androidannotations/api/rest/RestClientSupport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
/**
* A @Rest interface implementing this interface will automatically have the
* implementations of these methods generated.
*
* @see org.androidannotations.annotations.rest.Rest
*/
public interface RestClientSupport {
/**
Expand Down