/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.directory.server.core.journal;
import java.util.Set;
import java.util.concurrent.atomic.AtomicLong;
import org.apache.directory.server.core.DirectoryService;
import org.apache.directory.server.core.entry.ServerAttribute;
import org.apache.directory.server.core.entry.ServerEntry;
import org.apache.directory.server.core.interceptor.BaseInterceptor;
import org.apache.directory.server.core.interceptor.NextInterceptor;
import org.apache.directory.server.core.interceptor.context.AddOperationContext;
import org.apache.directory.server.core.interceptor.context.DeleteOperationContext;
import org.apache.directory.server.core.interceptor.context.ModifyOperationContext;
import org.apache.directory.server.core.interceptor.context.MoveAndRenameOperationContext;
import org.apache.directory.server.core.interceptor.context.MoveOperationContext;
import org.apache.directory.server.core.interceptor.context.RenameOperationContext;
import org.apache.directory.shared.ldap.entry.Modification;
import org.apache.directory.shared.ldap.ldif.ChangeType;
import org.apache.directory.shared.ldap.ldif.LdifEntry;
import org.apache.directory.shared.ldap.schema.AttributeType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* An interceptor which intercepts write operations to the directory and
* logs them into a journal.
*
* @org.apache.xbean.XBean
*/
public class JournalInterceptor extends BaseInterceptor
{
/** for debugging */
private static final Logger LOG = LoggerFactory.getLogger( JournalInterceptor.class );
/** A flag set to true if the journal interceptor is enabled */
private boolean journalEnabled;
/** A shared number stored within each change */
private AtomicLong revision;
/** the Journal service to log changes to */
private Journal journal;
// -----------------------------------------------------------------------
// Overridden init() and destroy() methods
// -----------------------------------------------------------------------
/**
* The init method will initialize the local variables and load the
* entryDeleted AttributeType.
*/
public void init( DirectoryService directoryService ) throws Exception
{
super.init( directoryService );
if ( directoryService.getJournal().isEnabled() )
{
journalEnabled = true;
journal = directoryService.getJournal();
revision = new AtomicLong( System.currentTimeMillis() );
}
LOG.debug( "JournalInterceptor has been initialized" );
}
/**
* Log the operation, manage the logs rotations.
*/
private void log( long revision, LdifEntry ldif ) throws Exception
{
journal.log( getPrincipal(), revision, ldif );
}
// -----------------------------------------------------------------------
// Overridden (only change inducing) intercepted methods
// -----------------------------------------------------------------------
/**
* {@inheritDoc}
*/
public void add( NextInterceptor next, AddOperationContext opContext ) throws Exception
{
long opRevision = 0;
if ( journalEnabled )
{
opRevision = revision.incrementAndGet();
// Store the added entry
ServerEntry addEntry = opContext.getEntry();
LdifEntry ldif = new LdifEntry();
ldif.setChangeType( ChangeType.Add );
ldif.setDn( opContext.getDn() );
Set<AttributeType> list = addEntry.getAttributeTypes();
for ( AttributeType attributeType:list )
{
ldif.addAttribute( ((ServerAttribute)addEntry.get( attributeType) ).toClientAttribute() );
}
log( opRevision, ldif );
}
try
{
next.add( opContext );
if ( journalEnabled )
{
// log the ACK
journal.ack( opRevision );
}
}
catch( Exception e )
{
if ( journalEnabled )
{
// log the NACK
journal.nack( opRevision );
}
throw e;
}
}
/**
* {@inheritDoc}
*/
public void delete( NextInterceptor next, DeleteOperationContext opContext ) throws Exception
{
long opRevision = 0;
if ( journalEnabled )
{
opRevision = revision.incrementAndGet();
// Store the deleted entry
LdifEntry ldif = new LdifEntry();
ldif.setChangeType( ChangeType.Delete );
ldif.setDn( opContext.getDn() );
journal.log( getPrincipal(), opRevision, ldif );
}
try
{
next.delete( opContext );
if ( journalEnabled )
{
// log the ACK
journal.ack( opRevision );
}
}
catch( Exception e )
{
if ( journalEnabled )
{
// log the NACK
journal.nack( opRevision );
}
throw e;
}
}
/**
* {@inheritDoc}
*/
public void modify( NextInterceptor next, ModifyOperationContext opContext ) throws Exception
{
long opRevision = 0;
if ( journalEnabled )
{
opRevision = revision.incrementAndGet();
// Store the modified entry
LdifEntry ldif = new LdifEntry();
ldif.setChangeType( ChangeType.Modify );
ldif.setDn( opContext.getDn() );
// Store the modifications
for ( Modification modification:opContext.getModItems() )
{
ldif.addModificationItem( modification );
}
journal.log( getPrincipal(), opRevision, ldif );
}
try
{
next.modify( opContext );
if ( journalEnabled )
{
// log the ACK
journal.ack( opRevision );
}
}
catch( Exception e )
{
if ( journalEnabled )
{
// log the NACK
journal.nack( opRevision );
}
throw e;
}
}
/**
* {@inheritDoc}
*/
public void rename ( NextInterceptor next, RenameOperationContext opContext ) throws Exception
{
long opRevision = 0;
if ( journalEnabled )
{
opRevision = revision.incrementAndGet();
// Store the renamed entry
LdifEntry ldif = new LdifEntry();
ldif.setChangeType( ChangeType.ModRdn );
ldif.setDn( opContext.getDn() );
ldif.setNewRdn( opContext.getNewRdn().toString() );
ldif.setDeleteOldRdn( opContext.getDelOldDn() );
journal.log( getPrincipal(), opRevision, ldif );
}
try
{
next.rename( opContext );
if ( journalEnabled )
{
// log the ACK
journal.ack( opRevision );
}
}
catch( Exception e )
{
if ( journalEnabled )
{
// log the NACK
journal.nack( opRevision );
}
throw e;
}
}
/**
* {@inheritDoc}
*/
public void moveAndRename( NextInterceptor next, MoveAndRenameOperationContext opContext )
throws Exception
{
long opRevision = 0;
if ( journalEnabled )
{
opRevision = revision.incrementAndGet();
// Store the renamed entry
LdifEntry ldif = new LdifEntry();
ldif.setChangeType( ChangeType.ModDn );
ldif.setDn( opContext.getDn() );
ldif.setNewRdn( opContext.getNewRdn().toString() );
ldif.setDeleteOldRdn( opContext.getDelOldDn() );
ldif.setNewSuperior( opContext.getNewDn().getNormName() );
journal.log( getPrincipal(), opRevision, ldif );
}
try
{
next.moveAndRename( opContext );
if ( journalEnabled )
{
// log the ACK
journal.ack( opRevision );
}
}
catch( Exception e )
{
if ( journalEnabled )
{
// log the NACK
journal.nack( opRevision );
}
throw e;
}
}
/**
* {@inheritDoc}
*/
public void move( NextInterceptor next, MoveOperationContext opContext ) throws Exception
{
long opRevision = 0;
if ( journalEnabled )
{
opRevision = revision.incrementAndGet();
// Store the moved entry
LdifEntry ldif = new LdifEntry();
ldif.setChangeType( ChangeType.ModDn );
ldif.setDn( opContext.getDn() );
ldif.setNewSuperior( opContext.getParent().getNormName() );
journal.log( getPrincipal(), opRevision, ldif );
}
try
{
next.move( opContext );
if ( journalEnabled )
{
// log the ACK
journal.ack( opRevision );
}
}
catch( Exception e )
{
if ( journalEnabled )
{
// log the NACK
journal.nack( opRevision );
}
throw e;
}
}
}