|
||||||||||
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.PluginApi<RightsManagerPlugin>
com.xpn.xwiki.plugin.rightsmanager.RightsManagerPluginApi
public class RightsManagerPluginApi
API for managing rights, users and groups.
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 | |
---|---|
RightsManagerPluginApi(RightsManagerPlugin plugin,
XWikiContext context)
Create an instance of the Rights Manager plugin user api. |
Method Summary | |
---|---|
int |
countAllGroupsNamesForMember(String member)
Return the number of groups containing provided member. |
int |
countAllMembersNamesForGroup(String group)
Return the number of members provided group contains. |
Collection<String> |
getAllGroupsNamesForMember(String member)
Get all groups containing provided user. |
Collection<String> |
getAllMatchedMembersNamesForGroup(String group,
String matchField,
int nb,
int start,
Boolean orderAsc)
Get members of provided group. |
Collection<String> |
getAllMembersNamesForGroup(String group)
Get all members (users or groups) provided group contains. |
Collection<String> |
getAllMembersNamesForGroup(String group,
int nb,
int start)
Get all members (users or groups) provided group contains. |
RightsManagerGroupsApi |
getGroupsApi()
|
RightsManagerRightsApi |
getRightsApi()
|
RightsManagerUsersApi |
getUsersApi()
|
Methods inherited from class com.xpn.xwiki.plugin.PluginApi |
---|
getInternalPlugin, getProtectedPlugin, setPlugin |
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 RightsManagerPluginApi(RightsManagerPlugin plugin, XWikiContext context)
plugin
- the entry point of the Rights Manager plugin.context
- the XWiki context.Method Detail |
---|
public RightsManagerRightsApi getRightsApi()
public RightsManagerUsersApi getUsersApi()
public RightsManagerGroupsApi getGroupsApi()
public Collection<String> getAllGroupsNamesForMember(String member) throws XWikiException
member
- the name of the member (user or group).
Collection
of String
containing group name.
XWikiException
- error when browsing groups.public Collection<String> getAllMembersNamesForGroup(String group) throws XWikiException
group
- the name of the group.
Collection
of String
containing member (user or group) name.
XWikiException
- error when browsing groups.public Collection<String> getAllMembersNamesForGroup(String group, int nb, int start) throws XWikiException
group
- the name of the group.nb
- the maximum number of result to return.start
- the index of the first found user to return.
Collection
of String
containing member (user or group) name.
XWikiException
- error when browsing groups.public Collection<String> getAllMatchedMembersNamesForGroup(String group, String matchField, int nb, int start, Boolean orderAsc) throws XWikiException
group
- the group.matchField
- a string to search in result to filter.nb
- the maximum number of result to return.start
- the index of the first found user to return.orderAsc
- if true, the result is ordered ascendent, if false it descendant. If null no order is applied.
Collection
of String
containing member name.
XWikiException
- error when browsing groups.public int countAllGroupsNamesForMember(String member) throws XWikiException
member
- the name of the member (user or group).
XWikiException
- error when getting number of users.public int countAllMembersNamesForGroup(String group) throws XWikiException
group
- the name of the group.
XWikiException
- error when getting number of groups.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |