Package com.logicaldoc.webservice.rest.endpoint

Class RestAuthService

java.lang.Object

com.logicaldoc.webservice.AbstractService

com.logicaldoc.webservice.soap.endpoint.SoapAuthService

com.logicaldoc.webservice.rest.endpoint.RestAuthService

All Implemented Interfaces:

AuthService, AuthService

Direct Known Subclasses:

RestAuthSwagger

@Path("/")
@Consumes({"application/xml","application/json"})
@Produces("application/json")
public class RestAuthService
extends SoapAuthService
implements AuthService

Constructor Summary

Constructors

Constructor	Description
RestAuthService()

Method Summary

Modifier and Type	Method	Description
String	getSid()
String	login(String username, String password)	Starts a new session.
String	loginApiKey(String apikey)	Starts a new session.
String	loginForm(String username, String password)
String	loginPostJSON(WSCredentials cred)
void	logout(String sid)	Closes a session.
void	renew()	Renews the current session
void	renew(String sid)	Renews a session

Methods inherited from class com.logicaldoc.webservice.soap.endpoint.SoapAuthService

valid

Methods inherited from class com.logicaldoc.webservice.AbstractService

convertDateToString, convertStringToDate, getCurrentMessage, isValidateSession, setCurrentMessage, setValidateSession

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RestAuthService

public RestAuthService()

Method Details

login

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

Description copied from interface: AuthService

Starts a new session.

Specified by:

login in interface AuthService

Specified by:

login in interface AuthService

Overrides:

login in class SoapAuthService

Parameters:

username - The username

password - The password

Returns:

The newly created session identifier(sid)

Throws:

AuthenticationException - the user was not authenticated

loginForm

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

Specified by:

loginForm in interface AuthService

loginPostJSON

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

Specified by:

loginPostJSON in interface AuthService

loginApiKey

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

Description copied from interface: AuthService

Starts a new session.

Specified by:

loginApiKey in interface AuthService

Specified by:

loginApiKey in interface AuthService

Overrides:

loginApiKey in class SoapAuthService

Parameters:

apikey - The API Key

Returns:

The newly created session identifier(sid)

logout

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

Description copied from interface: AuthService

Closes a session.

Specified by:

logout in interface AuthService

Specified by:

logout in interface AuthService

Overrides:

logout in class SoapAuthService

Parameters:

sid - identifier of the session or an API Key

getSid

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

Specified by:

getSid in interface AuthService

renew

@GET
@Path("/renew")
public void renew(@QueryParam("sid")
 String sid)

Renews a session

Specified by:

renew in interface AuthService

Overrides:

renew in class SoapAuthService

Parameters:

sid - identifier of the session

renew

@GET
@Path("/renewcurrent")
public void renew()

Renews the current session