org.bimserver.shared.interfaces

Class AuthInterfaceAdaptor

java.lang.Object

org.bimserver.shared.interfaces.AuthInterfaceAdaptor

All Implemented Interfaces:

AuthInterface, PublicInterface

public class AuthInterfaceAdaptor
extends Object
implements AuthInterface

Constructor Summary

Constructors

Constructor and Description
AuthInterfaceAdaptor()

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)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthInterfaceAdaptor

public AuthInterfaceAdaptor()

Method Detail

changePassword

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

Description copied from interface: AuthInterface

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

Specified by:

changePassword in interface AuthInterface

Parameters:

uoid - The ObjectID of the User

oldPassword - The old password

newPassword - The new password

Returns:

Whether the password was successfully changed

Throws:

UserException

ServerException

getAccessMethod

public SAccessMethod getAccessMethod()
                              throws UserException,
                                     ServerException

Specified by:

getAccessMethod in interface AuthInterface

Returns:

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

Throws:

UserException

ServerException

getLoggedInUser

public SUser getLoggedInUser()
                      throws UserException,
                             ServerException

Specified by:

getLoggedInUser in interface AuthInterface

Returns:

The User that it currently loggedin on this ServiceInterface

Throws:

UserException

ServerException

isLoggedIn

public Boolean isLoggedIn()
                   throws UserException,
                          ServerException

Description copied from interface: AuthInterface

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

Specified by:

isLoggedIn in interface AuthInterface

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: AuthInterface

Login with a username/password combination

Specified by:

login in interface AuthInterface

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: AuthInterface

Login with a user-token

Specified by:

loginUserToken in interface AuthInterface

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: AuthInterface

Logout

Specified by:

logout in interface AuthInterface

Throws:

UserException

ServerException

requestPasswordChange

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

Description copied from interface: AuthInterface

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

Specified by:

requestPasswordChange in interface AuthInterface

Parameters:

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

Throws:

UserException

ServerException

setHash

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

Description copied from interface: AuthInterface

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

Specified by:

setHash in interface AuthInterface

Parameters:

uoid - The ObjectID of the User

Throws:

UserException

ServerException

validateAccount

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

Specified by:

validateAccount in interface AuthInterface

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:

UserException

ServerException