org.nuxeo.client.objects.user

Class Group

java.lang.Object

org.nuxeo.client.objects.AbstractBase<B>

org.nuxeo.client.objects.AbstractConnectable<A,B>

org.nuxeo.client.objects.ConnectableEntity<UserManagerAPI,Group>

org.nuxeo.client.objects.user.Group

All Implemented Interfaces:

Connectable

public class Group
extends ConnectableEntity<UserManagerAPI,Group>

Since:

0.1

Field Summary

Fields

Modifier and Type	Field and Description
protected String	groupLabel
protected String	groupName
protected List<String>	memberGroups
protected List<String>	memberUsers
protected List<String>	parentGroups

Fields inherited from class org.nuxeo.client.objects.ConnectableEntity

entityType

Fields inherited from class org.nuxeo.client.objects.AbstractConnectable

api, apiClass, nuxeoClient

Fields inherited from class org.nuxeo.client.objects.AbstractBase

headerInterceptors, headerValues, okhttpBuilder, retrofit, retrofitBuilder

Constructor Summary

Constructors

Constructor and Description
Group()

Method Summary

Modifier and Type	Method and Description
Groups	fetchMemberGroups() Returns a list of member groups fetched from server.
Users	fetchMemberUsers() Returns a list of member users fetched from server.
String	getGroupLabel()
String	getGroupName()
List<String>	getMemberGroups() Returns a list of member groups if information is returned by server.
List<String>	getMemberUsers() Returns a list of member users if information is returned by server.
List<String>	getParentGroups() Returns a list of parent groups if information is returned by server.
void	setGroupLabel(String groupLabel)
void	setGroupName(String groupName)
void	setMemberGroups(List<String> memberGroups) Sets the memberGroups to this object.
void	setMemberUsers(List<String> memberUsers) Sets the memberUsers to this object.
void	setParentGroups(List<String> parentGroups) Sets the parentGroups to this object.

Methods inherited from class org.nuxeo.client.objects.ConnectableEntity

getEntityType

Methods inherited from class org.nuxeo.client.objects.AbstractConnectable

buildRetrofit, fetchResponse, fetchResponse, reconnectWith

Methods inherited from class org.nuxeo.client.objects.AbstractBase

connectTimeout, depth, enrichers, enrichers, enrichersForDocument, fetchProperties, fetchProperties, fetchPropertiesForDocument, fetchPropertiesForGroup, header, header, header, header, header, header, header, readTimeout, replaceWith, schemas, schemas, timeout, transactionTimeout, version

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

groupName

protected String groupName

groupLabel

protected String groupLabel

memberUsers

protected List<String> memberUsers

memberGroups

protected List<String> memberGroups

parentGroups

protected List<String> parentGroups

Constructor Detail

Group

public Group()

Method Detail

getGroupName

public String getGroupName()

setGroupName

public void setGroupName(String groupName)

getGroupLabel

public String getGroupLabel()

setGroupLabel

public void setGroupLabel(String groupLabel)

getMemberUsers

public List<String> getMemberUsers()

Returns a list of member users if information is returned by server. This could be done by adding fetch.group=memberUsers header to request.

This could be achieved with client API like this:

 // if you want to apply header on all requests
 client.fetchPropertiesForGroup("memberUsers").userManager().fetchGroup("...");
 // if you want to apply header only on requests made by this userManager
 client.userManager().fetchPropertiesForGroup("memberUsers").fetchGroup("...");
 

Returns:

a list of member users

fetchMemberUsers

public Users fetchMemberUsers()

Returns a list of member users fetched from server. This method will perform a request and store the result on this object.

Returns:

a list of member users fetched from server

Since:

3.0

setMemberUsers

public void setMemberUsers(List<String> memberUsers)

Sets the memberUsers to this object. This method doesn't perform request to server. It must be used with UserManager.createGroup(Group) or UserManager.updateGroup(Group).

getMemberGroups

public List<String> getMemberGroups()

Returns a list of member groups if information is returned by server. This could be done by adding fetch.group=memberGroups header to request.

This could be achieved with client API like this:

 // if you want to apply header on all requests
 client.fetchPropertiesForGroup("memberGroups").userManager().fetchGroup("...");
 // if you want to apply header only on requests made by this userManager
 client.userManager().fetchPropertiesForGroup("memberGroups").fetchGroup("...");
 

Returns:

a list of member groups

fetchMemberGroups

public Groups fetchMemberGroups()

Returns a list of member groups fetched from server. This method will perform a request and store the result on this object.

Returns:

a list of member groups fetched from server

Since:

3.0

setMemberGroups

public void setMemberGroups(List<String> memberGroups)

Sets the memberGroups to this object. This method doesn't perform request to server. It must be used with UserManager.createGroup(Group) or UserManager.updateGroup(Group).

getParentGroups

public List<String> getParentGroups()

Returns a list of parent groups if information is returned by server. This could be done by adding fetch.group=parentGroups header to request.

This could be achieved with client API like this:

 // if you want to apply header on all requests
 client.fetchPropertiesForGroup("parentGroups").userManager().fetchGroup("...");
 // if you want to apply header only on requests made by this userManager
 client.userManager().fetchPropertiesForGroup("parentGroups").fetchGroup("...");
 

CAUTION: Only available for Nuxeo Server greater than LTS 2016 - 8.10-HF19

Returns:

a list of parent groups

Since:

3.0

setParentGroups

public void setParentGroups(List<String> parentGroups)

Sets the parentGroups to this object. This method doesn't perform request to server. It must be used with UserManager.createGroup(Group) or UserManager.updateGroup(Group).

CAUTION: Only available for Nuxeo Server greater than LTS 2016 - 8.10-HF19