org.odpi.openmetadata.adapters.governanceenginesplugins.gaianrangerplugin

Class RangerPolicyResultFilter

java.lang.Object

com.ibm.gaiandb.policyframework.SQLResultFilterX

org.odpi.openmetadata.adapters.governanceenginesplugins.gaianrangerplugin.RangerPolicyResultFilter

All Implemented Interfaces:

com.ibm.gaiandb.policyframework.SQLResultFilter

public class RangerPolicyResultFilter
extends com.ibm.gaiandb.policyframework.SQLResultFilterX

Initial policy plugin for GaianDB Refer to the top level README.md in this project for further information on how to build, deploy and use

Field Summary

Fields inherited from class com.ibm.gaiandb.policyframework.SQLResultFilterX

COPYRIGHT_NOTICE, OP_ID_SET_ACCESS_CLUSTERS_RETURN_IS_QUERY_ALLOWED, OP_ID_SET_AUTHENTICATED_DERBY_USER_RETURN_IS_QUERY_ALLOWED, OP_ID_SET_FORWARDING_PATH_RETURN_IS_QUERY_ALLOWED

Constructor Summary

Constructors

Constructor and Description
RangerPolicyResultFilter() Policy instantiation constructor - invoked for every new query.

Method Summary

Modifier and Type	Method and Description
void	close() Invoked when Derby closes the GaianTable or GaianQuery instance.
protected Object	executeOperationImpl(String opID, Object... args) This method provides generic extensibility of the Policy framework.
boolean	filterRow(org.apache.derby.iapi.types.DataValueDescriptor[] row) This method is deprecated in favour of filterRowsBatch() - it is here for compatibility with SQLResultFilter
org.apache.derby.iapi.types.DataValueDescriptor[][]	filterRowsBatch(String dataSourceID, org.apache.derby.iapi.types.DataValueDescriptor[][] rows) Apply policy on a batch of rows..
int	nextQueriedDataSource(String dataSource, int[] columnMappings) This method is deprecated in favour of the same method below having 3 arguments - it is here for compatibility with SQLResultFilter
int	nextQueriedDataSource(String dataSourceID, String dataSourceDescription, int[] columnMappings)
int	setDataSourceWrapper(String wrapperID) This method is not currently called by Gaian.
boolean	setForwardingNode(String nodeName) Set up the forwarding node name
boolean	setLogicalTable(String logicalTableName, ResultSetMetaData logicalTableResultSetMetaData)
boolean	setQueriedColumns(int[] queriedColumns)
boolean	setUserCredentials(String credentialsStringBlock) Used to parse the GDB_CREDENTIALS string passed on every statement.

Methods inherited from class com.ibm.gaiandb.policyframework.SQLResultFilterX

executeOperation

Methods inherited from class java.lang.Object

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

Constructor Detail

RangerPolicyResultFilter

public RangerPolicyResultFilter()

Policy instantiation constructor - invoked for every new query. This instance will be re-used if the calling GaianTable results from a PreparedStatement which is re-executed by the calling application.

Method Detail

setForwardingNode

public boolean setForwardingNode(String nodeName)

Set up the forwarding node name

Parameters:

nodeName - forwarding node name

Returns:

true allow query to continue

close

public void close()

Invoked when Derby closes the GaianTable or GaianQuery instance. This should be when the query's statement is closed by the application - but this is not guaranteed as Derby may cache it for re-use.

nextQueriedDataSource

public int nextQueriedDataSource(String dataSource,
                                 int[] columnMappings)

This method is deprecated in favour of the same method below having 3 arguments - it is here for compatibility with SQLResultFilter

setDataSourceWrapper

public int setDataSourceWrapper(String wrapperID)

This method is not currently called by Gaian.

Specified by:

setDataSourceWrapper in class com.ibm.gaiandb.policyframework.SQLResultFilterX

filterRow

public boolean filterRow(org.apache.derby.iapi.types.DataValueDescriptor[] row)

This method is deprecated in favour of filterRowsBatch() - it is here for compatibility with SQLResultFilter

setUserCredentials

public boolean setUserCredentials(String credentialsStringBlock)

Used to parse the GDB_CREDENTIALS string passed on every statement. Not used by the ranger plugin support

Parameters:

credentialsStringBlock - credentials as string

Returns:

true allow query to continue (i.e. accept this credentialsStringBlock)

nextQueriedDataSource

public int nextQueriedDataSource(String dataSourceID,
                                 String dataSourceDescription,
                                 int[] columnMappings)

Specified by:

nextQueriedDataSource in class com.ibm.gaiandb.policyframework.SQLResultFilterX

Parameters:

dataSourceID - data source identifier

dataSourceDescription - data source description

columnMappings - columns for be mapped

Returns:

allow all records to be returned (i.e. don't impose a maximum number)

filterRowsBatch

public org.apache.derby.iapi.types.DataValueDescriptor[][] filterRowsBatch(String dataSourceID,
                                                                           org.apache.derby.iapi.types.DataValueDescriptor[][] rows)

Apply policy on a batch of rows.. This is helpful if you need to send the rows to a 3rd party to evaluate policy - so you can minimize the number of round trips to it.

Specified by:

filterRowsBatch in class com.ibm.gaiandb.policyframework.SQLResultFilterX

Parameters:

dataSourceID - data source identifier

rows - rows that have to be evaluated

Returns:

result after the policies are applied

setLogicalTable

public boolean setLogicalTable(String logicalTableName,
                               ResultSetMetaData logicalTableResultSetMetaData)

setQueriedColumns

public boolean setQueriedColumns(int[] queriedColumns)

executeOperationImpl

protected Object executeOperationImpl(String opID,
                                      Object... args)

This method provides generic extensibility of the Policy framework. For any new operations required in future, a new operation ID (opID) will be assigned, for which a given set of arguments will be expected, we well as a given return object.

Specified by:

executeOperationImpl in class com.ibm.gaiandb.policyframework.SQLResultFilterX