Package hudson.security
Class GroupDetails
- java.lang.Object
-
- hudson.security.GroupDetails
-
public abstract class GroupDetails extends Object
Represents the details of a group.- Since:
- 1.280
- Author:
- Kohsuke Kawaguchi
- See Also:
UserDetails
-
-
Constructor Summary
Constructors Constructor Description GroupDetails()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description String
getDisplayName()
Returns the human-readable name used for rendering in HTML.Set<String>
getMembers()
Returns the members of the group, ornull
if the members were not retrieved.abstract String
getName()
Returns the name of the group.
-
-
-
Method Detail
-
getName
public abstract String getName()
Returns the name of the group.- Returns:
- never null.
-
getDisplayName
public String getDisplayName()
Returns the human-readable name used for rendering in HTML.This may contain arbitrary character, and it can change.
- Returns:
- never null.
-
getMembers
public Set<String> getMembers()
Returns the members of the group, ornull
if the members were not retrieved. The results of this method are not live, they represent the membership at the time theGroupDetails
was instantiated. As fetching the membership of a group can be an expensive operation, it is preferential to use theSecurityRealm.loadGroupByGroupname(String, boolean)
method to retrieveGroupDetails
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 backingSecurityRealm
implementation may not support such a query.- Returns:
- the members of the group at the point in time when the
GroupDetails
were retrieved, ornull
if the members were not retrieved. - Since:
- 1.549
-
-