org.openmdx.audit1.accessor.layer.application
Class Audit_1

java.lang.Object
  org.openmdx.compatibility.base.dataprovider.spi.Layer_1
      org.openmdx.compatibility.base.dataprovider.spi.StreamOperationAwareLayer_1
          org.openmdx.compatibility.base.dataprovider.layer.persistence.common.AbstractPersistence_1
              org.openmdx.compatibility.base.dataprovider.layer.persistence.jdbc.AbstractDatabase_1
                  org.openmdx.compatibility.base.dataprovider.layer.persistence.jdbc.Database_1Jdbc2
                      org.openmdx.audit1.accessor.layer.application.Audit_1

All Implemented Interfaces:

Dataprovider_1_0, Layer_1_0, Layer_1_1, Operation_1_0

public class Audit_1
extends Database_1Jdbc2

Plugin implementing the org:openmdx:compatibility:audit1 features. The plugin does the following:

• intercepts replace() and modify() requests. These requests are delegated 1:1 to 'object store' plugin. The returned modified object - also called object after image - is then propagated as create-request to the configured audit provider.
• implements the derived features of audit1 for get() and find() operations. This requires the access to both, the 'object store' plugin and the audit provider.
• The first configured provider resource is used as audit provider.
• The current implementation requires Database_1 to be the 'object store' plugin (the plugin extends Database_1). This is a restriction implied by openMDX 1 and not by the Audit_1 plugin itself.

Field Summary

Fields inherited from class org.openmdx.compatibility.base.dataprovider.layer.persistence.jdbc.AbstractDatabase_1

allowsSqlSequenceFallback, batchSize, configuration, connectionManagers, DATASTORE_PREFIX, embeddedFeatures, EXTENT_PATTERN, ignoreCheckForDuplicates, JDBC_DRIVER_SQL_PROPERTIES, jdbcDriverSqlProperties, model, namespaceId, nonPersistentFeatures, OBJECT_ID, OBJECT_IDX, OBJECT_OID, OBJECT_RID, resultSetType, supportsSqlNumericNullCast, temporaryFiles

Fields inherited from class org.openmdx.compatibility.base.dataprovider.layer.persistence.common.AbstractPersistence_1

DEFAULT_CHUNK_SIZE

Constructor Summary

Audit_1()

Method Summary

void	activate(short id, Configuration configuration, Layer_1_0 delegation) Activates a dataprovider layer
DataproviderReply	create(ServiceHeader header, DataproviderRequest request) Create a new object
void	epilog(ServiceHeader header, DataproviderRequest[] requests, DataproviderReply[] replies) This method allows the dataprovider layers postprocessing of a collection of requests as a whole after the actual processing of the individual requests has been done.
DataproviderReply	find(ServiceHeader header, DataproviderRequest request) Get the objects specified by the references and filter properties
DataproviderReply	get(ServiceHeader header, DataproviderRequest request) Get the object specified by the requests's path
DataproviderReply	modify(ServiceHeader header, DataproviderRequest request) Modifies some of an object's attributes leaving the others unchanged.
void	prolog(ServiceHeader header, DataproviderRequest[] requests) This method allows the dataprovider layers to verify the integrity of a set of requests as a whole before the actual processing of the individual requests starts.
DataproviderReply	remove(ServiceHeader header, DataproviderRequest request) Removes an object including its descendents
DataproviderReply	replace(ServiceHeader header, DataproviderRequest request) Modifies all changeable attributes of an object.
protected String	uidAsString() To replace the deprecated UIDFactory.create() calls
protected boolean	useDatatypes() Tells whether XML datatype formatting is required

Methods inherited from class org.openmdx.compatibility.base.dataprovider.layer.persistence.jdbc.AbstractDatabase_1

closeConnection, create, createBlob, createClob, executeBatch, executeQuery, externalizePathValue, externalizeStringValue, get, getAttributeName, getAutonumValue, getBooleanType, getConnection, getConnectionManager, getDateTimeType, getDateType, getEscapeClause, getPartialObject, getReference, getReferenceIdFormat, getSelectReferenceIdsClause, getTimeType, internalizePathValue, internalizeStringValue, isSetSizeColumns, otherOperation, prepareStatement, setPreparedStatementValue, useNormalizedReferences

Methods inherited from class org.openmdx.compatibility.base.dataprovider.layer.persistence.common.AbstractPersistence_1

getBinaryStream, getCharacterStream, getChunkSize, getStreamBufferDirectory, getStreamOperation, getStreamOperation, isSequenceSupported

Methods inherited from class org.openmdx.compatibility.base.dataprovider.spi.StreamOperationAwareLayer_1

