|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.api.Api
com.xpn.xwiki.plugin.rightsmanager.RightsManagerUsersApi
public class RightsManagerUsersApi
API for managing users.
Field Summary | |
---|---|
static String |
CONTEXT_LASTERRORCODE
Field name of the last error code inserted in context. |
static String |
CONTEXT_LASTEXCEPTION
Field name of the last api exception inserted in context. |
protected static org.slf4j.Logger |
LOGGER
The logging toolkit. |
Fields inherited from class com.xpn.xwiki.api.Api |
---|
context |
Constructor Summary | |
---|---|
RightsManagerUsersApi(XWikiContext context)
Create an instance of RightsManageRightsApi. |
Method Summary | |
---|---|
int |
countAllGlobalUsers()
|
int |
countAllLocalUsers()
|
int |
countAllMatchedGlobalUsers(Map<?,?> matchFields)
|
int |
countAllMatchedLocalUsers(Map<?,?> matchFields)
|
int |
countAllMatchedUsers(Map<?,?> matchFields)
|
int |
countAllMatchedWikiUsers(String wikiName,
Map<?,?> matchFields)
Get the number of users in the provided wiki. |
int |
countAllUsers()
|
int |
countAllWikiUsers(String wikiName)
Get the number of users in the provided wiki. |
List<Document> |
getAllGlobalUsers()
Get all users in the main wiki. |
List<Document> |
getAllGlobalUsers(int nb,
int start)
Get all users in the main wiki. |
List<String> |
getAllGlobalUsersNames()
Get all users names in the main wiki. |
List<String> |
getAllGlobalUsersNames(int nb,
int start)
Get all users names in the main wiki. |
List<Document> |
getAllLocalUsers()
Get all users in the current wiki. |
List<Document> |
getAllLocalUsers(int nb,
int start)
Get all users in the current wiki. |
List<String> |
getAllLocalUsersNames()
Get all users names in the current wiki. |
List<String> |
getAllLocalUsersNames(int nb,
int start)
Get all users names in the current wiki. |
List<Document> |
getAllMatchedGlobalUsers(Map<?,?> matchFields)
Get all users in the main wiki. |
List<Document> |
getAllMatchedGlobalUsers(Map<?,?> matchFields,
int nb,
int start)
Get all users in the main wiki. |
List<Document> |
getAllMatchedGlobalUsers(Map<?,?> matchFields,
int nb,
int start,
List<?> order)
Get all users in the main wiki. |
List<String> |
getAllMatchedGlobalUsersNames(Map<?,?> matchFields)
Get all users names in the main wiki. |
List<String> |
getAllMatchedGlobalUsersNames(Map<?,?> matchFields,
int nb,
int start)
Get all users names in the main wiki. |
List<String> |
getAllMatchedGlobalUsersNames(Map<?,?> matchFields,
int nb,
int start,
List<?> order)
Get all users names in the main wiki. |
List<Document> |
getAllMatchedLocalUsers(Map<?,?> matchFields)
Get all users in the current wiki. |
List<Document> |
getAllMatchedLocalUsers(Map<?,?> matchFields,
int nb,
int start)
Get all users in the current wiki. |
List<Document> |
getAllMatchedLocalUsers(Map<?,?> matchFields,
int nb,
int start,
List<?> order)
Get all users in the current wiki. |
List<String> |
getAllMatchedLocalUsersNames(Map<?,?> matchFields)
Get all users names in the current wiki. |
List<String> |
getAllMatchedLocalUsersNames(Map<?,?> matchFields,
int nb,
int start)
Get all users names in the current wiki. |
List<String> |
getAllMatchedLocalUsersNames(Map<?,?> matchFields,
int nb,
int start,
List<?> order)
Get all users names in the current wiki. |
List<Document> |
getAllMatchedUsers(Map<?,?> matchFields)
Get all users in the main wiki and the current wiki. |
List<Document> |
getAllMatchedUsers(Map<?,?> matchFields,
int nb,
int start)
Get all users in the main wiki and the current wiki. |
List<Document> |
getAllMatchedUsers(Map<?,?> matchFields,
int nb,
int start,
List<?> order)
Get all users in the main wiki and the current wiki. |
List<String> |
getAllMatchedUsersNames(Map<?,?> matchFields)
Get all users names in the main wiki and the current wiki. |
List<String> |
getAllMatchedUsersNames(Map<?,?> matchFields,
int nb,
int start)
Get all users names in the main wiki and the current wiki. |
List<String> |
getAllMatchedUsersNames(Map<?,?> matchFields,
int nb,
int start,
List<?> order)
Get all users names in the main wiki and the current wiki. |
List<Document> |
getAllMatchedWikiUsers(String wikiName,
Map<?,?> matchFields)
Get all users in the provided wiki. |
List<Document> |
getAllMatchedWikiUsers(String wikiName,
Map<?,?> matchFields,
int nb,
int start)
Get all users in the provided wiki. |
List<Document> |
getAllMatchedWikiUsers(String wikiName,
Map<?,?> matchFields,
int nb,
int start,
List<?> order)
Get all users in the provided wiki. |
List<String> |
getAllMatchedWikiUsersNames(String wikiName,
Map<?,?> matchFields)
Get all users names in the provided wiki. |
List<String> |
getAllMatchedWikiUsersNames(String wikiName,
Map<?,?> matchFields,
int nb,
int start)
Get all users names in the provided wiki. |
List<String> |
getAllMatchedWikiUsersNames(String wikiName,
Map<?,?> matchFields,
int nb,
int start,
List<?> order)
Get all users names in the provided wiki. |
List<Document> |
getAllUsers()
Get all users in the main wiki and the current wiki. |
List<Document> |
getAllUsers(int nb,
int start)
Get all users in the main wiki and the current wiki. |
List<String> |
getAllUsersNames()
Get all users names in the main wiki and the current wiki. |
List<String> |
getAllUsersNames(int nb,
int start)
Get all users names in the main wiki and the current wiki. |
List<Document> |
getAllWikiUsers(String wikiName)
Get all users in the provided wiki. |
List<Document> |
getAllWikiUsers(String wikiName,
int nb,
int start)
Get all users in the provided wiki. |
List<String> |
getAllWikiUsersNames(String wikiName)
Get all users names in the provided wiki. |
List<String> |
getAllWikiUsersNames(String wikiName,
int nb,
int start)
Get all users names in the provided wiki. |
Methods inherited from class com.xpn.xwiki.api.Api |
---|
convert, convert, convert, convertAttachments, getXWikiContext, hasAccessLevel, hasAdminRights, hasProgrammingRights, hasWikiAdminRights |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String CONTEXT_LASTERRORCODE
public static final String CONTEXT_LASTEXCEPTION
protected static final org.slf4j.Logger LOGGER
Constructor Detail |
---|
public RightsManagerUsersApi(XWikiContext context)
context
- the XWiki context.Method Detail |
---|
public int countAllUsers() throws XWikiException
XWikiException
- error when getting number of users.public int countAllMatchedUsers(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
XWikiException
- error when getting number of users.public int countAllWikiUsers(String wikiName) throws XWikiException
wikiName
- the name of the wiki where to search for users.
XWikiException
- error when getting number of users.public int countAllMatchedWikiUsers(String wikiName, Map<?,?> matchFields) throws XWikiException
wikiName
- the name of the wiki where to search for users.matchFields
- the fields to match. It is a Map with field name as key and for value :
XWikiException
- error when getting number of users.public int countAllGlobalUsers() throws XWikiException
XWikiException
- error when getting number of users.public int countAllMatchedGlobalUsers(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
XWikiException
- error when getting number of users.public int countAllLocalUsers() throws XWikiException
XWikiException
- error when getting number of users.public int countAllMatchedLocalUsers(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
XWikiException
- error when getting number of users.public List<String> getAllUsersNames(int nb, int start) throws XWikiException
nb
- the maximum number of result to return.start
- the index of the first found user to return.
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllUsersNames() throws XWikiException
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllMatchedUsersNames(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllMatchedUsersNames(Map<?,?> matchFields, int nb, int start) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found user to return.
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllMatchedUsersNames(Map<?,?> matchFields, int nb, int start, List<?> order) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found user to return.order
- the fields to order from. It is a List containing :
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllGlobalUsersNames(int nb, int start) throws XWikiException
nb
- the maximum number of result to return.start
- the index of the first found user to return.
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllGlobalUsersNames() throws XWikiException
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllMatchedGlobalUsersNames(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllMatchedGlobalUsersNames(Map<?,?> matchFields, int nb, int start) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found user to return.
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllMatchedGlobalUsersNames(Map<?,?> matchFields, int nb, int start, List<?> order) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found user to return.order
- the fields to order from. It is a List containing :
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllWikiUsersNames(String wikiName, int nb, int start) throws XWikiException
wikiName
- the wiki where to search for users.nb
- the maximum number of result to return.start
- the index of the first found user to return.
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllWikiUsersNames(String wikiName) throws XWikiException
wikiName
- the wiki where to search for users.
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllMatchedWikiUsersNames(String wikiName, Map<?,?> matchFields) throws XWikiException
wikiName
- the wiki where to search for users.matchFields
- the fields to match. It is a Map with field name as key and for value :
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllMatchedWikiUsersNames(String wikiName, Map<?,?> matchFields, int nb, int start) throws XWikiException
wikiName
- the wiki where to search for users.matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found user to return.
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllMatchedWikiUsersNames(String wikiName, Map<?,?> matchFields, int nb, int start, List<?> order) throws XWikiException
wikiName
- the wiki where to search for users.matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found user to return.order
- the fields to order from. It is a List containing :
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllLocalUsersNames(int nb, int start) throws XWikiException
nb
- the maximum number of result to return.start
- the index of the first found user to return.
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllLocalUsersNames() throws XWikiException
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllMatchedLocalUsersNames(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllMatchedLocalUsersNames(Map<?,?> matchFields, int nb, int start) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found user to return.
List
of String
containing user names.
XWikiException
- error when searching for users.public List<String> getAllMatchedLocalUsersNames(Map<?,?> matchFields, int nb, int start, List<?> order) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found user to return.order
- the fields to order from. It is a List containing :
String
containing user names.
List
of String
containing user names.
XWikiException
- error when searching for users.public List<Document> getAllUsers(int nb, int start) throws XWikiException
nb
- the maximum number of result to return.start
- the index of the first found user to return.
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllUsers() throws XWikiException
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllMatchedUsers(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllMatchedUsers(Map<?,?> matchFields, int nb, int start) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found user to return.
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllMatchedUsers(Map<?,?> matchFields, int nb, int start, List<?> order) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found user to return.order
- the fields to order from. It is a List containing :
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllGlobalUsers(int nb, int start) throws XWikiException
nb
- the maximum number of result to return.start
- the index of the first found user to return.
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllGlobalUsers() throws XWikiException
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllMatchedGlobalUsers(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllMatchedGlobalUsers(Map<?,?> matchFields, int nb, int start) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found user to return.
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllMatchedGlobalUsers(Map<?,?> matchFields, int nb, int start, List<?> order) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found user to return.order
- the fields to order from. It is a List containing :
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllWikiUsers(String wikiName, int nb, int start) throws XWikiException
wikiName
- the wiki where to search for users.nb
- the maximum number of result to return.start
- the index of the first found user to return.
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllWikiUsers(String wikiName) throws XWikiException
wikiName
- the wiki where to search for users.
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllMatchedWikiUsers(String wikiName, Map<?,?> matchFields) throws XWikiException
wikiName
- the wiki where to search for users.matchFields
- the fields to match. It is a Map with field name as key and for value :
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllMatchedWikiUsers(String wikiName, Map<?,?> matchFields, int nb, int start) throws XWikiException
wikiName
- the wiki where to search for users.matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found user to return.
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllMatchedWikiUsers(String wikiName, Map<?,?> matchFields, int nb, int start, List<?> order) throws XWikiException
wikiName
- the wiki where to search for users.matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found user to return.order
- the fields to order from. It is a List containing :
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllLocalUsers(int nb, int start) throws XWikiException
nb
- the maximum number of result to return.start
- the index of the first found user to return.
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllLocalUsers() throws XWikiException
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllMatchedLocalUsers(Map<?,?> matchFields) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllMatchedLocalUsers(Map<?,?> matchFields, int nb, int start) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found user to return.
List
of Document
containing user.
XWikiException
- error when searching for users.public List<Document> getAllMatchedLocalUsers(Map<?,?> matchFields, int nb, int start, List<?> order) throws XWikiException
matchFields
- the fields to match. It is a Map with field name as key and for value :
nb
- the maximum number of result to return.start
- the index of the first found user to return.order
- the fields to order from. It is a List containing :
List
of Document
containing user.
XWikiException
- error when searching for users.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |