Package com.logicaldoc.webservice.rest

Interface AuthService

All Known Implementing Classes:

RestAuthClient, RestAuthService, RestAuthSwagger

@Consumes({"application/xml","application/json"})
@Produces("application/json")
public interface AuthService

Auth Web Service definition interface for Rest Services

Since:

7.5

Author:

Alessandro Gasparini - LogicalDOC

Method Summary

Modifier and Type	Method	Description
String	getSid()
String	login(String username, String password)
String	loginApiKey(String apiKey)
String	loginForm(String username, String password)
String	loginPostJSON(WSCredentials wscred)
void	logout(String sid)

Method Details

login

@GET
@Path("/login")
String login(@QueryParam("u")
 String username,
 @QueryParam("pw")
 String password)

loginApiKey

@GET
@Path("/loginApiKey")
String loginApiKey(@HeaderParam("X-API-KEY")
 String apiKey)

loginForm

@POST
@Path("/loginForm")
@Consumes("application/x-www-form-urlencoded")
String loginForm(@FormParam("username")
 String username,
 @FormParam("password")
 String password)

loginPostJSON

@POST
@Path("/login")
@Consumes("application/json")
String loginPostJSON(WSCredentials wscred)

logout

@DELETE
@Path("/logout")
void logout(@QueryParam("sid")
 String sid)

getSid

@GET
@Path("/getSid")
@Produces({"application/json","text/plain"})
String getSid()