com.logicaldoc.webservice.auth

Class AuthClient

java.lang.Object

com.logicaldoc.webservice.AbstractClient<AuthService>

com.logicaldoc.webservice.auth.AuthClient

All Implemented Interfaces:

AuthService

public class AuthClient
extends AbstractClient<AuthService>
implements AuthService

Auth Web Service client.

Since:

5.2

Author:

Matteo Caruso - Logical Objects

Field Summary

Fields inherited from class com.logicaldoc.webservice.AbstractClient

client, endpoint

Constructor Summary

Constructors

Constructor and Description
AuthClient(String endpoint)

Method Summary

Methods

Modifier and Type	Method and Description
String	login(String username, String password) Starts a new user session.
void	logout(String sid) Closes a user 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.AbstractClient

configureSSL, configureTimeout, initClient

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthClient

public AuthClient(String endpoint)
           throws IOException

Throws:

IOException

Method Detail

login

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

Description copied from interface: AuthService

Starts a new user session.

Specified by:

login in interface AuthService

Parameters:

username - The username

password - The password

Returns:

The newly created session identifier(sid)

Throws:

Exception

logout

public void logout(String sid)

Description copied from interface: AuthService

Closes a user 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

renew

public void renew(String sid)

Description copied from interface: AuthService

Renews a session

Specified by:

renew in interface AuthService