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
SUser	getLoggedInUser()
void	requestPasswordChange(String username, String resetUrl) 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

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)
                    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