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

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, or null if the members were not retrieved.
abstract String	getName()	Returns the name of the group.

Methods inherited from class java.lang.Object

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

Constructor Details

GroupDetails

public GroupDetails()

Method Details

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, or 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.

Returns:

the members of the group at the point in time when the GroupDetails were retrieved, or null if the members were not retrieved.

Since:

1.549