public class TigaseCustomAuth extends Object implements AuthRepository
{ call
then the server
assumes this is a stored procedure call, otherwise it is executed as a plain
SQL query. Each configuration value is stripped from white characters on both
ends before processing.
Please don't use semicolon ';'
at the end of the query as many
JDBC drivers get confused and the query may not work for unknown obvious
reason.
Some queries take arguments. Arguments are marked by question marks
'?'
in the query. Refer to the configuration parameters
description for more details about what parameters are expected in each
query.
Example configuration.
The first example shows how to put a stored procedure as a query with 2
required parameters.
add-user-query={ call TigAddUserPlainPw(?, ?) }The same query with plain SQL parameters instead:
add-user-query=insert into users (user_id, password) values (?, ?)Created: Sat Nov 11 22:22:04 2006
Repository.Meta
Modifier and Type | Field and Description |
---|---|
static String |
DEF_ADDUSER_KEY
Query adding a new user to the database.
|
static String |
DEF_ADDUSER_QUERY
Field description
|
static String |
DEF_CONNVALID_KEY
Query executing periodically to ensure active connection with the database.
|
static String |
DEF_DELUSER_KEY
Removes a user from the database.
|
static String |
DEF_DELUSER_QUERY
Field description
|
static String |
DEF_GETPASSWORD_KEY
Retrieves user password from the database for given user_id (JID).
|
static String |
DEF_GETPASSWORD_QUERY
Field description
|
static String |
DEF_INITDB_KEY
Database initialization query which is run after the server is started.
|
static String |
DEF_INITDB_QUERY
Field description
|
static String |
DEF_NONSASL_MECHS
Field description
|
static String |
DEF_NONSASL_MECHS_KEY
Comma separated list of NON-SASL authentication mechanisms.
|
static String |
DEF_SASL_MECHS
Field description
|
static String |
DEF_SASL_MECHS_KEY
Comma separated list of SASL authentication mechanisms.
|
static String |
DEF_UPDATEPASSWORD_KEY
Updates (changes) password for a given user_id (JID).
|
static String |
DEF_UPDATEPASSWORD_QUERY
Field description
|
static String |
DEF_USERLOGIN_KEY
Performs user login.
|
static String |
DEF_USERLOGIN_QUERY
Field description
|
static String |
DEF_USERLOGOUT_KEY
This query is called when user logs out or disconnects.
|
static String |
DEF_USERLOGOUT_QUERY
Field description
|
static String |
DEF_USERS_COUNT_KEY
Field description
|
static String |
DEF_USERS_COUNT_QUERY
Field description
|
static String |
DEF_USERS_DOMAIN_COUNT_KEY
Field description
|
static String |
DEF_USERS_DOMAIN_COUNT_QUERY
Field description
|
static String |
NO_QUERY |
static String |
SP_STARTS_WITH
Field description
|
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, USERNAME_KEY
Constructor and Description |
---|
TigaseCustomAuth() |
Modifier and Type | Method and Description |
---|---|
void |
addUser(tigase.xmpp.BareJID user,
String password)
Describe
addUser method here. |
boolean |
digestAuth(tigase.xmpp.BareJID user,
String digest,
String id,
String alg)
Deprecated.
|
protected String |
getParamWithDef(Map<String,String> params,
String key,
String def) |
String |
getPassword(tigase.xmpp.BareJID user) |
String |
getResourceUri()
Method description
|
long |
getUsersCount()
getUsersCount method is thread safe. |
long |
getUsersCount(String domain)
Method description
|
void |
initRepository(String connection_str,
Map<String,String> params)
Describe
initRepository method here. |
void |
logout(tigase.xmpp.BareJID user)
Method description
|
boolean |
otherAuth(Map<String,Object> props)
Describe
otherAuth method here. |
boolean |
plainAuth(tigase.xmpp.BareJID user,
String password)
Deprecated.
|
void |
queryAuth(Map<String,Object> authProps)
Describe
queryAuth method here. |
void |
removeUser(tigase.xmpp.BareJID user)
Describe
removeUser method here. |
void |
updatePassword(tigase.xmpp.BareJID user,
String password)
Describe
updatePassword method here. |
public static final String DEF_CONNVALID_KEY
select 1
public static final String DEF_INITDB_KEY
update tig_users set online_status = 0
public static final String DEF_ADDUSER_KEY
(user_id (JID), password)
Example query:
insert into tig_users (user_id, user_pw) values (?, ?)
public static final String DEF_DELUSER_KEY
(user_id (JID))
Example query:
delete from tig_users where user_id = ?
public static final String DEF_GETPASSWORD_KEY
(user_id (JID))
Example query:
select user_pw from tig_users where user_id = ?
public static final String DEF_UPDATEPASSWORD_KEY
(password, user_id (JID))
Example query:
update tig_users set user_pw = ? where user_id = ?
public static final String DEF_USERLOGIN_KEY
user-login-query
or get-password-query
.
If both queries are defined then user-login-query
is used.
Normally this method should be only used with plain text password
authentication or sasl-plain.
The Tigase server expects a result set with user_id to be returned from the
query if login is successful and empty results set if the login is
unsuccessful.
Takes 2 arguments: (user_id (JID), password)
Example query:
select user_id from tig_users where (user_id = ?) AND (user_pw = ?)
public static final String DEF_USERLOGOUT_KEY
(user_id (JID))
Example query:
update tig_users, set online_status = online_status - 1 where user_id = ?
public static final String DEF_USERS_COUNT_KEY
public static final String DEF_USERS_DOMAIN_COUNT_KEY
public static final String DEF_NONSASL_MECHS_KEY
password
and digest
.
digest
mechanism can work only with
get-password-query
active and only when password are stored in
plain text format in the database.public static final String DEF_SASL_MECHS_KEY
PLAIN
, DIGEST-MD5
, CRAM-MD5
.
"Non-PLAIN" mechanisms will work only with the
get-password-query
active and only when passwords are stored
in plain text format in the database.public static final String NO_QUERY
public static final String DEF_INITDB_QUERY
public static final String DEF_ADDUSER_QUERY
public static final String DEF_DELUSER_QUERY
public static final String DEF_GETPASSWORD_QUERY
public static final String DEF_UPDATEPASSWORD_QUERY
public static final String DEF_USERLOGIN_QUERY
public static final String DEF_USERLOGOUT_QUERY
public static final String DEF_USERS_COUNT_QUERY
public static final String DEF_USERS_DOMAIN_COUNT_QUERY
public static final String DEF_NONSASL_MECHS
public static final String DEF_SASL_MECHS
public static final String SP_STARTS_WITH
public void addUser(tigase.xmpp.BareJID user, String password) throws UserExistsException, TigaseDBException
addUser
method here.addUser
in interface AuthRepository
user
- a String
valuepassword
- a String
valueUserExistsException
- if an error occursTigaseDBException
- if an error occurs@Deprecated public boolean digestAuth(tigase.xmpp.BareJID user, String digest, String id, String alg) throws UserNotFoundException, TigaseDBException, AuthorizationException
digestAuth
method here.digestAuth
in interface AuthRepository
user
- a String
valuedigest
- a String
valueid
- a String
valuealg
- a String
valueboolean
valueUserNotFoundException
- if an error occursTigaseDBException
- if an error occursAuthorizationException
- if an error occurspublic String getResourceUri()
getResourceUri
in interface AuthRepository
String
value of database connection string.public long getUsersCount()
getUsersCount
method is thread safe. It uses local variable
for storing Statement
.getUsersCount
in interface AuthRepository
long
number of user accounts in database.public long getUsersCount(String domain)
getUsersCount
in interface AuthRepository
domain
- long
number of registered users in the repository.public void initRepository(String connection_str, Map<String,String> params) throws DBInitException
initRepository
method here.initRepository
in interface Repository
connection_str
- a String
valueparams
- DBInitException
- if an error occurspublic void logout(tigase.xmpp.BareJID user) throws UserNotFoundException, TigaseDBException
logout
in interface AuthRepository
user
- TigaseDBException
UserNotFoundException
public boolean otherAuth(Map<String,Object> props) throws UserNotFoundException, TigaseDBException, AuthorizationException
otherAuth
method here.otherAuth
in interface AuthRepository
props
- a Map
valueboolean
valueUserNotFoundException
- if an error occursTigaseDBException
- if an error occursAuthorizationException
- if an error occurs@Deprecated public boolean plainAuth(tigase.xmpp.BareJID user, String password) throws UserNotFoundException, TigaseDBException, AuthorizationException
plainAuth
method here.plainAuth
in interface AuthRepository
user
- a String
valuepassword
- a String
valueboolean
valueAuthorizationException
UserNotFoundException
- if an error occursTigaseDBException
- if an error occurspublic void queryAuth(Map<String,Object> authProps)
queryAuth
method here.queryAuth
in interface AuthRepository
authProps
- a Map
valuepublic void removeUser(tigase.xmpp.BareJID user) throws UserNotFoundException, TigaseDBException
removeUser
method here.removeUser
in interface AuthRepository
user
- a String
valueUserNotFoundException
- if an error occursTigaseDBException
- if an error occurspublic void updatePassword(tigase.xmpp.BareJID user, String password) throws UserNotFoundException, TigaseDBException
updatePassword
method here.updatePassword
in interface AuthRepository
user
- a String
valuepassword
- a String
valueTigaseDBException
- if an error occursUserNotFoundException
public String getPassword(tigase.xmpp.BareJID user) throws UserNotFoundException, TigaseDBException
getPassword
in interface AuthRepository
UserNotFoundException
TigaseDBException
Copyright © 2014 "Tigase, Inc.". All rights reserved.