Package tigase.examples

Class SampleCustomAuthRepository

java.lang.Object

tigase.examples.SampleCustomAuthRepository

All Implemented Interfaces:

AuthRepository, Repository

public class SampleCustomAuthRepository
extends Object
implements AuthRepository

This is only and example, sample implementation of AuthRepository and should not be used!

Nested Class Summary

Nested classes/interfaces inherited from interface tigase.db.AuthRepository

AuthRepository.AccountStatus, AuthRepository.DefaultCredentials, AuthRepository.SingleCredential

Nested classes/interfaces inherited from interface tigase.db.Repository

Repository.Meta, Repository.SchemaId

Field Summary

Fields inherited from interface tigase.db.AuthRepository

DATA_KEY, DIGEST_ID_KEY, DIGEST_KEY, MACHANISM_KEY, PASSWORD_KEY, PROTOCOL_KEY, PROTOCOL_VAL_NONSASL, PROTOCOL_VAL_SASL, REALM_KEY, RESULT_KEY, SERVER_NAME_KEY, USER_ID_KEY

Constructor Summary

Constructors

Constructor	Description
SampleCustomAuthRepository()

Method Summary

Modifier and Type	Method	Description
void	addUser(BareJID user, String password)
AuthRepository.AccountStatus	getAccountStatus(BareJID user)
long	getActiveUsersCountIn(Duration duration)
Credentials	getCredentials(BareJID user, String credentialId)
String	getPassword(BareJID user)
String	getResourceUri()	getResourceUri method returns database connection string.
long	getUsersCount()	This method is only used by the server statistics component to report number of registered users.
long	getUsersCount(String domain)	This method is only used by the server statistics component to report number of registered users for given domain.
void	loggedIn(BareJID jid)	Do some actions on repository, when user logs in.
void	logout(BareJID user)
boolean	otherAuth(Map<String,Object> authProps)
void	queryAuth(Map<String,Object> authProps)	queryAuth returns mechanisms available for authentication.
void	removeUser(BareJID user)
void	setAccountStatus(BareJID user, AuthRepository.AccountStatus status)
void	updatePassword(BareJID user, String password)

Methods inherited from class java.lang.Object

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

Methods inherited from interface tigase.db.AuthRepository

getCredentialIds, getUsernames, isMechanismSupported, isUserDisabled, removeCredential, setCredentialsCodecs, setUserDisabled, updateCredential, updateCredential

Methods inherited from interface tigase.db.Repository

initRepository

Constructor Details

SampleCustomAuthRepository

public SampleCustomAuthRepository()

Method Details

getCredentials

public Credentials getCredentials(BareJID user,
 String credentialId)
                           throws TigaseDBException

Specified by:

getCredentials in interface AuthRepository

Throws:

TigaseDBException

getAccountStatus

public AuthRepository.AccountStatus getAccountStatus(BareJID user)
                                              throws TigaseDBException

Specified by:

getAccountStatus in interface AuthRepository

Throws:

TigaseDBException

loggedIn

public void loggedIn(BareJID jid)
              throws TigaseDBException

Description copied from interface: AuthRepository

Do some actions on repository, when user logs in. (for example update last_login_time)

Specified by:

loggedIn in interface AuthRepository

Parameters:

jid - JID of logged user.

Throws:

TigaseDBException - if an error occurs

logout

public void logout(BareJID user)
            throws TigaseDBException

Specified by:

logout in interface AuthRepository

Throws:

TigaseDBException

addUser

public void addUser(BareJID user,
 String password)
             throws TigaseDBException

Specified by:

addUser in interface AuthRepository

Throws:

TigaseDBException

getPassword

public String getPassword(BareJID user)
                   throws TigaseDBException

Specified by:

getPassword in interface AuthRepository

Throws:

TigaseDBException

getResourceUri

public String getResourceUri()

Description copied from interface: AuthRepository

getResourceUri method returns database connection string.

Specified by:

getResourceUri in interface AuthRepository

Returns:

a String value of database connection string.

getActiveUsersCountIn

public long getActiveUsersCountIn(Duration duration)

Specified by:

getActiveUsersCountIn in interface AuthRepository

Parameters:

duration - Time range within which active users should be counted. Method is only used by statistics.

Returns:

number of active users in required range

getUsersCount

public long getUsersCount()

Description copied from interface: AuthRepository

This method is only used by the server statistics component to report number of registered users.

Specified by:

getUsersCount in interface AuthRepository

Returns:

a long number of registered users in the repository.

getUsersCount

public long getUsersCount(String domain)

Description copied from interface: AuthRepository

This method is only used by the server statistics component to report number of registered users for given domain.

Specified by:

getUsersCount in interface AuthRepository

Parameters:

domain - for which get the statistics

Returns:

a long number of registered users in the repository.

otherAuth

public boolean otherAuth(Map<String,Object> authProps)
                  throws TigaseDBException,
AuthorizationException

Specified by:

otherAuth in interface AuthRepository

Throws:

TigaseDBException

AuthorizationException

queryAuth

public void queryAuth(Map<String,Object> authProps)

Description copied from interface: AuthRepository

queryAuth returns mechanisms available for authentication.

Specified by:

queryAuth in interface AuthRepository

Parameters:

authProps - a Map value with parameters for authentication.

removeUser

public void removeUser(BareJID user)
                throws TigaseDBException

Specified by:

removeUser in interface AuthRepository

Throws:

TigaseDBException

setAccountStatus

public void setAccountStatus(BareJID user,
 AuthRepository.AccountStatus status)
                      throws TigaseDBException

Specified by:

setAccountStatus in interface AuthRepository

Throws:

TigaseDBException

updatePassword

public void updatePassword(BareJID user,
 String password)
                    throws TigaseDBException

Specified by:

updatePassword in interface AuthRepository

Throws:

TigaseDBException