Class MysqlDbAclProvider
java.lang.Object
com.illumon.iris.db.v2.permissions.MysqlDbAclProvider
- All Implemented Interfaces:
com.fishlib.auth.AuthModule
,DbAclProvider
,DbAclWriter
,Closeable
,AutoCloseable
- Direct Known Subclasses:
MysqlDbAclGuiHelper
,UnauthenticatedPermissionFilterProviderMysqlImpl
public class MysqlDbAclProvider extends Object implements DbAclProvider, com.fishlib.auth.AuthModule, Closeable
Access to the MySQL ACL database.
This class implements DbAclProvider, AuthModule, and DbAclWriter and serves as the basis for the Mysql permission
filter provider, as well as the GUI helper. Anything that talks to the MySql ACL database should use or extend it.
The class is configured with properties:
MysqlDbAclProvider.host - the mysql host to connect to
MysqlDbAclProvider.db - the database containing our ACL tables
MysqlDbAclProvider.user - username for MySQL connection
MysqlDbAclProvider.ssl - SSL connectivity to MySQL (not yet tested in a production environment)
The MySQL password is stored as a base64 encoded string, either in a file (which takes precedence) referenced by:
environment variable
MYSQLDBACLPROVIDER.PASS
or in the file identified by
MysqlDbAclProvider.passwordFile
or within a property itself
MysqlDbAclProvider.pass
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MysqlDbAclProvider.NamedPreparedStatement
protected static interface
MysqlDbAclProvider.SQLFunction<R>
protected static interface
MysqlDbAclProvider.SQLProcedure
-
Field Summary
Fields Modifier and Type Field Description protected Connection
mysqlConnection
static String
PASSWORD_ENV
-
Constructor Summary
Constructors Constructor Description MysqlDbAclProvider(com.fishlib.io.logger.Logger log)
MysqlDbAclProvider(com.fishlib.io.logger.Logger log, boolean readOnly)
-
Method Summary
Modifier and Type Method Description int
addAcl(String group, String ns, String table, String acl)
Adds an ACL entry.int
addColumnAcl(String group, String ns, String table, String columns, String acl)
Adds a Column ACL entry.void
addGroupStrategy(String group, String strategy)
For AccountFilterGenerator() there are two levels of mappings.int
addInputTableEditor(String group, String ns, String table, boolean canEdit)
Adds an entry to the ACL database for editing an input table.void
addMembership(String user, List<String> groups)
Adds a user to a list of groups If the user could not be added to all of the groups, a RuntimeException is thrown.int
addOrUpdateSystemUserAcl(String user, String systemUser)
Inserts or Updates an entry to the ACL database for run-as mappingvoid
addStrategyAccount(String strategy, String account)
For AccountFilterGenerator() there are two levels of mappings.int
addSystemAcl(String group, String key, String acl)
Adds a system ACL entry.void
addUser(String user, String passwordHash)
Adds a user to the Iris system.boolean
canAnyoneEditInputTable(String namespace, String tableName)
Checks whether an input table can be edited by all usersboolean
canEditInputTable(String effectiveUser, String namespace, String tableName)
Checks whether a user has rights to edit an input tablevoid
changePassword(String user, String passwordHash)
Changes the password of a user entry in passwdvoid
close()
void
deleteAcls(String group, String ns, String table)
Deletes an ACL entry for a group and table.void
deleteAllAclData()
Deletes all data in the ACL store.void
deleteColumnAcls(String group, String ns, String table, String columns)
Deletes a Column ACL entry for a group, table, and column set.void
deleteGroup(String group)
Deletes a group.void
deleteGroupStrategy(String group, String strategy)
For AccountFilterGenerator() there are two levels of mappings.void
deleteInputTableEditor(String group, String ns, String table)
Deletes an entry to the ACL database for editing an input table.void
deleteStrategyAccount(String strategy, String account)
For AccountFilterGenerator() there are two levels of mappings.void
deleteSystemAcls(String group, String key)
Deletes a system ACL entry for a group and key.void
deleteSystemUserAcl(String user)
Removes an entry from the ACL database for run-as mappingvoid
deleteUser(String user)
The user is deleted.String[]
getAccountsForGroup(String group)
Retrieves all strategy accounts associated with a particular groupString[]
getAccountsForStrategy(String strategy)
Retrieves all strategy accounts associated with a particular strategyString[]
getAccountsForUser(String effectiveUser)
Retrieves all strategy accounts associated with a user, directly or through group membershipString[]
getAllAccounts()
Retrieves all strategy accounts in the systemString[]
getAllGroups()
Retrieves all groups accounts in the systemString[]
getAllStrategies()
Retrieves all strategy names by unioning strategies in strategyaccount with those in groupstrategyString[]
getAllUsers()
Retrieves all user accounts in the systemstatic String
getEncodedPassword()
Retrieve the stored password for connecting to the MySQL ACL database, leaving it encodedList<PermissionFilterProvider.FilterDetails>
getFilterDetailsForUser(com.fishlib.auth.UserContext userContext)
Gets the tableacls permissions filters for an effective userString[]
getGroupsForUser(String effectiveUser)
Get the groups to which a user is mappedList<com.fishlib.base.Pair<String,String>>
getPasswdsForMigration()
Returns user and password entries from the passwd table.String
getRunAsUser(String effectiveUser)
Returns the systemuser to which the effectiveUser is mapped, or null if no mapping exists.Map<String,String>
getRunAsUserMap()
Returns a map of user names to systemuser namesString[]
getStrategiesForGroup(String group)
Retrieves all strategies associated with a particular groupString[]
getStrategiesForUser(String effectiveUser)
Retrieves all strategies associated with a particular user, either directly or through group membershipString[]
getStrategyForAccount(String account)
Retrieves all strategies associated with a particular strategy accountString[]
getSystemUsers()
Returns an array of systemusers.String[]
getUsersForGroup(String group)
Get the users that are members of a groupboolean
groupStrategyExists(String groupName, String strategy)
Checks whether a particular association of a group and a strategy existsboolean
isUserPassValid(String username, String password)
void
removeMembership(String user, List<String> groups)
Removes a user from a list of groups.Map<String,List<com.fishlib.base.Pair<String,String>>>
retrieveColumnAcls(String effectiveUser, String namespace, String tableName)
Returns the most specific columnacl per group for a specific user, namespace, and table.Collection<String>
retrieveRowAcls(String effectiveUser, String namespace, String tableName)
Returns the most specific tableacl per group for a specific user, namespace, and table.Collection<String>
retrieveSystemAcls(String effectiveUser, String key)
Retrieve the set of system ACLs that modify system behavior rather than table access.protected <R> R
runFunctionWithSqlRetry(MysqlDbAclProvider.SQLFunction<R> function)
protected void
runProcedureWithSqlRetry(MysqlDbAclProvider.SQLProcedure procedure)
int
updateAcl(String group, String ns, String table, String acl)
Changes an already existent ACL entry.int
updateColumnAcl(String group, String ns, String table, String columns, String acl)
Changes an already existent Column ACL entry.int
updateInputTableEditor(String group, String ns, String table, boolean canEdit)
Updates an entry to the ACL database for editing an input table.int
updateSystemAcl(String group, String key, String acl)
Changes an already existent system ACL entry.boolean
userExists(String username)
-
Field Details
-
PASSWORD_ENV
- See Also:
- Constant Field Values
-
mysqlConnection
-
-
Constructor Details
-
MysqlDbAclProvider
public MysqlDbAclProvider(com.fishlib.io.logger.Logger log) -
MysqlDbAclProvider
public MysqlDbAclProvider(com.fishlib.io.logger.Logger log, boolean readOnly)
-
-
Method Details
-
getEncodedPassword
Retrieve the stored password for connecting to the MySQL ACL database, leaving it encoded- Returns:
- the still-encoded representation of the password for connecting to the MySQL ACL database.
-
close
public void close()- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceDbAclProvider
-
getFilterDetailsForUser
@NotNull public List<PermissionFilterProvider.FilterDetails> getFilterDetailsForUser(com.fishlib.auth.UserContext userContext)Description copied from interface:DbAclProvider
Gets the tableacls permissions filters for an effective user- Specified by:
getFilterDetailsForUser
in interfaceDbAclProvider
- Parameters:
userContext
- TheUserContext
from which the effective user name to filter will be obtained- Returns:
- A List of
PermissionFilterProvider.FilterDetails
for the effective user
-
retrieveRowAcls
@NotNull public Collection<String> retrieveRowAcls(String effectiveUser, String namespace, String tableName)Description copied from interface:DbAclProvider
Returns the most specific tableacl per group for a specific user, namespace, and table.- Specified by:
retrieveRowAcls
in interfaceDbAclProvider
- Parameters:
effectiveUser
- the user for which acls should be retrievednamespace
- the namespace specifically for which acls should be retrieved - will also match * in tableaclstableName
- the table name specifically for which acls should be retrieved - will also match * in tableacls- Returns:
- A Collection of tableacls filters.
-
retrieveColumnAcls
@NotNull public Map<String,List<com.fishlib.base.Pair<String,String>>> retrieveColumnAcls(String effectiveUser, String namespace, String tableName)Description copied from interface:DbAclProvider
Returns the most specific columnacl per group for a specific user, namespace, and table.- Specified by:
retrieveColumnAcls
in interfaceDbAclProvider
- Parameters:
effectiveUser
- the user for which acls should be retrievednamespace
- the namespace specifically for which acls should be retrieved - will also match * in columnaclstableName
- the table name specifically for which acls should be retrieved - will also match * in columnacls- Returns:
- A Map of group names to Lists of columns and filter pairs.
-
retrieveSystemAcls
Retrieve the set of system ACLs that modify system behavior rather than table access.- Specified by:
retrieveSystemAcls
in interfaceDbAclProvider
- Parameters:
effectiveUser
- The user to get ACLs forkey
- The lookup value that applies- Returns:
- A collection of strings representing the applicable ACLs.
-
canEditInputTable
Description copied from interface:DbAclProvider
Checks whether a user has rights to edit an input table- Specified by:
canEditInputTable
in interfaceDbAclProvider
- Parameters:
effectiveUser
- The user for whom permissions should be checkednamespace
- the namespace specifically for which acls should be retrieved - will also match * in inputtableeditorstableName
- the table name specifically for which acls should be retrieved - will also match * in inputtableeditors- Returns:
- True if the user has an effective canedit grant, otherwise false
-
canAnyoneEditInputTable
Description copied from interface:DbAclProvider
Checks whether an input table can be edited by all users- Specified by:
canAnyoneEditInputTable
in interfaceDbAclProvider
- Parameters:
namespace
- the namespace specifically for which acls should be retrieved - will also match * in inputtableeditorstableName
- the table name specifically for which acls should be retrieved - will also match * in inputtableeditors- Returns:
- True if the input table can be edited by all users, otherwise false
-
getAccountsForUser
Description copied from interface:DbAclProvider
Retrieves all strategy accounts associated with a user, directly or through group membership- Specified by:
getAccountsForUser
in interfaceDbAclProvider
- Parameters:
effectiveUser
- The user for whom strategy account access should be checked- Returns:
- An array of String of associated strategy accounts
-
getAllUsers
Description copied from interface:DbAclProvider
Retrieves all user accounts in the system- Specified by:
getAllUsers
in interfaceDbAclProvider
- Returns:
- An array of String of user names
-
getSystemUsers
Description copied from interface:DbAclProvider
Returns an array of systemusers.- Specified by:
getSystemUsers
in interfaceDbAclProvider
- Returns:
- A String array of distinct systemuser names, sorted.
-
getAllGroups
Description copied from interface:DbAclProvider
Retrieves all groups accounts in the system- Specified by:
getAllGroups
in interfaceDbAclProvider
- Returns:
- An array of String of groups names
-
getAllStrategies
Description copied from interface:DbAclProvider
Retrieves all strategy names by unioning strategies in strategyaccount with those in groupstrategy- Specified by:
getAllStrategies
in interfaceDbAclProvider
- Returns:
- An array of String of strategy names
- Throws:
SQLException
- In the case of SQL implementations of this interface if something goes wrong
-
getAllAccounts
Description copied from interface:DbAclProvider
Retrieves all strategy accounts in the system- Specified by:
getAllAccounts
in interfaceDbAclProvider
- Returns:
- An array of String of strategy account names
- Throws:
SQLException
- In the case of SQL implementations of this interface if something goes wrong
-
getAccountsForStrategy
Description copied from interface:DbAclProvider
Retrieves all strategy accounts associated with a particular strategy- Specified by:
getAccountsForStrategy
in interfaceDbAclProvider
- Parameters:
strategy
- The strategy name for which to filter accounts- Returns:
- An array of String of strategy account names
-
getStrategyForAccount
Description copied from interface:DbAclProvider
Retrieves all strategies associated with a particular strategy account- Specified by:
getStrategyForAccount
in interfaceDbAclProvider
- Parameters:
account
- The strategy account name for which to filter strategies- Returns:
- An array of String of strategy account names
-
getAccountsForGroup
Description copied from interface:DbAclProvider
Retrieves all strategy accounts associated with a particular group- Specified by:
getAccountsForGroup
in interfaceDbAclProvider
- Parameters:
group
- The group name for which to filter accounts- Returns:
- An array of String of strategy account names
-
getStrategiesForGroup
Description copied from interface:DbAclProvider
Retrieves all strategies associated with a particular group- Specified by:
getStrategiesForGroup
in interfaceDbAclProvider
- Parameters:
group
- The group name for which to filter strategies- Returns:
- An array of String of strategy names
-
groupStrategyExists
Description copied from interface:DbAclProvider
Checks whether a particular association of a group and a strategy exists- Specified by:
groupStrategyExists
in interfaceDbAclProvider
- Parameters:
groupName
- The group name to checkstrategy
- The strategy name to check- Returns:
- True if the mapping exists, false if it does not
-
userExists
- Specified by:
userExists
in interfacecom.fishlib.auth.AuthModule
-
isUserPassValid
- Specified by:
isUserPassValid
in interfacecom.fishlib.auth.AuthModule
-
getPasswdsForMigration
Returns user and password entries from the passwd table. Intended for use during ACL exports and/or data migration between MySQL and Etcd ACL stores.- Specified by:
getPasswdsForMigration
in interfaceDbAclProvider
- Returns:
- A
List
ofPair<String,String>
objects which contain a user and password entry.
-
runFunctionWithSqlRetry
protected <R> R runFunctionWithSqlRetry(MysqlDbAclProvider.SQLFunction<R> function) throws SQLException- Throws:
SQLException
-
runProcedureWithSqlRetry
protected void runProcedureWithSqlRetry(MysqlDbAclProvider.SQLProcedure procedure) throws SQLException- Throws:
SQLException
-
getGroupsForUser
Description copied from interface:DbAclProvider
Get the groups to which a user is mapped- Specified by:
getGroupsForUser
in interfaceDbAclProvider
- Parameters:
effectiveUser
- The String name of the user to find groups for- Returns:
- A String array of groups mapped to this user
-
getStrategiesForUser
Description copied from interface:DbAclProvider
Retrieves all strategies associated with a particular user, either directly or through group membership- Specified by:
getStrategiesForUser
in interfaceDbAclProvider
- Parameters:
effectiveUser
- The user for whom strategy access should be checked- Returns:
- An array of String of strategy names
-
getUsersForGroup
Description copied from interface:DbAclProvider
Get the users that are members of a group- Specified by:
getUsersForGroup
in interfaceDbAclProvider
- Parameters:
group
- The String name of the group to find users for- Returns:
- A String array of users with membership in this group
-
getRunAsUserMap
Description copied from interface:DbAclProvider
Returns a map of user names to systemuser names- Specified by:
getRunAsUserMap
in interfaceDbAclProvider
- Returns:
- a map of user names to systemuser names
-
getRunAsUser
Description copied from interface:DbAclProvider
Returns the systemuser to which the effectiveUser is mapped, or null if no mapping exists.- Specified by:
getRunAsUser
in interfaceDbAclProvider
- Parameters:
effectiveUser
- The user for which a mapped systemuser name should be retrieved.- Returns:
- the String systemuser to which the effectiveUser is mapped, or null if no mapping exists.
-
addMembership
Description copied from interface:DbAclWriter
Adds a user to a list of groups If the user could not be added to all of the groups, a RuntimeException is thrown.- Specified by:
addMembership
in interfaceDbAclWriter
- Parameters:
user
- the user to add to the groupsgroups
- a list of groups to add the user to- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
addUser
Description copied from interface:DbAclWriter
Adds a user to the Iris system.- Specified by:
addUser
in interfaceDbAclWriter
- Parameters:
user
- the user to add.passwordHash
- the APR1 hash of the user's password. Ignored if the system is not configured to manage user authentication.- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
changePassword
Description copied from interface:DbAclProvider
Changes the password of a user entry in passwd- Specified by:
changePassword
in interfaceDbAclProvider
- Specified by:
changePassword
in interfaceDbAclWriter
- Parameters:
user
- The user for which the password should be updatedpasswordHash
- The new password value to store- Throws:
SQLException
- In the case of SQL implementations of this interface if something goes wrong
-
removeMembership
Description copied from interface:DbAclWriter
Removes a user from a list of groups. It is possible that the user may be removed from some groups and not others. If the user could not be removed from all of the specified groups (e.g., because they are not a member of those groups), a runtime exception is thrown.- Specified by:
removeMembership
in interfaceDbAclWriter
- Parameters:
user
- the user to remove from groupsgroups
- a list of groups to remove the user from- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
deleteGroup
Description copied from interface:DbAclWriter
Deletes a group. The group is removed from all user to group mappings, all group to strategy mappings. All table ACLs and input table editors that reference the group are deleted.- Specified by:
deleteGroup
in interfaceDbAclWriter
- Parameters:
group
- the group to delete.- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
deleteUser
Description copied from interface:DbAclWriter
The user is deleted. Deletes the user's group, followed by deleting any other user to group associations for the user. If managed authentication is enabled, also deletes the user's password.- Specified by:
deleteUser
in interfaceDbAclWriter
- Parameters:
user
- the user to delete- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
addGroupStrategy
Description copied from interface:DbAclWriter
For AccountFilterGenerator() there are two levels of mappings. Group to strategy and strategy to account. This will add a group to the intermediate "strategy".- Specified by:
addGroupStrategy
in interfaceDbAclWriter
- Parameters:
group
- the group to map to a strategystrategy
- the strategy that the group is added to- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
deleteGroupStrategy
Description copied from interface:DbAclWriter
For AccountFilterGenerator() there are two levels of mappings. Group to strategy and strategy to account. This will remove a group from the intermediate "strategy".- Specified by:
deleteGroupStrategy
in interfaceDbAclWriter
- Parameters:
group
- the group to remove a mapping to a strategystrategy
- the strategy that the group is removed from- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
addStrategyAccount
Description copied from interface:DbAclWriter
For AccountFilterGenerator() there are two levels of mappings. Group to strategy and strategy to account. This will add an account to the intermediate "strategy".- Specified by:
addStrategyAccount
in interfaceDbAclWriter
- Parameters:
strategy
- the strategy that the account is added toaccount
- the account to add to a strategy- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
deleteStrategyAccount
Description copied from interface:DbAclWriter
For AccountFilterGenerator() there are two levels of mappings. Group to strategy and strategy to account. This will remove an account from the intermediate "strategy".- Specified by:
deleteStrategyAccount
in interfaceDbAclWriter
- Parameters:
strategy
- the strategy that the account is added toaccount
- the account to add to a strategy- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
addAcl
Description copied from interface:DbAclWriter
Adds an ACL entry. No ACL entry may currently exist for the group and table in question.- Specified by:
addAcl
in interfaceDbAclWriter
- Parameters:
group
- the group to add the entry forns
- the namespace to add the entry for ("*" for all namespaces)table
- the namespace to add the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")acl
- the ACL to add, see http://wiki.illumon.com/Iris/Permissions#Table_Access_Control_Lists_.28ACLs.29- Returns:
- the number of rows within the ACL database that were modified.
- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
updateAcl
Description copied from interface:DbAclWriter
Changes an already existent ACL entry. An ACL entry must currently exist for the group and table in question.- Specified by:
updateAcl
in interfaceDbAclWriter
- Parameters:
group
- the group to update the entry forns
- the namespace to update the entry for ("*" for all namespaces)table
- the namespace to update the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")acl
- the new ACL, see http://wiki.illumon.com/Iris/Permissions#Table_Access_Control_Lists_.28ACLs.29- Returns:
- the number of rows within the ACL database that were modified.
- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
deleteAcls
Description copied from interface:DbAclWriter
Deletes an ACL entry for a group and table.- Specified by:
deleteAcls
in interfaceDbAclWriter
- Parameters:
group
- the group to remove the entry forns
- the namespace to remove the entry for ("*" for all namespaces)table
- the namespace to remove the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
addColumnAcl
public int addColumnAcl(String group, String ns, String table, String columns, String acl) throws SQLExceptionDescription copied from interface:DbAclWriter
Adds a Column ACL entry. No ACL entry may currently exist for the group and table in question.- Specified by:
addColumnAcl
in interfaceDbAclWriter
- Parameters:
group
- the group to add the entry forns
- the namespace to add the entry for ("*" for all namespaces)table
- the namespace to add the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")columns
- the columns the ACL applies toacl
- the ACL to add, see http://wiki.illumon.com/Iris/Permissions#Table_Access_Control_Lists_.28ACLs.29- Returns:
- the number of rows within the ACL database that were modified.
- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
updateColumnAcl
public int updateColumnAcl(String group, String ns, String table, String columns, String acl) throws SQLExceptionDescription copied from interface:DbAclWriter
Changes an already existent Column ACL entry. An ACL entry must currently exist for the group, table, and column set in question.- Specified by:
updateColumnAcl
in interfaceDbAclWriter
- Parameters:
group
- the group to update the entry forns
- the namespace to update the entry for ("*" for all namespaces)table
- the namespace to update the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")columns
- the columns the ACL applies toacl
- the new ACL, see http://wiki.illumon.com/Iris/Permissions#Table_Access_Control_Lists_.28ACLs.29- Returns:
- the number of rows within the ACL database that were modified.
- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
deleteColumnAcls
public void deleteColumnAcls(String group, String ns, String table, String columns) throws SQLExceptionDescription copied from interface:DbAclWriter
Deletes a Column ACL entry for a group, table, and column set.- Specified by:
deleteColumnAcls
in interfaceDbAclWriter
- Parameters:
group
- the group to remove the entry forns
- the namespace to add the entry for ("*" for all namespaces)table
- the namespace to add the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")columns
- the applicable columne set- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
addSystemAcl
Description copied from interface:DbAclWriter
Adds a system ACL entry. No ACL entry may currently exist for the group and key in question.- Specified by:
addSystemAcl
in interfaceDbAclWriter
- Parameters:
group
- the group to add the entry forkey
- the key to add the entry for (wildcard not allowed)acl
- the ACL to add, see http://wiki.illumon.com/Iris/Permissions#Table_Access_Control_Lists_.28ACLs.29- Returns:
- the number of rows within the ACL database that were modified.
- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
updateSystemAcl
Description copied from interface:DbAclWriter
Changes an already existent system ACL entry. An ACL entry must currently exist for the group and key in question.- Specified by:
updateSystemAcl
in interfaceDbAclWriter
- Parameters:
group
- the group to update the entry forkey
- the key to update the entry for (no wildcard)acl
- the new ACL, see http://wiki.illumon.com/Iris/Permissions#Table_Access_Control_Lists_.28ACLs.29- Returns:
- the number of rows within the ACL database that were modified.
- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
deleteSystemAcls
Description copied from interface:DbAclWriter
Deletes a system ACL entry for a group and key.- Specified by:
deleteSystemAcls
in interfaceDbAclWriter
- Parameters:
group
- the group to remove the entry forkey
- the namespace to add the entry for (wildcard not allowed)- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
addInputTableEditor
public int addInputTableEditor(String group, String ns, String table, boolean canEdit) throws SQLExceptionDescription copied from interface:DbAclWriter
Adds an entry to the ACL database for editing an input table.- Specified by:
addInputTableEditor
in interfaceDbAclWriter
- Parameters:
group
- the group to add the entry forns
- the namespace to add the entry for ("*" for all namespaces)table
- the namespace to add the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")canEdit
- whether the table is editable for this group- Returns:
- the number of rows within the ACL database that were modified.
- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
updateInputTableEditor
public int updateInputTableEditor(String group, String ns, String table, boolean canEdit) throws SQLExceptionDescription copied from interface:DbAclWriter
Updates an entry to the ACL database for editing an input table.- Specified by:
updateInputTableEditor
in interfaceDbAclWriter
- Parameters:
group
- the group to update the entry forns
- the namespace to update the entry for ("*" for all namespaces)table
- the namespace to update the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")canEdit
- whether the table is editable for this group- Returns:
- the number of rows within the ACL database that were modified.
- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
deleteInputTableEditor
Description copied from interface:DbAclWriter
Deletes an entry to the ACL database for editing an input table.- Specified by:
deleteInputTableEditor
in interfaceDbAclWriter
- Parameters:
group
- the group to delete the entry forns
- the namespace to delete the entry for ("*" for all namespaces)table
- the namespace to delete the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
addOrUpdateSystemUserAcl
Description copied from interface:DbAclWriter
Inserts or Updates an entry to the ACL database for run-as mapping- Specified by:
addOrUpdateSystemUserAcl
in interfaceDbAclWriter
- Parameters:
user
- the user whose system-user mapping is to be updatedsystemUser
- the system-user which will be used for launching workers- Returns:
- the number of rows within the ACL database that were modified
- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
deleteSystemUserAcl
Description copied from interface:DbAclWriter
Removes an entry from the ACL database for run-as mapping- Specified by:
deleteSystemUserAcl
in interfaceDbAclWriter
- Parameters:
user
- the user whose system-user mapping is to be deleted- Throws:
SQLException
- if the underlying SQL operation could not be completed
-
deleteAllAclData
Deletes all data in the ACL store. Use judiciously.- Specified by:
deleteAllAclData
in interfaceDbAclWriter
- Throws:
SQLException
-