org.bimserver.shared.interfaces

Class Bimsie1AuthInterfaceAdaptor

java.lang.Object

org.bimserver.shared.interfaces.Bimsie1AuthInterfaceAdaptor

All Implemented Interfaces:

Bimsie1AuthInterface, PublicInterface

public class Bimsie1AuthInterfaceAdaptor
extends Object
implements Bimsie1AuthInterface

Constructor Summary

Constructors

Constructor and Description
Bimsie1AuthInterfaceAdaptor()

Method Summary

Modifier and Type	Method and Description
SAccessMethod	getAccessMethod()
Boolean	isLoggedIn() Check whether the server considers the user (token) as logged-in
String	login(String username, String password) Login with a username/password combination
String	loginUserToken(String token) Login with a user-token
void	logout() Logout

Methods inherited from class java.lang.Object

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

Constructor Detail

Bimsie1AuthInterfaceAdaptor

public Bimsie1AuthInterfaceAdaptor()

Method Detail

getAccessMethod

public SAccessMethod getAccessMethod()
                              throws UserException,
                                     ServerException

Specified by:

getAccessMethod in interface Bimsie1AuthInterface

Returns:

The method of access this ServiceInterface is using (SOAP, PB etc...)

Throws:

UserException

ServerException

isLoggedIn

public Boolean isLoggedIn()
                   throws UserException,
                          ServerException

Description copied from interface: Bimsie1AuthInterface

Check whether the server considers the user (token) as logged-in

Specified by:

isLoggedIn in interface Bimsie1AuthInterface

Returns:

Whether this ServiceInterface is logged-in

Throws:

UserException

ServerException

login

public String login(String username,
                    String password)
             throws UserException,
                    ServerException

Description copied from interface: Bimsie1AuthInterface

Login with a username/password combination

Specified by:

login in interface Bimsie1AuthInterface

Parameters:

username - The username (must be a valid e-mail address)

password - The password

Returns:

A token, use this token in subsequent calls. Read the documentation of the transport mechanism (SOAP, Protocol Buffers or JSON) to see how to send the token

Throws:

UserException

ServerException

loginUserToken

public String loginUserToken(String token)
                      throws UserException,
                             ServerException

Description copied from interface: Bimsie1AuthInterface

Login with a user-token

Specified by:

loginUserToken in interface Bimsie1AuthInterface

Returns:

A token, use this token in subsequent calls. Read the documentation of the transport mechanism (SOAP, Protocol Buffers or JSON) to see how to send the token

Throws:

UserException

ServerException

logout

public void logout()
            throws UserException,
                   ServerException

Description copied from interface: Bimsie1AuthInterface

Logout

Specified by:

logout in interface Bimsie1AuthInterface

Throws:

UserException

ServerException