org.bimserver.shared.interfaces

Interface AuthInterface

All Superinterfaces:

PublicInterface

All Known Implementing Classes:

AuthInterfaceAdaptor

public interface AuthInterface
extends PublicInterface

Method Summary

Modifier and Type	Method and Description
Boolean	changePassword(Long uoid, String oldPassword, String newPassword) Change a User's password, not the preferred way, use requestPasswordChange for a safer version
SAccessMethod	getAccessMethod()
SUser	getLoggedInUser()
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
void	requestPasswordChange(String username, String resetUrl, Boolean includeSiteAddress) Request a password change, an e-mail will be send with a validation url
void	setHash(Long uoid, byte[] hash, byte[] salt) Change a User's password, not the preferred way, use requestPasswordChange for a safer version
SUser	validateAccount(Long uoid, String token, String password)

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

getLoggedInUser

SUser getLoggedInUser()
               throws ServerException,
                      UserException

Returns:

The User that it currently loggedin on this ServiceInterface

Throws:

ServerException, - UserException

ServerException

UserException

changePassword

Boolean changePassword(Long uoid,
                       String oldPassword,
                       String newPassword)
                throws ServerException,
                       UserException

Change a User's password, not the preferred way, use requestPasswordChange for a safer version

Parameters:

uoid - The ObjectID of the User

oldPassword - The old password

newPassword - The new password

Returns:

Whether the password was successfully changed

Throws:

ServerException, - UserException

ServerException

UserException

setHash

void setHash(Long uoid,
             byte[] hash,
             byte[] salt)
      throws ServerException,
             UserException

Change a User's password, not the preferred way, use requestPasswordChange for a safer version

Parameters:

uoid - The ObjectID of the User

oldPassword - The old password

newPassword - The new password

Throws:

ServerException, - UserException

ServerException

UserException

requestPasswordChange

void requestPasswordChange(String username,
                           String resetUrl,
                           Boolean includeSiteAddress)
                    throws ServerException,
                           UserException

Request a password change, an e-mail will be send with a validation url

Parameters:

username - The username of the user to change tot password for

Throws:

ServerException, - UserException

ServerException

UserException

validateAccount

SUser validateAccount(Long uoid,
                      String token,
                      String password)
               throws ServerException,
                      UserException

Parameters:

uoid - The ObejctID of the User

token - The token generated by requestPasswordChange

password - The new password

Returns:

A User object if the change is successful, null otherwise

Throws:

ServerException, - UserException

ServerException

UserException