SoapAuthService (logicaldoc 8.5.0 API)

java.lang.Object
- com.logicaldoc.webservice.AbstractService
- - com.logicaldoc.webservice.soap.endpoint.SoapAuthService

All Implemented Interfaces:

AuthService

Direct Known Subclasses:

RestAuthService
```
public class SoapAuthService
extends AbstractService
implements AuthService
```
Auth Web Service Implementation (SOAP)

Since:

5.2

Author:

Matteo Caruso - LogicalDOC

Constructor Summary

Constructors
Constructor Description

SoapAuthService()

Method Summary

All Methods Instance Methods Concrete 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

Methods inherited from class com.logicaldoc.webservice.AbstractService
convertDateToString, convertStringToDate, getContext, getMessageContext, isValidateSession, setContext, setMessageContext, setValidateSession

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SoapAuthService
```
public SoapAuthService()
```
- Method Detail
  - login
```
public String login(String username,
                    String password)
             throws Exception
```
    Description copied from interface: AuthService
    
    Starts a new session.
    
    Specified by:
    
    login in interface AuthService
    
    Parameters:
    
    username - The username
    
    password - The password
    
    Returns:
    
    The newly created session identifier(sid)
    
    Throws:
    
    Exception - error in the server application
  - logout
```
public void logout(String sid)
```
    Description copied from interface: AuthService
    
    Closes a session.
    
    Specified by:
    
    logout in interface AuthService
    
    Parameters:
    
    sid - The session identifier
  - valid
```
public boolean valid(String sid)
```
    Description copied from interface: AuthService
    
    Checks if a SID is valid
    
    Specified by:
    
    valid in interface AuthService
    
    Parameters:
    
    sid - identifier of the session
    
    Returns:
    
    if the session is valid
  - renew
```
public void renew(String sid)
```
    Description copied from interface: AuthService
    
    Renews a session
    
    Specified by:
    
    renew in interface AuthService
    
    Parameters:
    
    sid - identifier of the session