com.acciente.oacc.sql

Class SQLAccessControlContextFactory

java.lang.Object

com.acciente.oacc.sql.SQLAccessControlContextFactory

public class SQLAccessControlContextFactory
extends Object

The factory that provides OACC's AccessControlContext implementation, which is backed by a database.

Constructor Summary

Constructors

Constructor and Description
SQLAccessControlContextFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static AccessControlContext	getAccessControlContext(Connection connection, String schemaName, SQLProfile sqlProfile, AuthenticationProvider authenticationProvider) Creates an AccessControlContext instance backed by the specified database connection.
static AccessControlContext	getAccessControlContext(Connection connection, String schemaName, SQLProfile sqlProfile, PasswordEncryptor passwordEncryptor) Creates an AccessControlContext instance backed by the specified database connection.
static AccessControlContext	getAccessControlContext(DataSource dataSource, String schemaName, SQLProfile sqlProfile, AuthenticationProvider authenticationProvider) Creates an AccessControlContext instance backed by the specified database data source.
static AccessControlContext	getAccessControlContext(DataSource dataSource, String schemaName, SQLProfile sqlProfile, PasswordEncryptor passwordEncryptor) Creates an AccessControlContext instance backed by the specified database data source.
static void	postDeserialize(AccessControlContext accessControlContext, Connection connection) Re-initializes the specified deserialized accessControlContext with the specified connection.
static void	postDeserialize(AccessControlContext accessControlContext, DataSource dataSource) Re-initializes the specified deserialized accessControlContext with the specified data source.

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLAccessControlContextFactory

public SQLAccessControlContextFactory()

Method Detail

getAccessControlContext

public static AccessControlContext getAccessControlContext(Connection connection,
                                           String schemaName,
                                           SQLProfile sqlProfile,
                                           PasswordEncryptor passwordEncryptor)

Creates an AccessControlContext instance backed by the specified database connection. A set of valid OACC database tables are expected to reside in the specified schema. The dialect of SQL supported by the database server for which the connection is provided is specified using the SQLProfile parameter. The access control context returned by this method uses the built-in authentication provider for resource authentication. The built-in authentication provider delegates all password encryption and decryption to the PasswordEncryptor instance provided -- therefore it is imperative that the PasswordEncryptor instance is able to decrypt existing resource passwords.

Parameters:

connection - a database connection with access to the required OACC tables

schemaName - the name of the schema in the database containing the OACC tables

sqlProfile - the database provider and dialect of SQL supported for the database server associated with the connection provided

passwordEncryptor - a PasswordEncryptor instance to which the built-in authentication provider delegates all password encryption and decryption

Returns:

an AccessControlContext instance ready to receive API calls

getAccessControlContext

public static AccessControlContext getAccessControlContext(DataSource dataSource,
                                           String schemaName,
                                           SQLProfile sqlProfile,
                                           PasswordEncryptor passwordEncryptor)

Creates an AccessControlContext instance backed by the specified database data source. A set of valid OACC database tables are expected to reside in the specified schema. The dialect of SQL supported by the database server for which the data source is provided is specified using the SQLProfile parameter. The access control context returned by this method uses the built-in authentication provider for resource authentication. The built-in authentication provider delegates all password encryption and decryption to the PasswordEncryptor instance provided -- therefore it is important that the PasswordEncryptor instance is able to decrypt existing resource passwords.

Parameters:

dataSource - a database data source with access to the required OACC tables

schemaName - the name of the schema in the database containing the OACC tables

sqlProfile - the database provider and dialect of SQL supported for the database server associated with the data source provided

passwordEncryptor - a PasswordEncryptor instance to which the built-in authentication provider delegates all password encryption and decryption

Returns:

an AccessControlContext instance ready to receive API calls

getAccessControlContext

public static AccessControlContext getAccessControlContext(Connection connection,
                                           String schemaName,
                                           SQLProfile sqlProfile,
                                           AuthenticationProvider authenticationProvider)

Creates an AccessControlContext instance backed by the specified database connection. A set of valid OACC database tables are expected to reside in the specified schema. The dialect of SQL supported by the database server for which the connection is provided is specified using the SQLProfile parameter. The access control context returned by this method delegates all resource authentication to the specified custom authentication provider.

Parameters:

connection - a database connection with access to the required OACC tables

schemaName - the name of the schema in the database containing the OACC tables

sqlProfile - the database provider and dialect of SQL supported for the database server associated with the connection provided

authenticationProvider - an AuthenticationProvider instance to which all resource authentication is delegated

Returns:

an AccessControlContext instance ready to receive API calls

getAccessControlContext

public static AccessControlContext getAccessControlContext(DataSource dataSource,
                                           String schemaName,
                                           SQLProfile sqlProfile,
                                           AuthenticationProvider authenticationProvider)

Creates an AccessControlContext instance backed by the specified database data source. A set of valid OACC database tables are expected to reside in the specified schema. The dialect of SQL supported by the database server for which the data source is provided is specified using the SQLProfile parameter. The access control context returned by this method delegates all resource authentication to the specified custom authentication provider.

Parameters:

dataSource - a database data source with access to the required OACC tables

schemaName - the name of the schema in the database containing the OACC tables

sqlProfile - the database provider and dialect of SQL supported for the database server associated with the connection provided

authenticationProvider - an AuthenticationProvider instance to which all resource authentication is delegated

Returns:

an AccessControlContext instance ready to receive API calls

postDeserialize

public static void postDeserialize(AccessControlContext accessControlContext,
                   Connection connection)

Re-initializes the specified deserialized accessControlContext with the specified connection.

This method is only intended to be called after the specified accessControlContext was successfully deserialized, in order to reset a transient connection to a database that was not serialized. If the method is called when a data source or connection has already been initialized, the method may pass through an IllegalStateException from the accessControlContext.

Parameters:

accessControlContext - the accessControlContext on which to reset the database connection

connection - the database connection to be reset on the accessControlContext

postDeserialize

public static void postDeserialize(AccessControlContext accessControlContext,
                   DataSource dataSource)

Re-initializes the specified deserialized accessControlContext with the specified data source.

This method is only intended to be called after the specified accessControlContext was successfully deserialized, in order to reset a transient dataSource to a database that was not serialized. If the method is called when a data source or connection has already been initialized, the method may pass through an IllegalStateException from the accessControlContext.

Parameters:

accessControlContext - the accessControlContext on which to reset the database connection

dataSource - the database dataSource to be reset on the accessControlContext