Package com.i2group.disco.security.spi

Interface IUserItemTypeAccessResolverProvider

public interface IUserItemTypeAccessResolverProvider

A provider of per-user IUserItemTypeAccessResolverProvider.IUserItemTypeAccessResolver objects that can determine a user's right (that is, "allowed" or "not allowed") to access different types of data in i2 Analyze.

Since:

11.5

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IUserItemTypeAccessResolverProvider.IUserItemTypeAccessResolver	A provider of methods that i2 Analyze calls to determine whether the user for whom it was generated has access to data with a particular type.

Method Summary

Modifier and Type	Method	Description
IUserItemTypeAccessResolverProvider.IUserItemTypeAccessResolver	getItemTypeAccessResolverForUser(IUserInformation userInformation)	Gets a IUserItemTypeAccessResolverProvider.IUserItemTypeAccessResolver for a particular user.
void	load()	Loads the type access configuration.

Method Details

load

void load()

Loads the type access configuration. i2 Analyze calls this method on your implementation during startup and reload of the server. You can choose to validate the configuration as well as load it.

If you find the configuration not to be valid, throw a IllegalStateException to send a message back to the server. You can decide whether to respond to future requests for type access levels using any configuration that was present before the load occurred, or as if there are no type access restrictions, or by failing.

Throws:

IllegalStateException - If the type access configuration is not valid.

getItemTypeAccessResolverForUser

IUserItemTypeAccessResolverProvider.IUserItemTypeAccessResolver getItemTypeAccessResolverForUser(IUserInformation userInformation)

Gets a IUserItemTypeAccessResolverProvider.IUserItemTypeAccessResolver for a particular user.

The i2 Analyze application will use a single IUserItemTypeAccessResolverProvider instance to determine user item type access in different threads, so implementations of this method must be thread-safe.

Parameters:

userInformation - Identifying and security information about the user that the IUserItemTypeAccessResolverProvider.IUserItemTypeAccessResolver is for.

Returns:

See above.