Package org.apache.nifi.authorization

Class FileUserGroupProvider

java.lang.Object

org.apache.nifi.authorization.FileUserGroupProvider

All Implemented Interfaces:

ConfigurableUserGroupProvider, UserGroupProvider

public class FileUserGroupProvider
extends Object
implements ConfigurableUserGroupProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	FileUserGroupProvider.UsersAndGroups

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	GROUP_ELEMENT
private static final String	GROUP_USER_ELEMENT
private static final String	IDENTIFIER_ATTR
private static final String	IDENTITY_ATTR
(package private) static final Pattern	INITIAL_USER_IDENTITY_PATTERN
private Set<String>	initialUserIdentities
private static final jakarta.xml.bind.JAXBContext	JAXB_TENANTS_CONTEXT
private static final String	JAXB_TENANTS_PATH
private static final org.slf4j.Logger	logger
private static final String	NAME_ATTR
(package private) static final String	PROP_INITIAL_USER_IDENTITY_PREFIX
(package private) static final String	PROP_TENANTS_FILE
private NiFiProperties	properties
private File	restoreTenantsFile
private static final String	TENANTS_XSD
private File	tenantsFile
private Schema	tenantsSchema
private static final String	USER_ELEMENT
private final AtomicReference<UserGroupHolder>	userGroupHolder
private static final XMLOutputFactory	XML_OUTPUT_FACTORY

Constructor Summary

Constructors

Constructor	Description
FileUserGroupProvider()

Method Summary

Modifier and Type	Method	Description
Group	addGroup(Group group)
User	addUser(User user)
private void	addUsersAndGroups(FileUserGroupProvider.UsersAndGroups usersAndGroups)
void	backupUsersAndGroups()
void	checkInheritability(String proposedFingerprint)
private User	createJAXBUser(User user)
private void	createUser(Tenants tenants, String userIdentity)	Finds the User with the given identity, or creates a new one and adds it to the Tenants.
Group	deleteGroup(Group group)
User	deleteUser(User user)
void	forciblyInheritFingerprint(String fingerprint)
String	getFingerprint()
Group	getGroup(String identifier)
Group	getGroupByName(String name)
Set<Group>	getGroups()
User	getUser(String identifier)
UserAndGroups	getUserAndGroups(String identity)
User	getUserByIdentity(String identity)
(package private) UserGroupHolder	getUserGroupHolder()
Set<User>	getUsers()
private void	inherit(FileUserGroupProvider.UsersAndGroups usersAndGroups)
void	inheritFingerprint(String fingerprint)
void	initialize(UserGroupProviderInitializationContext initializationContext)
private static jakarta.xml.bind.JAXBContext	initializeJaxbContext()	Load the JAXBContext.
private boolean	isInheritable()
private void	load()	Loads the authorizations file and populates the AuthorizationsHolder, only called during start-up.
void	onConfigured(AuthorizerConfigurationContext configurationContext)
private Group	parseGroup(Element element)
private User	parseUser(Element element)
private FileUserGroupProvider.UsersAndGroups	parseUsersAndGroups(String fingerprint)
private void	populateInitialUsers(Tenants tenants)
void	preDestruction()
void	purgeUsersAndGroups()
private void	saveAndRefreshHolder(Tenants tenants)	Saves the Authorizations instance by marshalling to a file, then re-populates the in-memory data structures and sets the new holder.
private void	saveTenants(Tenants tenants)
private void	saveTenants(Tenants tenants, File destinationFile)
void	setNiFiProperties(NiFiProperties properties)
private Tenants	unmarshallTenants()
Group	updateGroup(Group group)
User	updateUser(User user)
private void	writeGroup(XMLStreamWriter writer, Group group)
private void	writeUser(XMLStreamWriter writer, User user)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.authorization.ConfigurableUserGroupProvider

isConfigurable, isConfigurable

Field Details

logger

private static final org.slf4j.Logger logger

TENANTS_XSD

private static final String TENANTS_XSD

See Also:

• Constant Field Values

JAXB_TENANTS_PATH

private static final String JAXB_TENANTS_PATH

See Also:

• Constant Field Values

JAXB_TENANTS_CONTEXT

private static final jakarta.xml.bind.JAXBContext JAXB_TENANTS_CONTEXT

