Module org.elasticsearch.xcore
Interface RoleReference
- All Known Implementing Classes:
RoleReference.ApiKeyRoleReference,RoleReference.BwcApiKeyRoleReference,RoleReference.CrossClusterAccessRoleReference,RoleReference.CrossClusterApiKeyRoleReference,RoleReference.FixedRoleReference,RoleReference.NamedRoleReference,RoleReference.ServiceAccountRoleReference
public interface RoleReference
RoleReference is a handle to the actual role definitions (role descriptors).
It has different sub-types depending on how the role descriptors should be resolved.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classReferencing API Key role descriptors.static enumThe type of one set of API key roles.static final classSame asRoleReference.ApiKeyRoleReferencebut for BWC purpose (prior to v7.9.0)static final classRepresents the role descriptors sent from the querying cluster to the fulfilling cluster as part of API key authentication based cross cluster operations.static final classRepresents the role descriptors of the cross-cluster API key underlying an API key authentication based remote cluster connection.static final classstatic final classReferencing a collection of role descriptors by their namesstatic final classReferencing role descriptors by the service account principal -
Method Summary
Modifier and TypeMethodDescriptionid()Unique ID of the instance.voidresolve(RoleReferenceResolver resolver, ActionListener<RolesRetrievalResult> listener) Resolve concrete role descriptors for the roleReference.
-
Method Details
-
id
RoleKey id()Unique ID of the instance. Instances that have equal ID means they are equivalent in terms of authorization. It is currently used as cache key for role caching purpose. Callers can use this value to determine whether it should skip resolving the role descriptors and subsequently building the role. -
resolve
Resolve concrete role descriptors for the roleReference.
-