|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserAuthRepository
Describe interface UserAuthRepository here. Created: Sun Nov 5 21:15:46 2006
Field Summary | |
---|---|
static String |
DATA_KEY
|
static String |
MACHANISM_KEY
|
static String |
PROTOCOL_KEY
|
static String |
PROTOCOL_VAL_NONSASL
|
static String |
PROTOCOL_VAL_SASL
|
static String |
REALM_KEY
|
static String |
RESULT_KEY
|
static String |
SERVER_NAME_KEY
|
static String |
USER_ID_KEY
|
Method Summary | |
---|---|
void |
addUser(String user,
String password)
Describe addUser method here. |
boolean |
digestAuth(String user,
String digest,
String id,
String alg)
digestAuth method performs non-sasl, digest authentication
as described in non-sasl authentication
XEP-0078
For now it is empty and always returns false as I don't
have description for database with passwords. |
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 |
initRepository(String resource_uri,
Map<String,String> params)
initRepository method is doing initialization for database
connection. |
void |
logout(String user)
Describe logout method here. |
boolean |
otherAuth(Map<String,Object> authProps)
Describe otherAuth method here. |
boolean |
plainAuth(String user,
String password)
plainAuth method performs non-sasl, plain authentication
as described in non-sasl authentication
XEP-0078. |
void |
queryAuth(Map<String,Object> authProps)
queryAuth returns mechanisms available for authentication. |
void |
removeUser(String user)
Describe removeUser method here. |
void |
updatePassword(String user,
String password)
Describe updatePassword method here. |
Field Detail |
---|
static final String PROTOCOL_KEY
static final String PROTOCOL_VAL_SASL
static final String PROTOCOL_VAL_NONSASL
static final String RESULT_KEY
static final String MACHANISM_KEY
static final String REALM_KEY
static final String SERVER_NAME_KEY
static final String DATA_KEY
static final String USER_ID_KEY
Method Detail |
---|
long getUsersCount()
long
number of registered users in the repository.long getUsersCount(String domain)
domain
-
long
number of registered users in the repository.void queryAuth(Map<String,Object> authProps)
queryAuth
returns mechanisms available for authentication.
authProps
- a Map
value with parameters for authentication.void initRepository(String resource_uri, Map<String,String> params) throws DBInitException
initRepository
method is doing initialization for database
connection. It may also do lazy initialization with database.
Connection to database might be established during the first authentication
request.
resource_uri
- a String
value of database connection string.
The string must also contain database user name and password if required
for connection.params
-
DBInitException
- if an error occurs during access database. It won't
happen however as in this method we do simple variable assigment.String getResourceUri()
getResourceUri
method returns database connection string.
String
value of database connection string.boolean plainAuth(String user, String password) throws UserNotFoundException, TigaseDBException, AuthorizationException
plainAuth
method performs non-sasl, plain authentication
as described in non-sasl authentication
XEP-0078.
user
- a String
value of user namepassword
- a String
value of plain user password.
boolean
value true
on successful
authentication, false
on authentication failure.
UserNotFoundException
- if an given user name is not found in
the authentication repository.
TigaseDBException
- if an error occurs during during accessing
database;
AuthorizationException
- if an error occurs during authentication
process.boolean digestAuth(String user, String digest, String id, String alg) throws UserNotFoundException, TigaseDBException, AuthorizationException
digestAuth
method performs non-sasl, digest authentication
as described in non-sasl authentication
XEP-0078
For now it is empty and always returns false
as I don't
have description for database with passwords.
user
- a String
value of user namedigest
- a String
value password digest sumid
- a String
value session ID used for digest sum
calculation.alg
- a String
value of algorithm ID used for digest sum
calculation.
boolean
value true
on successful
authentication, false
on authentication failure.
UserNotFoundException
- if an given user name is not found in
the authentication repository.
TigaseDBException
- if an error occurs during during accessing
database;
AuthorizationException
- if an error occurs during authentication
process.boolean otherAuth(Map<String,Object> authProps) throws UserNotFoundException, TigaseDBException, AuthorizationException
otherAuth
method here.
authProps
- a Map
value
boolean
value
UserNotFoundException
- if an error occurs
TigaseDBException
- if an error occurs
AuthorizationException
- if an error occursvoid addUser(String user, String password) throws UserExistsException, TigaseDBException
addUser
method here.
user
- a String
valuepassword
- a String
value
UserExistsException
- if an error occurs
TigaseDBException
- if an error occursvoid updatePassword(String user, String password) throws UserNotFoundException, TigaseDBException
updatePassword
method here.
user
- a String
valuepassword
- a String
value
UserNotFoundException
TigaseDBException
- if an error occursvoid removeUser(String user) throws UserNotFoundException, TigaseDBException
removeUser
method here.
user
- a String
value
UserNotFoundException
- if an error occurs
TigaseDBException
- if an error occursvoid logout(String user) throws UserNotFoundException, TigaseDBException
logout
method here.
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 |