Package com.logicaldoc.webservice.soap.endpoint

Class SoapAuthService

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

Modifier and Type	Method	Description
String	login(String username, String password)	Starts a new session.
String	loginApiKey(String apiKey)	Starts a new session.
void	logout(String sidOrApiKey)	Closes a session.
void	renew(String sidOrApiKey)	Renews a session
boolean	valid(String sidOrApiKey)	Checks if a SID is 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

SoapAuthService

public SoapAuthService()

Method Details

login

public String login(String username,
 String password)
             throws AuthenticationException

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:

AuthenticationException - the user was not authenticated

loginApiKey

public String loginApiKey(String apiKey)
                   throws AuthenticationException

Description copied from interface: AuthService

Starts a new session.

Specified by:

loginApiKey in interface AuthService

Parameters:

apiKey - The API Key

Returns:

The newly created session identifier(sid)

Throws:

AuthenticationException - the user was not authenticated

logout

public void logout(String sidOrApiKey)

Description copied from interface: AuthService

Closes a session.

Specified by:

logout in interface AuthService

Parameters:

sidOrApiKey - identifier of the session or an API Key

valid

public boolean valid(String sidOrApiKey)

Description copied from interface: AuthService

Checks if a SID is valid

Specified by:

valid in interface AuthService

Parameters:

sidOrApiKey - identifier of the session or an API Key

Returns:

if the session is valid

renew

public void renew(String sidOrApiKey)

Description copied from interface: AuthService

Renews a session

Specified by:

renew in interface AuthService

Parameters:

sidOrApiKey - identifier of the session or an API Key