XML_OUTPUT_FACTORY

private static final XMLOutputFactory XML_OUTPUT_FACTORY

USER_ELEMENT

private static final String USER_ELEMENT

See Also:

• Constant Field Values

GROUP_USER_ELEMENT

private static final String GROUP_USER_ELEMENT

See Also:

• Constant Field Values

GROUP_ELEMENT

private static final String GROUP_ELEMENT

See Also:

• Constant Field Values

IDENTIFIER_ATTR

private static final String IDENTIFIER_ATTR

See Also:

• Constant Field Values

IDENTITY_ATTR

private static final String IDENTITY_ATTR

See Also:

• Constant Field Values

NAME_ATTR

private static final String NAME_ATTR

See Also:

• Constant Field Values

PROP_INITIAL_USER_IDENTITY_PREFIX

static final String PROP_INITIAL_USER_IDENTITY_PREFIX

See Also:

• Constant Field Values

PROP_TENANTS_FILE

static final String PROP_TENANTS_FILE

See Also:

• Constant Field Values

INITIAL_USER_IDENTITY_PATTERN

static final Pattern INITIAL_USER_IDENTITY_PATTERN

tenantsSchema

private Schema tenantsSchema

properties

private NiFiProperties properties

tenantsFile

private File tenantsFile

restoreTenantsFile

private File restoreTenantsFile

initialUserIdentities

private Set<String> initialUserIdentities

userGroupHolder

private final AtomicReference<UserGroupHolder> userGroupHolder

Constructor Details

FileUserGroupProvider

public FileUserGroupProvider()

Method Details

initializeJaxbContext

private static jakarta.xml.bind.JAXBContext initializeJaxbContext()

Load the JAXBContext.

initialize

public void initialize(UserGroupProviderInitializationContext initializationContext)
                throws AuthorizerCreationException

Specified by:

initialize in interface UserGroupProvider

Throws:

AuthorizerCreationException

onConfigured

public void onConfigured(AuthorizerConfigurationContext configurationContext)
                  throws AuthorizerCreationException

Specified by:

onConfigured in interface UserGroupProvider

Throws:

AuthorizerCreationException

getUsers

public Set<User> getUsers()
                   throws AuthorizationAccessException

Specified by:

getUsers in interface UserGroupProvider

Throws:

AuthorizationAccessException

addUser

public User addUser(User user)
             throws AuthorizationAccessException

Specified by:

addUser in interface ConfigurableUserGroupProvider

Throws:

AuthorizationAccessException

getUser

public User getUser(String identifier)
             throws AuthorizationAccessException

Specified by:

getUser in interface UserGroupProvider

Throws:

AuthorizationAccessException

updateUser

public User updateUser(User user)
                throws AuthorizationAccessException

Specified by:

updateUser in interface ConfigurableUserGroupProvider

Throws:

AuthorizationAccessException

getUserByIdentity

public User getUserByIdentity(String identity)
                       throws AuthorizationAccessException

Specified by:

getUserByIdentity in interface UserGroupProvider

Throws:

AuthorizationAccessException

deleteUser

public User deleteUser(User user)
                throws AuthorizationAccessException

Specified by:

deleteUser in interface ConfigurableUserGroupProvider

Throws:

AuthorizationAccessException

getGroups

public Set<Group> getGroups()
                     throws AuthorizationAccessException

Specified by:

getGroups in interface UserGroupProvider

Throws:

AuthorizationAccessException

addUsersAndGroups

private void addUsersAndGroups(FileUserGroupProvider.UsersAndGroups usersAndGroups)

addGroup

public Group addGroup(Group group)
               throws AuthorizationAccessException

Specified by:

addGroup in interface ConfigurableUserGroupProvider

Throws:

AuthorizationAccessException

getGroup

public Group getGroup(String identifier)
               throws AuthorizationAccessException

Specified by:

getGroup in interface UserGroupProvider

Throws:

AuthorizationAccessException

getGroupByName

public Group getGroupByName(String name)
                     throws AuthorizationAccessException

Specified by:

getGroupByName in interface UserGroupProvider

Throws:

AuthorizationAccessException

getUserAndGroups

public UserAndGroups getUserAndGroups(String identity)
                               throws AuthorizationAccessException

