org.apache.nifi.authorization.user

Interface NiFiUser

public interface NiFiUser

A representation of a NiFi user that has logged into the application

Method Summary

Modifier and Type	Method and Description
Set<String>	getAllGroups()
NiFiUser	getChain()
String	getClientAddress()
Set<String>	getGroups()
String	getIdentity()
Set<String>	getIdentityProviderGroups()
boolean	isAnonymous()

Method Detail

getIdentity

String getIdentity()

Returns:

the unique identity of this user

getGroups

Set<String> getGroups()

Returns:

the groups that this user belongs to if this nifi is configured to load user groups, null otherwise.

getIdentityProviderGroups

Set<String> getIdentityProviderGroups()

Returns:

the groups that this user belongs to if this nifi is configured to authenticate against an identity provider capable of returning group membership information in the authentication response

getAllGroups

Set<String> getAllGroups()

Returns:

the combined set of getGroups and getIdentityProviderGroups, all authorization checks should use this method to authorize against all know groups

getChain

NiFiUser getChain()

Returns:

the next user in the proxied entities chain, or null if no more users exist in the chain.

isAnonymous

boolean isAnonymous()

Returns:

true if the user is the unauthenticated Anonymous user

getClientAddress

String getClientAddress()

Returns:

the address of the client that made the request which created this user