Package com.logicaldoc.webservice.soap
Interface AuthService
-
- All Known Implementing Classes:
RestAuthService
,RestAuthSwagger
,SoapAuthClient
,SoapAuthService
public interface AuthService
Auth Web Service definition interface- Since:
- 5.2
- Author:
- Matteo Caruso - LogicalDOC
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
login(String username, String password)
Starts a new session.void
logout(String sid)
Closes a session.void
renew(String sid)
Renews a sessionboolean
valid(String sid)
Checks if a SID is valid
-
-
-
Method Detail
-
login
String login(String username, String password) throws Exception
Starts a new session.- Parameters:
username
- The usernamepassword
- The password- Returns:
- The newly created session identifier(sid)
- Throws:
Exception
- error in the server application
-
logout
void logout(String sid)
Closes a session.- Parameters:
sid
- The session identifier
-
valid
boolean valid(String sid)
Checks if a SID is valid- Parameters:
sid
- identifier of the session- Returns:
- if the session is valid
-
renew
void renew(String sid)
Renews a session- Parameters:
sid
- identifier of the session
-
-