|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecttigase.db.jdbc.TigaseCustomAuth
public class TigaseCustomAuth
The user authentication connector allows for customized SQL queries to be used.
Queries are defined in the configuration file and they can be either plain SQL
queries or stored procedures.
If the query starts with characters: { 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
Field Summary | |
---|---|
static String |
DEF_ADDUSER_KEY
Query adding a new user to the database. |
static String |
DEF_ADDUSER_QUERY
|
static String |
DEF_CONNVALID_KEY
Query executing periodically to ensure active connection with the database. |
static String |
DEF_CONNVALID_QUERY
|
static String |
DEF_DELUSER_KEY
Removes a user from the database. |
static String |
DEF_DELUSER_QUERY
|
static String |
DEF_GETPASSWORD_KEY
Retrieves user password from the database for given user_id (JID). |
static String |
DEF_GETPASSWORD_QUERY
|
static String |
DEF_INITDB_KEY
Database initialization query which is run after the server is started. |
static String |
DEF_INITDB_QUERY
|
static String |
DEF_NONSASL_MECHS
|
static String |
DEF_NONSASL_MECHS_KEY
Comma separated list of NON-SASL authentication mechanisms. |
static String |
DEF_SASL_MECHS
|
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
|
static String |
DEF_USERLOGIN_KEY
Performs user login. |
static String |
DEF_USERLOGIN_QUERY
|
static String |
DEF_USERLOGOUT_KEY
This query is called when user logs out or disconnects. |
static String |
DEF_USERLOGOUT_QUERY
|
static String |
DEF_USERS_COUNT_KEY
|
static String |
DEF_USERS_COUNT_QUERY
|
static String |
DEF_USERS_DOMAIN_COUNT_KEY
|
static String |
DEF_USERS_DOMAIN_COUNT_QUERY
|
static String |
SP_STARTS_WITH
|
Fields inherited from interface tigase.db.UserAuthRepository |
---|
DATA_KEY, MACHANISM_KEY, PROTOCOL_KEY, PROTOCOL_VAL_NONSASL, PROTOCOL_VAL_SASL, REALM_KEY, RESULT_KEY, SERVER_NAME_KEY, USER_ID_KEY |
Constructor Summary | |
---|---|
TigaseCustomAuth()
|
Method Summary | |
---|---|
void |
addUser(String user,
String password)
Describe addUser method here. |
boolean |
digestAuth(String user,
String digest,
String id,
String alg)
Describe digestAuth method here. |
String |
getResourceUri()
getResourceUri method returns database connection string. |
long |
getUsersCount()
getUsersCount method is thread safe. |
long |
getUsersCount(String domain)
This method is only used by the server statistics component to report number of registered users for given domain. |
void |
initRepository(String connection_str,
Map<String,String> params)
Describe initRepository method here. |
void |
logout(String user)
Describe logout method here. |
boolean |
otherAuth(Map<String,Object> props)
Describe otherAuth method here. |
boolean |
plainAuth(String user,
String password)
Describe plainAuth method here. |
void |
queryAuth(Map<String,Object> authProps)
Describe queryAuth method here. |
void |
removeUser(String user)
Describe removeUser method here. |
void |
updatePassword(String user,
String password)
Describe updatePassword method here. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
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 formay in the database.
public static final String DEF_CONNVALID_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
Constructor Detail |
---|
public TigaseCustomAuth()
Method Detail |
---|
public void queryAuth(Map<String,Object> authProps)
queryAuth
method here.
queryAuth
in interface UserAuthRepository
authProps
- a Map
valuepublic void initRepository(String connection_str, Map<String,String> params) throws DBInitException
initRepository
method here.
initRepository
in interface UserAuthRepository
connection_str
- a String
valueparams
-
DBInitException
- if an error occurspublic String getResourceUri()
UserAuthRepository
getResourceUri
method returns database connection string.
getResourceUri
in interface UserAuthRepository
String
value of database connection string.public long getUsersCount()
getUsersCount
method is thread safe. It uses local variable
for storing Statement
.
getUsersCount
in interface UserAuthRepository
long
number of user accounts in database.public long getUsersCount(String domain)
UserAuthRepository
getUsersCount
in interface UserAuthRepository
long
number of registered users in the repository.public boolean plainAuth(String user, String password) throws UserNotFoundException, TigaseDBException, AuthorizationException
plainAuth
method here.
plainAuth
in interface UserAuthRepository
user
- a String
valuepassword
- a String
value
boolean
value
UserNotFoundException
- if an error occurs
TigaseDBException
- if an error occurs
AuthorizationException
- if an error occurs during authentication
process.public boolean digestAuth(String user, String digest, String id, String alg) throws UserNotFoundException, TigaseDBException, AuthorizationException
digestAuth
method here.
digestAuth
in interface UserAuthRepository
user
- a String
valuedigest
- a String
valueid
- a String
valuealg
- a String
value
boolean
value
UserNotFoundException
- if an error occurs
TigaseDBException
- if an error occurs
AuthorizationException
- if an error occurspublic boolean otherAuth(Map<String,Object> props) throws UserNotFoundException, TigaseDBException, AuthorizationException
otherAuth
method here.
otherAuth
in interface UserAuthRepository
props
- a Map
value
boolean
value
UserNotFoundException
- if an error occurs
TigaseDBException
- if an error occurs
AuthorizationException
- if an error occurspublic void logout(String user) throws UserNotFoundException, TigaseDBException
UserAuthRepository
logout
method here.
logout
in interface UserAuthRepository
user
- a String
value
UserNotFoundException
- if an error occurs
TigaseDBException
- if an error occurspublic void addUser(String user, String password) throws UserExistsException, TigaseDBException
addUser
method here.
addUser
in interface UserAuthRepository
user
- a String
valuepassword
- a String
value
UserExistsException
- if an error occurs
TigaseDBException
- if an error occurspublic void updatePassword(String user, String password) throws UserNotFoundException, TigaseDBException
updatePassword
method here.
updatePassword
in interface UserAuthRepository
user
- a String
valuepassword
- a String
value
UserExistsException
- if an error occurs
TigaseDBException
- if an error occurs
UserNotFoundException
public void removeUser(String user) throws UserNotFoundException, TigaseDBException
removeUser
method here.
removeUser
in interface UserAuthRepository
user
- a String
value
UserNotFoundException
- if an error occurs
TigaseDBException
- if an error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |