Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- all() - Static method in class io.jenkins.plugins.authcommons.PrincipalSearchProvider
- avatarUrl() - Method in record class io.jenkins.plugins.authcommons.Principal
-
Returns the value of the
avatarUrlrecord component.
D
- DEFAULT_LIMIT - Static variable in class io.jenkins.plugins.authcommons.PrincipalSearch
- description() - Method in record class io.jenkins.plugins.authcommons.Principal
-
Returns the value of the
descriptionrecord component. - displayName() - Method in record class io.jenkins.plugins.authcommons.Principal
-
Returns the value of the
displayNamerecord component.
E
- equals(Object) - Method in record class io.jenkins.plugins.authcommons.Principal
-
Indicates whether some other object is "equal to" this one.
G
- group(String, String, String) - Static method in record class io.jenkins.plugins.authcommons.Principal
- GROUP - Enum constant in enum class io.jenkins.plugins.authcommons.PrincipalType
H
- hashCode() - Method in record class io.jenkins.plugins.authcommons.Principal
-
Returns a hash code value for this object.
I
- io.jenkins.plugins.authcommons - package io.jenkins.plugins.authcommons
- isApplicable(SecurityRealm) - Method in class io.jenkins.plugins.authcommons.PrincipalSearchProvider
-
Whether this provider can search the given security realm.
- isAvailable() - Static method in class io.jenkins.plugins.authcommons.PrincipalSearch
-
Whether any provider can search the current security realm.
L
- lookup(String, PrincipalType) - Static method in class io.jenkins.plugins.authcommons.PrincipalSearch
-
Look up a principal by SID using the applicable providers.
- lookup(String, PrincipalType) - Method in class io.jenkins.plugins.authcommons.PrincipalSearchProvider
-
Look up a single principal by SID, so that a friendly name can be shown for SIDs that are not meaningful by themselves (such as object ids).
M
- MAX_LIMIT - Static variable in class io.jenkins.plugins.authcommons.PrincipalSearch
- MIN_QUERY_LENGTH - Static variable in class io.jenkins.plugins.authcommons.PrincipalSearch
-
Queries shorter than this return no results.
P
- Principal - Record Class in io.jenkins.plugins.authcommons
-
A user or group known to the security realm, as returned by a
PrincipalSearchProvider. - Principal(String, PrincipalType, String, String) - Constructor for record class io.jenkins.plugins.authcommons.Principal
- Principal(String, PrincipalType, String, String, String) - Constructor for record class io.jenkins.plugins.authcommons.Principal
-
Creates an instance of a
Principalrecord class. - PrincipalSearch - Class in io.jenkins.plugins.authcommons
-
Entry point for authorization strategies to search the configured security realm for users and groups.
- PrincipalSearchProvider - Class in io.jenkins.plugins.authcommons
-
Looks up users and groups in a directory, so that authorization strategies can offer autocompletion when choosing who gets access.
- PrincipalSearchProvider() - Constructor for class io.jenkins.plugins.authcommons.PrincipalSearchProvider
- PrincipalType - Enum Class in io.jenkins.plugins.authcommons
-
The kind of security principal a SID refers to.
S
- search(String, Set<PrincipalType>, int) - Static method in class io.jenkins.plugins.authcommons.PrincipalSearch
-
Search all applicable providers.
- search(String, Set<PrincipalType>, int) - Method in class io.jenkins.plugins.authcommons.PrincipalSearchProvider
-
Search for principals matching a query.
- searchResponse(String, String, Integer) - Static method in class io.jenkins.plugins.authcommons.PrincipalSearch
-
Build a JSON response for a search request, of the form
{"results": [{"sid", "type", "displayName", "description"}]}. - sid() - Method in record class io.jenkins.plugins.authcommons.Principal
-
Returns the value of the
sidrecord component.
T
- toJson() - Method in record class io.jenkins.plugins.authcommons.Principal
- toString() - Method in record class io.jenkins.plugins.authcommons.Principal
-
Returns a string representation of this record class.
- type() - Method in record class io.jenkins.plugins.authcommons.Principal
-
Returns the value of the
typerecord component.
U
- user(String, String, String) - Static method in record class io.jenkins.plugins.authcommons.Principal
- USER - Enum constant in enum class io.jenkins.plugins.authcommons.PrincipalType
V
- valueOf(String) - Static method in enum class io.jenkins.plugins.authcommons.PrincipalType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.jenkins.plugins.authcommons.PrincipalType
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- withAvatarUrl(String) - Method in record class io.jenkins.plugins.authcommons.Principal
All Classes and Interfaces|All Packages|Constant Field Values