/*
* 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.api.schema.registries.synchronizers;
import org.apache.directory.api.ldap.model.constants.MetaSchemaConstants;
import org.apache.directory.api.ldap.model.constants.SchemaConstants;
import org.apache.directory.api.ldap.model.entry.Entry;
import org.apache.directory.api.ldap.model.exception.LdapException;
import org.apache.directory.api.ldap.model.exception.LdapInvalidDnException;
import org.apache.directory.api.ldap.model.exception.LdapUnwillingToPerformException;
import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
import org.apache.directory.api.ldap.model.name.Dn;
import org.apache.directory.api.ldap.model.name.Rdn;
import org.apache.directory.api.ldap.model.schema.ObjectClass;
import org.apache.directory.api.ldap.model.schema.SchemaManager;
import org.apache.directory.api.ldap.model.schema.registries.Schema;
import org.apache.directory.api.util.Strings;
import org.apache.directory.server.core.api.interceptor.context.ModifyOperationContext;
import org.apache.directory.server.i18n.I18n;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
*
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class ObjectClassSynchronizer extends AbstractRegistrySynchronizer
{
/** A logger for this class */
private static final Logger LOG = LoggerFactory.getLogger( ObjectClassSynchronizer.class );
/**
* Creates a new instance of ObjectClassSynchronizer.
*
* @param schemaManager The global schemaManager
* @throws Exception If the initialization failed
*/
public ObjectClassSynchronizer( SchemaManager schemaManager ) throws Exception
{
super( schemaManager );
}
/**
* {@inheritDoc}
*/
public boolean modify( ModifyOperationContext modifyContext, Entry targetEntry, boolean cascade )
throws LdapException
{
Dn name = modifyContext.getDn();
Entry entry = modifyContext.getEntry();
String oid = getOid( entry );
ObjectClass oc = factory.getObjectClass( schemaManager, targetEntry, schemaManager.getRegistries(),
getSchemaName( name ) );
String schemaName = getSchemaName( entry.getDn() );
if ( isSchemaEnabled( schemaName ) )
{
schemaManager.unregisterObjectClass( oid );
schemaManager.add( oc );
return SCHEMA_MODIFIED;
}
return SCHEMA_UNCHANGED;
}
/**
* {@inheritDoc}
*/
public void add( Entry entry ) throws LdapException
{
Dn dn = entry.getDn();
Dn parentDn = dn.getParent();
// The parent Dn must be ou=objectclasses,cn=<schemaName>,ou=schema
checkParent( parentDn, schemaManager, SchemaConstants.OBJECT_CLASS );
// The new schemaObject's OID must not already exist
checkOidIsUnique( entry );
// Build the new ObjectClass from the given entry
String schemaName = getSchemaName( dn );
ObjectClass objectClass = factory.getObjectClass( schemaManager, entry, schemaManager.getRegistries(),
schemaName );
// At this point, the constructed ObjectClass has not been checked against the
// existing Registries. It may be broken (missing SUP, or such), it will be checked
// there, if the schema and the ObjectClass are both enabled.
Schema schema = schemaManager.getLoadedSchema( schemaName );
if ( schema.isEnabled() && objectClass.isEnabled() )
{
if ( schemaManager.add( objectClass ) )
{
LOG.debug( "Added {} into the enabled schema {}", dn.getName(), schemaName );
}
else
{
// We have some error : reject the addition and get out
String msg = I18n.err( I18n.ERR_373, entry.getDn().getName(),
Strings.listToString( schemaManager.getErrors() ) );
LOG.info( msg );
throw new LdapUnwillingToPerformException( ResultCodeEnum.UNWILLING_TO_PERFORM, msg );
}
}
else
{
LOG.debug( "The ObjectClass {} cannot be added in the disabled schema {}.", objectClass, schemaName );
}
}
/**
* {@inheritDoc}
*/
public void delete( Entry entry, boolean cascade ) throws LdapException
{
Dn dn = entry.getDn();
Dn parentDn = dn.getParent();
// The parent Dn must be ou=objectclasses,cn=<schemaName>,ou=schema
checkParent( parentDn, schemaManager, SchemaConstants.OBJECT_CLASS );
// Get the ObjectClass from the given entry ( it has been grabbed from the server earlier)
String schemaName = getSchemaName( entry.getDn() );
// Get the schema
Schema schema = schemaManager.getLoadedSchema( schemaName );
if ( schema.isDisabled() )
{
// The schema is disabled, nothing to do.
LOG.debug( "The ObjectClass {} cannot be removed from the disabled schema {}.",
dn.getName(), schemaName );
return;
}
// Test that the Oid exists
ObjectClass objectClass = ( ObjectClass ) checkOidExists( entry );
if ( schema.isEnabled() && objectClass.isEnabled() )
{
if ( schemaManager.delete( objectClass ) )
{
LOG.debug( "Removed {} from the schema {}", objectClass, schemaName );
}
else
{
// We have some error : reject the deletion and get out
String msg = I18n.err( I18n.ERR_374, entry.getDn().getName(),
Strings.listToString( schemaManager.getErrors() ) );
LOG.info( msg );
throw new LdapUnwillingToPerformException( ResultCodeEnum.UNWILLING_TO_PERFORM, msg );
}
}
else
{
LOG.debug( "Removed {} from the disabled schema {}", objectClass, schemaName );
}
}
/**
* {@inheritDoc}
*/
public void rename( Entry entry, Rdn newRdn, boolean cascade ) throws LdapException
{
String schemaName = getSchemaName( entry.getDn() );
ObjectClass oldOc = factory.getObjectClass( schemaManager, entry, schemaManager.getRegistries(), schemaName );
// Dependency constraints are not managed by this class
// Set<Entry> dependees = dao.listObjectClassDependents( oldOc );
//
// if ( dependees != null && dependees.size() > 0 )
// {
// throw new LdapUnwillingToPerformException( "The objectClass with OID " + oldOc.getOid()
// + " cannot be deleted until all entities"
// + " using this objectClass have also been deleted. The following dependees exist: "
// + getOids( dependees ),
// ResultCodeEnum.UNWILLING_TO_PERFORM );
// }
Entry targetEntry = ( Entry ) entry.clone();
String newOid = newRdn.getNormValue().getString();
targetEntry.put( MetaSchemaConstants.M_OID_AT, newOid );
// Inject the new Dn
Dn newDn = targetEntry.getDn().getParent();
newDn = newDn.add( newRdn );
checkOidIsUnique( newOid );
ObjectClass oc = factory.getObjectClass( schemaManager, targetEntry, schemaManager.getRegistries(), schemaName );
if ( isSchemaEnabled( schemaName ) )
{
// Check that the entry has no descendant
if ( schemaManager.getObjectClassRegistry().hasDescendants( oldOc.getOid() ) )
{
String msg = I18n.err( I18n.ERR_375, entry.getDn().getName(), newDn );
throw new LdapUnwillingToPerformException( ResultCodeEnum.UNWILLING_TO_PERFORM, msg );
}
schemaManager.unregisterObjectClass( oldOc.getOid() );
schemaManager.add( oc );
}
else
{
unregisterOids( oldOc );
registerOids( oc );
}
}
public void moveAndRename( Dn oriChildName, Dn newParentName, Rdn newRdn, boolean deleteOldRn,
Entry entry, boolean cascade ) throws LdapException
{
checkNewParent( newParentName );
String oldSchemaName = getSchemaName( oriChildName );
ObjectClass oldOc = factory.getObjectClass( schemaManager, entry, schemaManager.getRegistries(), oldSchemaName );
// this class does not handle dependencies
// Set<Entry> dependees = dao.listObjectClassDependents( oldOc );
// if ( dependees != null && dependees.size() > 0 )
// {
// throw new LdapUnwillingToPerformException( "The objectClass with OID " + oldOc.getOid()
// + " cannot be deleted until all entities"
// + " using this objectClass have also been deleted. The following dependees exist: "
// + getOids( dependees ),
// ResultCodeEnum.UNWILLING_TO_PERFORM );
// }
String newSchemaName = getSchemaName( newParentName );
Entry targetEntry = ( Entry ) entry.clone();
String newOid = newRdn.getNormValue().getString();
checkOidIsUnique( newOid );
targetEntry.put( MetaSchemaConstants.M_OID_AT, newOid );
ObjectClass oc = factory.getObjectClass( schemaManager, targetEntry, schemaManager.getRegistries(),
newSchemaName );
if ( isSchemaEnabled( oldSchemaName ) )
{
schemaManager.unregisterObjectClass( oldOc.getOid() );
}
else
{
unregisterOids( oldOc );
}
if ( isSchemaEnabled( newSchemaName ) )
{
schemaManager.add( oc );
}
else
{
registerOids( oc );
}
}
public void move( Dn oriChildName, Dn newParentName, Entry entry, boolean cascade ) throws LdapException
{
checkNewParent( newParentName );
String oldSchemaName = getSchemaName( oriChildName );
String newSchemaName = getSchemaName( newParentName );
ObjectClass oldAt = factory.getObjectClass( schemaManager, entry, schemaManager.getRegistries(), oldSchemaName );
// dependencies are not managed by this class
// Set<Entry> dependees = dao.listObjectClassDependents( oldAt );
// if ( dependees != null && dependees.size() > 0 )
// {s
// throw new LdapUnwillingToPerformException( "The objectClass with OID " + oldAt.getOid()
// + " cannot be deleted until all entities"
// + " using this objectClass have also been deleted. The following dependees exist: "
// + getOids( dependees ),
// ResultCodeEnum.UNWILLING_TO_PERFORM );
// }
ObjectClass oc = factory.getObjectClass( schemaManager, entry, schemaManager.getRegistries(), newSchemaName );
if ( isSchemaEnabled( oldSchemaName ) )
{
schemaManager.unregisterObjectClass( oldAt.getOid() );
}
else
{
unregisterOids( oldAt );
}
if ( isSchemaEnabled( newSchemaName ) )
{
schemaManager.add( oc );
}
else
{
registerOids( oc );
}
}
private void checkNewParent( Dn newParent ) throws LdapException
{
if ( newParent.size() != 3 )
{
throw new LdapInvalidDnException(
ResultCodeEnum.NAMING_VIOLATION,
"The parent dn of a objectClass should be at most 3 name components in length." );
}
Rdn rdn = newParent.getRdn();
if ( !schemaManager.getAttributeTypeRegistry().getOidByName( rdn.getNormType() ).equals(
SchemaConstants.OU_AT_OID ) )
{
throw new LdapInvalidDnException( ResultCodeEnum.NAMING_VIOLATION,
I18n.err( I18n.ERR_376 ) );
}
if ( !rdn.getNormValue().getString().equalsIgnoreCase( SchemaConstants.OBJECT_CLASSES_AT ) )
{
throw new LdapInvalidDnException( ResultCodeEnum.NAMING_VIOLATION,
I18n.err( I18n.ERR_377 ) );
}
}
}