org.bimserver.shared.interfaces.bimsie1

Interface Bimsie1AuthInterface

All Superinterfaces:

PublicInterface

All Known Implementing Classes:

Bimsie1AuthInterfaceAdaptor

public interface Bimsie1AuthInterface
extends PublicInterface

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

Method Detail

login

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

Login with a username/password combination

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:

ServerException, - UserException

ServerException

UserException

logout

void logout()
     throws ServerException,
            UserException

Logout

Throws:

ServerException, - UserException

ServerException

UserException

isLoggedIn

Boolean isLoggedIn()
            throws ServerException,
                   UserException

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

Returns:

Whether this ServiceInterface is logged-in

Throws:

ServerException, - UserException

ServerException

UserException

getAccessMethod

SAccessMethod getAccessMethod()
                       throws ServerException,
                              UserException

Returns:

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

Throws:

ServerException, - UserException

ServerException

UserException

loginUserToken

String loginUserToken(String token)
               throws ServerException,
                      UserException

Login with a user-token

Parameters:

token -

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:

ServerException

UserException