Specified by:

getUserAndGroups in interface UserGroupProvider

Throws:

AuthorizationAccessException

updateGroup

public Group updateGroup(Group group)
                  throws AuthorizationAccessException

Specified by:

updateGroup in interface ConfigurableUserGroupProvider

Throws:

AuthorizationAccessException

deleteGroup

public Group deleteGroup(Group group)
                  throws AuthorizationAccessException

Specified by:

deleteGroup in interface ConfigurableUserGroupProvider

Throws:

AuthorizationAccessException

getUserGroupHolder

UserGroupHolder getUserGroupHolder()

setNiFiProperties

@AuthorizerContext
public void setNiFiProperties(NiFiProperties properties)

inheritFingerprint

public void inheritFingerprint(String fingerprint)
                        throws AuthorizationAccessException

Specified by:

inheritFingerprint in interface ConfigurableUserGroupProvider

Throws:

AuthorizationAccessException

inherit

private void inherit(FileUserGroupProvider.UsersAndGroups usersAndGroups)

forciblyInheritFingerprint

public void forciblyInheritFingerprint(String fingerprint)
                                throws AuthorizationAccessException

Specified by:

forciblyInheritFingerprint in interface ConfigurableUserGroupProvider

Throws:

AuthorizationAccessException

backupUsersAndGroups

public void backupUsersAndGroups()
                          throws AuthorizationAccessException

Throws:

AuthorizationAccessException

purgeUsersAndGroups

public void purgeUsersAndGroups()

checkInheritability

public void checkInheritability(String proposedFingerprint)
                         throws AuthorizationAccessException

Specified by:

checkInheritability in interface ConfigurableUserGroupProvider

Throws:

AuthorizationAccessException

isInheritable

private boolean isInheritable()

getFingerprint

public String getFingerprint()
                      throws AuthorizationAccessException

Specified by:

getFingerprint in interface ConfigurableUserGroupProvider

Throws:

AuthorizationAccessException

parseUsersAndGroups

private FileUserGroupProvider.UsersAndGroups parseUsersAndGroups(String fingerprint)

parseUser

private User parseUser(Element element)

parseGroup

private Group parseGroup(Element element)

writeUser

private void writeUser(XMLStreamWriter writer,
 User user)
                throws XMLStreamException

Throws:

XMLStreamException

writeGroup

private void writeGroup(XMLStreamWriter writer,
 Group group)
                 throws XMLStreamException

Throws:

XMLStreamException

createJAXBUser

private User createJAXBUser(User user)

load

private void load()
           throws jakarta.xml.bind.JAXBException,
IllegalStateException

Loads the authorizations file and populates the AuthorizationsHolder, only called during start-up.

Throws:

jakarta.xml.bind.JAXBException - Unable to reload the authorized users file

IllegalStateException - Unable to sync file with restore

saveTenants

private void saveTenants(Tenants tenants)
                  throws jakarta.xml.bind.JAXBException

Throws:

jakarta.xml.bind.JAXBException

saveTenants

private void saveTenants(Tenants tenants,
 File destinationFile)
                  throws jakarta.xml.bind.JAXBException

Throws:

jakarta.xml.bind.JAXBException

unmarshallTenants

private Tenants unmarshallTenants()
                           throws jakarta.xml.bind.JAXBException

Throws:

jakarta.xml.bind.JAXBException

populateInitialUsers

private void populateInitialUsers(Tenants tenants)

createUser

private void createUser(Tenants tenants,
 String userIdentity)

Finds the User with the given identity, or creates a new one and adds it to the Tenants.

Parameters:

tenants - the Tenants reference

userIdentity - the user identity to find or create

saveAndRefreshHolder

private void saveAndRefreshHolder(Tenants tenants)
                           throws AuthorizationAccessException

Saves the Authorizations instance by marshalling to a file, then re-populates the in-memory data structures and sets the new holder. Synchronized to ensure only one thread writes the file at a time.

Parameters:

tenants - the tenants to save and populate from

Throws:

AuthorizationAccessException - if an error occurs saving the authorizations

preDestruction

public void preDestruction()
                    throws AuthorizerDestructionException

Specified by:

preDestruction in interface UserGroupProvider

Throws:

AuthorizerDestructionException