createResponse, getConfigurationValue, getConfigurationValue, operation

Methods inherited from class org.openmdx.compatibility.base.dataprovider.spi.Layer_1

configurationSpecification, deactivate, getConfiguration, getDelegation, getDelegation, getId, getLenientProcessor, isLenient, process, process, set, startPublishing, terminal

Methods inherited from class java.lang.Object

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

Constructor Detail

Audit_1

public Audit_1()

Method Detail

activate

public void activate(short id,
                     Configuration configuration,
                     Layer_1_0 delegation)
              throws Exception,
                     ServiceException

Description copied from class: Layer_1

Activates a dataprovider layer

Specified by:

activate in interface Layer_1_0

Overrides:

activate in class AbstractDatabase_1

Parameters:

id - the dataprovider layer's id

configuration - the dataprovider'a configuration

namespaceId

String

exposedPath

Path[]

delegation - the layer to delegate to; or null if "persistenceLayer".equals(id)

Throws:

Exception - unexpected exceptions

ServiceException - expected exceptions

prolog

public void prolog(ServiceHeader header,
                   DataproviderRequest[] requests)
            throws ServiceException

Description copied from class: Layer_1

This method allows the dataprovider layers to verify the integrity of a set of requests as a whole before the actual processing of the individual requests starts.

Specified by:

prolog in interface Layer_1_0

Overrides:

prolog in class AbstractDatabase_1

Parameters:

header - the requests' service header

requests - the request list

Throws:

ServiceException - on failure

epilog

public void epilog(ServiceHeader header,
                   DataproviderRequest[] requests,
                   DataproviderReply[] replies)
            throws ServiceException

Description copied from class: Layer_1

This method allows the dataprovider layers postprocessing of a collection of requests as a whole after the actual processing of the individual requests has been done.

Specified by:

epilog in interface Layer_1_0

Overrides:

epilog in class AbstractDatabase_1

Parameters:

header - the requests' service header

requests - the request list

replies - the reply collection

Throws:

ServiceException - on failure

get

public DataproviderReply get(ServiceHeader header,
                             DataproviderRequest request)
                      throws ServiceException

Description copied from class: Layer_1

Get the object specified by the requests's path

Specified by:

get in interface Layer_1_0

Overrides:

get in class AbstractDatabase_1

Parameters:

header - request header

request - the request

Returns:

the reply

Throws:

ServiceException - on failure

find

public DataproviderReply find(ServiceHeader header,
                              DataproviderRequest request)
                       throws ServiceException

Description copied from class: Layer_1

Get the objects specified by the references and filter properties

Specified by:

find in interface Layer_1_0

Overrides:

find in class AbstractDatabase_1

Parameters:

header - request header

request - the request

Returns:

the reply

Throws:

ServiceException - on failure

replace

public DataproviderReply replace(ServiceHeader header,
                                 DataproviderRequest request)
                          throws ServiceException

Description copied from class: Layer_1

Modifies all changeable attributes of an object.

Specified by:

replace in interface Layer_1_0

Overrides:

replace in class AbstractDatabase_1

Parameters:

header - request header

request - the request

Returns:

the reply

Throws:

ServiceException - on failure

modify

public DataproviderReply modify(ServiceHeader header,
                                DataproviderRequest request)
                         throws ServiceException

Description copied from class: Layer_1

Modifies some of an object's attributes leaving the others unchanged.

Specified by:

modify in interface Layer_1_0

Overrides:

modify in class AbstractDatabase_1

Parameters:

header - request header

request - the request

Returns:

the reply

Throws:

ServiceException - on failure

remove

public DataproviderReply remove(ServiceHeader header,
                                DataproviderRequest request)
                         throws ServiceException

Description copied from class: Layer_1

Removes an object including its descendents

Specified by:

remove in interface Layer_1_0

Overrides:

remove in class AbstractDatabase_1

Parameters:

header - request header

request - the request

Returns:

the reply

Throws:

ServiceException - on failure

create

public DataproviderReply create(ServiceHeader header,
                                DataproviderRequest request)
                         throws ServiceException

Description copied from class: Layer_1

Create a new object

Specified by:

create in interface Layer_1_0

Overrides:

create in class AbstractDatabase_1

Parameters:

header - request header

request - the request

Returns:

the reply

Throws:

ServiceException - on failure

useDatatypes

protected boolean useDatatypes()

Tells whether XML datatype formatting is required

Returns:

uidAsString

protected final String uidAsString()

To replace the deprecated UIDFactory.create() calls

Returns:

a UID as string