public abstract class GroupDetails extends Object
UserDetails
Constructor and Description |
---|
GroupDetails() |
Modifier and Type | Method and Description |
---|---|
String |
getDisplayName()
Returns the human-readable name used for rendering in HTML.
|
Set<String> |
getMembers()
Returns the members of the group, or
null if the members were not retrieved. |
abstract String |
getName()
Returns the name of the group.
|
public abstract String getName()
public String getDisplayName()
This may contain arbitrary character, and it can change.
public Set<String> getMembers()
null
if the members were not retrieved. The results of this method
are not live, they represent the membership at the time the GroupDetails
was instantiated. As fetching
the membership of a group can be an expensive operation, it is preferential to use the
SecurityRealm.loadGroupByGroupname(String, boolean)
method to retrieve GroupDetails
in those
cases where you want to try and retrieve the members of the group, though even that method does not guarantee
to retrieve the members of a group as the backing SecurityRealm
implementation may not support such
a query.GroupDetails
were retrieved, or
null
if the members were not retrieved.Copyright © 2016. All rights reserved.