Package org.apache.jackrabbit.oak.api
Interface AuthInfo
- All Known Implementing Classes:
AuthInfoImpl
public interface AuthInfo
AuthInfo
instances provide access to information related
to authentication and authorization of a given content session.
AuthInfo
instances are guaranteed to be immutable.-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescription@Nullable Object
getAttribute
(String attributeName) Returns the attribute with the given name ornull
if no attribute with thatattributeName
exists.@NotNull String[]
Returns the attribute names associated with this instance.Returns the set of principals associated with thisAuthInfo
instance.@Nullable String
Return the user ID to be exposed on the JCR Session object.
-
Field Details
-
EMPTY
-
-
Method Details
-
getUserID
Return the user ID to be exposed on the JCR Session object. It refers to the ID of the user associated with the Credentials passed to the repository login.- Returns:
- the user ID such as exposed on the JCR Session object.
-
getAttributeNames
Returns the attribute names associated with this instance.- Returns:
- The attribute names with that instance or an empty array if no attributes are present.
-
getAttribute
Returns the attribute with the given name ornull
if no attribute with thatattributeName
exists.- Parameters:
attributeName
- The attribute name.- Returns:
- The attribute or
null
.
-
getPrincipals
Returns the set of principals associated with thisAuthInfo
instance.- Returns:
- A set of principals.
-