AuthService (logicaldoc 8.8.3 API)

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 session
`boolean`	`valid(String sid)`	Checks if a SID is valid

- Method Detail
  - login
```
String login(String username,
             String password)
      throws AuthenticationException
```
    Starts a new session.
    
    Parameters:
    
    username - The username
    
    password - The password
    
    Returns:
    
    The newly created session identifier(sid)
    
    Throws:
    
    AuthenticationException - the user was not authenticated
  - 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