| /* |
| * 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.shared.ldap.schemaloader; |
| |
| |
| import java.lang.reflect.Constructor; |
| import java.util.ArrayList; |
| import java.util.HashSet; |
| import java.util.List; |
| import java.util.Set; |
| |
| import org.apache.directory.shared.asn1.util.OID; |
| import org.apache.directory.shared.i18n.I18n; |
| import org.apache.directory.shared.ldap.model.constants.MetaSchemaConstants; |
| import org.apache.directory.shared.ldap.model.constants.SchemaConstants; |
| import org.apache.directory.shared.ldap.model.entry.DefaultEntryAttribute; |
| import org.apache.directory.shared.ldap.model.entry.EntryAttribute; |
| import org.apache.directory.shared.ldap.model.entry.Value; |
| import org.apache.directory.shared.ldap.model.entry.Entry; |
| import org.apache.directory.shared.ldap.model.exception.LdapException; |
| import org.apache.directory.shared.ldap.model.exception.LdapInvalidAttributeValueException; |
| import org.apache.directory.shared.ldap.model.exception.LdapUnwillingToPerformException; |
| import org.apache.directory.shared.ldap.model.message.ResultCodeEnum; |
| import org.apache.directory.shared.ldap.model.schema.AttributeType; |
| import org.apache.directory.shared.ldap.model.schema.EntityFactory; |
| import org.apache.directory.shared.ldap.model.schema.AbstractLdapComparator; |
| import org.apache.directory.shared.ldap.model.schema.MutableLdapSyntaxImpl; |
| import org.apache.directory.shared.ldap.model.schema.LoadableSchemaObject; |
| import org.apache.directory.shared.ldap.model.schema.MutableMatchingRuleImpl; |
| import org.apache.directory.shared.ldap.model.schema.AbstractNormalizer; |
| import org.apache.directory.shared.ldap.model.schema.Normalizer; |
| import org.apache.directory.shared.ldap.model.schema.ObjectClass; |
| import org.apache.directory.shared.ldap.model.schema.ObjectClassTypeEnum; |
| import org.apache.directory.shared.ldap.model.schema.SchemaManager; |
| import org.apache.directory.shared.ldap.model.schema.MutableSchemaObject; |
| import org.apache.directory.shared.ldap.model.schema.SchemaObject; |
| import org.apache.directory.shared.ldap.model.schema.SyntaxChecker; |
| import org.apache.directory.shared.ldap.model.schema.AbstractSyntaxChecker; |
| import org.apache.directory.shared.ldap.model.schema.UsageEnum; |
| import org.apache.directory.shared.ldap.model.schema.parsers.NormalizerDescription; |
| import org.apache.directory.shared.ldap.model.schema.registries.Registries; |
| import org.apache.directory.shared.ldap.model.schema.registries.Schema; |
| import org.apache.directory.shared.ldap.model.schema.parsers.LdapComparatorDescription; |
| import org.apache.directory.shared.ldap.model.schema.parsers.SyntaxCheckerDescription; |
| import org.apache.directory.shared.ldap.model.schema.registries.DefaultSchema; |
| import org.apache.directory.shared.util.Base64; |
| import org.apache.directory.shared.util.StringConstants; |
| import org.apache.directory.shared.util.Strings; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| |
| /** |
| * Showing how it's done ... |
| * |
| * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> |
| */ |
| public class SchemaEntityFactory implements EntityFactory |
| { |
| /** Slf4j logger */ |
| private static final Logger LOG = LoggerFactory.getLogger( SchemaEntityFactory.class ); |
| |
| /** The empty string list. */ |
| private static final List<String> EMPTY_LIST = new ArrayList<String>(); |
| |
| /** The empty string array. */ |
| private static final String[] EMPTY_ARRAY = new String[] |
| {}; |
| |
| /** A special ClassLoader that loads a class from the bytecode attribute */ |
| private final AttributeClassLoader classLoader; |
| |
| |
| /** |
| * Instantiates a new schema entity factory. |
| */ |
| public SchemaEntityFactory() |
| { |
| this.classLoader = new AttributeClassLoader(); |
| } |
| |
| |
| /** |
| * Get an OID from an entry. Handles the bad cases (null OID, |
| * not a valid OID, ...) |
| */ |
| private String getOid( Entry entry, String objectType ) throws LdapInvalidAttributeValueException |
| { |
| // The OID |
| EntryAttribute mOid = entry.get( MetaSchemaConstants.M_OID_AT ); |
| |
| if ( mOid == null ) |
| { |
| String msg = I18n.err( I18n.ERR_10005, objectType, MetaSchemaConstants.M_OID_AT ); |
| LOG.warn( msg ); |
| throw new IllegalArgumentException( msg ); |
| } |
| |
| String oid = mOid.getString(); |
| |
| if ( !OID.isOID(oid) ) |
| { |
| String msg = I18n.err( I18n.ERR_10006, oid ); |
| LOG.warn( msg ); |
| throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, msg ); |
| } |
| |
| return oid; |
| } |
| |
| |
| /** |
| * Get an OID from an entry. Handles the bad cases (null OID, |
| * not a valid OID, ...) |
| */ |
| private String getOid( SchemaObject description, String objectType ) throws LdapInvalidAttributeValueException |
| { |
| // The OID |
| String oid = description.getOid(); |
| |
| if ( oid == null ) |
| { |
| String msg = I18n.err( I18n.ERR_10005, objectType, MetaSchemaConstants.M_OID_AT ); |
| LOG.warn( msg ); |
| throw new IllegalArgumentException( msg ); |
| } |
| |
| if ( !OID.isOID( oid ) ) |
| { |
| String msg = I18n.err( I18n.ERR_10006, oid ); |
| LOG.warn( msg ); |
| throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, msg ); |
| } |
| |
| return oid; |
| } |
| |
| |
| /** |
| * Check that the Entry is not null |
| */ |
| private void checkEntry( Entry entry, String schemaEntity ) |
| { |
| if ( entry == null ) |
| { |
| String msg = I18n.err( I18n.ERR_10007, schemaEntity ); |
| LOG.warn( msg ); |
| throw new IllegalArgumentException( msg ); |
| } |
| } |
| |
| |
| /** |
| * Check that the Description is not null |
| */ |
| private void checkDescription( SchemaObject description, String schemaEntity ) |
| { |
| if ( description == null ) |
| { |
| String msg = I18n.err( I18n.ERR_10008, schemaEntity ); |
| LOG.warn( msg ); |
| throw new IllegalArgumentException( msg ); |
| } |
| } |
| |
| |
| /** |
| * Get the schema from its name. Return the Other reference if there |
| * is no schema name. Throws a NPE if the schema is not loaded. |
| */ |
| private Schema getSchema( String schemaName, Registries registries ) |
| { |
| if ( Strings.isEmpty(schemaName) ) |
| { |
| schemaName = MetaSchemaConstants.SCHEMA_OTHER; |
| } |
| |
| Schema schema = registries.getLoadedSchema( schemaName ); |
| |
| if ( schema == null ) |
| { |
| String msg = I18n.err( I18n.ERR_10009, schemaName ); |
| LOG.error( msg ); |
| } |
| |
| return schema; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public Schema getSchema( Entry entry ) throws LdapException |
| { |
| String name; |
| String owner; |
| String[] dependencies = EMPTY_ARRAY; |
| boolean isDisabled = false; |
| |
| if ( entry == null ) |
| { |
| throw new IllegalArgumentException( I18n.err( I18n.ERR_10010 ) ); |
| } |
| |
| if ( entry.get( SchemaConstants.CN_AT ) == null ) |
| { |
| throw new IllegalArgumentException( I18n.err( I18n.ERR_10011 ) ); |
| } |
| |
| name = entry.get( SchemaConstants.CN_AT ).getString(); |
| |
| if ( entry.get( SchemaConstants.CREATORS_NAME_AT ) == null ) |
| { |
| throw new IllegalArgumentException( I18n.err( I18n.ERR_10012, SchemaConstants.CREATORS_NAME_AT ) ); |
| } |
| |
| owner = entry.get( SchemaConstants.CREATORS_NAME_AT ).getString(); |
| |
| if ( entry.get( MetaSchemaConstants.M_DISABLED_AT ) != null ) |
| { |
| String value = entry.get( MetaSchemaConstants.M_DISABLED_AT ).getString(); |
| value = value.toUpperCase(); |
| isDisabled = value.equals( "TRUE" ); |
| } |
| |
| if ( entry.get( MetaSchemaConstants.M_DEPENDENCIES_AT ) != null ) |
| { |
| Set<String> depsSet = new HashSet<String>(); |
| EntryAttribute depsAttr = entry.get( MetaSchemaConstants.M_DEPENDENCIES_AT ); |
| |
| for ( Value<?> value : depsAttr ) |
| { |
| depsSet.add( value.getString() ); |
| } |
| |
| dependencies = depsSet.toArray( EMPTY_ARRAY ); |
| } |
| |
| return new DefaultSchema( name, owner, dependencies, isDisabled ); |
| } |
| |
| |
| /** |
| * Class load a syntaxChecker instance |
| */ |
| private AbstractSyntaxChecker classLoadSyntaxChecker( SchemaManager schemaManager, String oid, String className, EntryAttribute byteCode ) |
| throws Exception |
| { |
| // Try to class load the syntaxChecker |
| Class<?> clazz = null; |
| AbstractSyntaxChecker syntaxChecker = null; |
| String byteCodeStr = StringConstants.EMPTY; |
| |
| if ( byteCode == null ) |
| { |
| clazz = Class.forName( className ); |
| } |
| else |
| { |
| classLoader.setAttribute( byteCode ); |
| clazz = classLoader.loadClass( className ); |
| byteCodeStr = new String( Base64.encode(byteCode.getBytes()) ); |
| } |
| |
| // Create the syntaxChecker instance |
| syntaxChecker = ( AbstractSyntaxChecker ) clazz.newInstance(); |
| |
| // Update the common fields |
| syntaxChecker.setBytecode( byteCodeStr ); |
| syntaxChecker.setFqcn( className ); |
| |
| // Inject the new OID, as the loaded syntaxChecker might have its own |
| syntaxChecker.setOid( oid ); |
| |
| // Inject the SchemaManager for the comparator who needs it |
| syntaxChecker.setSchemaManager( schemaManager ); |
| |
| return syntaxChecker; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public AbstractSyntaxChecker getSyntaxChecker( SchemaManager schemaManager, Entry entry, Registries targetRegistries, |
| String schemaName ) throws LdapException |
| { |
| checkEntry( entry, SchemaConstants.SYNTAX_CHECKER ); |
| |
| // The SyntaxChecker OID |
| String oid = getOid( entry, SchemaConstants.SYNTAX_CHECKER ); |
| |
| // Get the schema |
| if ( !schemaManager.isSchemaLoaded( schemaName ) ) |
| { |
| // The schema is not loaded. We can't create the requested Normalizer |
| String msg = I18n.err( I18n.ERR_10013, entry.getDn().getName(), schemaName ); |
| LOG.warn( msg ); |
| throw new LdapUnwillingToPerformException( ResultCodeEnum.UNWILLING_TO_PERFORM, msg ); |
| } |
| |
| Schema schema = getSchema( schemaName, targetRegistries ); |
| |
| if ( schema == null ) |
| { |
| // The schema is disabled. We still have to update the backend |
| String msg = I18n.err( I18n.ERR_10014, entry.getDn().getName(), schemaName ); |
| LOG.info( msg ); |
| schema = schemaManager.getLoadedSchema( schemaName ); |
| } |
| |
| // The FQCN |
| String className = getFqcn( entry, SchemaConstants.SYNTAX_CHECKER ); |
| |
| // The ByteCode |
| EntryAttribute byteCode = entry.get( MetaSchemaConstants.M_BYTECODE_AT ); |
| |
| try |
| { |
| // Class load the syntaxChecker |
| AbstractSyntaxChecker syntaxChecker = classLoadSyntaxChecker( schemaManager, oid, className, byteCode ); |
| |
| // Update the common fields |
| setSchemaObjectProperties( syntaxChecker, entry, schema ); |
| |
| // return the resulting syntaxChecker |
| return syntaxChecker; |
| } |
| catch ( Exception e ) |
| { |
| throw new LdapUnwillingToPerformException( ResultCodeEnum.UNWILLING_TO_PERFORM, e.getMessage() ); |
| } |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public SyntaxChecker getSyntaxChecker( SchemaManager schemaManager, |
| SyntaxCheckerDescription syntaxCheckerDescription, Registries targetRegistries, String schemaName ) |
| throws Exception |
| { |
| checkDescription( syntaxCheckerDescription, SchemaConstants.SYNTAX_CHECKER ); |
| |
| // The Comparator OID |
| String oid = getOid( syntaxCheckerDescription, SchemaConstants.SYNTAX_CHECKER ); |
| |
| // Get the schema |
| Schema schema = getSchema( schemaName, targetRegistries ); |
| |
| if ( schema == null ) |
| { |
| // The schema is not loaded. We can't create the requested SyntaxChecker |
| String msg = I18n.err( I18n.ERR_10013, syntaxCheckerDescription.getName(), schemaName ); |
| LOG.warn( msg ); |
| throw new LdapUnwillingToPerformException( ResultCodeEnum.UNWILLING_TO_PERFORM, msg ); |
| } |
| |
| // The FQCN |
| String fqcn = getFqcn( syntaxCheckerDescription, SchemaConstants.SYNTAX_CHECKER ); |
| |
| // get the byteCode |
| EntryAttribute byteCode = getByteCode( syntaxCheckerDescription, SchemaConstants.SYNTAX_CHECKER ); |
| |
| // Class load the SyntaxChecker |
| AbstractSyntaxChecker syntaxChecker = classLoadSyntaxChecker( schemaManager, oid, fqcn, byteCode ); |
| |
| // Update the common fields |
| setSchemaObjectProperties( syntaxChecker, syntaxCheckerDescription, schema ); |
| |
| return syntaxChecker; |
| } |
| |
| |
| /** |
| * Class load a comparator instances |
| */ |
| private AbstractLdapComparator<?> classLoadComparator( SchemaManager schemaManager, String oid, String className, |
| EntryAttribute byteCode ) throws Exception |
| { |
| // Try to class load the comparator |
| AbstractLdapComparator<?> comparator = null; |
| Class<?> clazz = null; |
| String byteCodeStr = StringConstants.EMPTY; |
| |
| if ( byteCode == null ) |
| { |
| clazz = Class.forName( className ); |
| } |
| else |
| { |
| classLoader.setAttribute( byteCode ); |
| clazz = classLoader.loadClass( className ); |
| byteCodeStr = new String( Base64.encode( byteCode.getBytes() ) ); |
| } |
| |
| // Create the comparator instance. Either we have a no argument constructor, |
| // or we have one which takes an OID. Lets try the one with an OID argument first |
| try |
| { |
| Constructor<?> constructor = clazz.getConstructor( new Class[] |
| { String.class } ); |
| comparator = ( AbstractLdapComparator<?> ) constructor.newInstance( new Object[] |
| { oid } ); |
| } |
| catch ( NoSuchMethodException nsme ) |
| { |
| // Ok, let's try with the constructor without argument. |
| // In this case, we will have to check that the OID is the same than |
| // the one we got in the Comparator entry |
| clazz.getConstructor(); |
| comparator = ( AbstractLdapComparator<?> ) clazz.newInstance(); |
| |
| if ( !comparator.getOid().equals( oid ) ) |
| { |
| String msg = I18n.err( I18n.ERR_10015, oid, comparator.getOid() ); |
| throw new LdapInvalidAttributeValueException( ResultCodeEnum.UNWILLING_TO_PERFORM, msg ); |
| } |
| } |
| |
| // Update the loadable fields |
| comparator.setBytecode( byteCodeStr ); |
| comparator.setFqcn( className ); |
| |
| // Inject the SchemaManager for the comparator who needs it |
| comparator.setSchemaManager( schemaManager ); |
| |
| return comparator; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public AbstractLdapComparator<?> getLdapComparator( SchemaManager schemaManager, |
| LdapComparatorDescription comparatorDescription, Registries targetRegistries, String schemaName ) |
| throws Exception |
| { |
| checkDescription( comparatorDescription, SchemaConstants.COMPARATOR ); |
| |
| // The Comparator OID |
| String oid = getOid( comparatorDescription, SchemaConstants.COMPARATOR ); |
| |
| // Get the schema |
| Schema schema = getSchema( schemaName, targetRegistries ); |
| |
| if ( schema == null ) |
| { |
| // The schema is not loaded. We can't create the requested Comparator |
| String msg = I18n.err( I18n.ERR_10016, comparatorDescription.getName(), schemaName ); |
| LOG.warn( msg ); |
| throw new LdapUnwillingToPerformException( ResultCodeEnum.UNWILLING_TO_PERFORM, msg ); |
| } |
| |
| // The FQCN |
| String fqcn = getFqcn( comparatorDescription, SchemaConstants.COMPARATOR ); |
| |
| // get the byteCode |
| EntryAttribute byteCode = getByteCode( comparatorDescription, SchemaConstants.COMPARATOR ); |
| |
| // Class load the comparator |
| AbstractLdapComparator<?> comparator = classLoadComparator( schemaManager, oid, fqcn, byteCode ); |
| |
| // Update the common fields |
| setSchemaObjectProperties( comparator, comparatorDescription, schema ); |
| |
| return comparator; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public AbstractLdapComparator<?> getLdapComparator( SchemaManager schemaManager, Entry entry, Registries targetRegistries, |
| String schemaName ) throws LdapException |
| { |
| checkEntry( entry, SchemaConstants.COMPARATOR ); |
| |
| // The Comparator OID |
| String oid = getOid( entry, SchemaConstants.COMPARATOR ); |
| |
| // Get the schema |
| if ( !schemaManager.isSchemaLoaded( schemaName ) ) |
| { |
| // The schema is not loaded. We can't create the requested Comparator |
| String msg = I18n.err( I18n.ERR_10016, entry.getDn().getName(), schemaName ); |
| LOG.warn( msg ); |
| throw new LdapUnwillingToPerformException( ResultCodeEnum.UNWILLING_TO_PERFORM, msg ); |
| } |
| |
| Schema schema = getSchema( schemaName, targetRegistries ); |
| |
| if ( schema == null ) |
| { |
| // The schema is disabled. We still have to update the backend |
| String msg = I18n.err( I18n.ERR_10017, entry.getDn().getName(), schemaName ); |
| LOG.info( msg ); |
| schema = schemaManager.getLoadedSchema( schemaName ); |
| } |
| |
| // The FQCN |
| String fqcn = getFqcn( entry, SchemaConstants.COMPARATOR ); |
| |
| // The ByteCode |
| EntryAttribute byteCode = entry.get( MetaSchemaConstants.M_BYTECODE_AT ); |
| |
| try |
| { |
| // Class load the comparator |
| AbstractLdapComparator<?> comparator = classLoadComparator( schemaManager, oid, fqcn, byteCode ); |
| |
| // Update the common fields |
| setSchemaObjectProperties( comparator, entry, schema ); |
| |
| // return the resulting comparator |
| return comparator; |
| } |
| catch ( Exception e ) |
| { |
| throw new LdapUnwillingToPerformException( ResultCodeEnum.UNWILLING_TO_PERFORM, e.getMessage() ); |
| } |
| } |
| |
| |
| /** |
| * Class load a normalizer instances |
| */ |
| private AbstractNormalizer classLoadNormalizer( SchemaManager schemaManager, String oid, String className, |
| EntryAttribute byteCode ) throws Exception |
| { |
| // Try to class load the normalizer |
| Class<?> clazz = null; |
| AbstractNormalizer normalizer = null; |
| String byteCodeStr = StringConstants.EMPTY; |
| |
| if ( byteCode == null ) |
| { |
| clazz = Class.forName( className ); |
| } |
| else |
| { |
| classLoader.setAttribute( byteCode ); |
| clazz = classLoader.loadClass( className ); |
| byteCodeStr = new String( Base64.encode( byteCode.getBytes() ) ); |
| } |
| |
| // Create the normalizer instance |
| normalizer = ( AbstractNormalizer ) clazz.newInstance(); |
| |
| // Update the common fields |
| normalizer.setBytecode( byteCodeStr ); |
| normalizer.setFqcn( className ); |
| |
| // Inject the new OID, as the loaded normalizer might have its own |
| normalizer.setOid( oid ); |
| |
| // Inject the SchemaManager for the normalizer who needs it |
| normalizer.setSchemaManager( schemaManager ); |
| |
| return normalizer; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public Normalizer getNormalizer( SchemaManager schemaManager, NormalizerDescription normalizerDescription, |
| Registries targetRegistries, String schemaName ) throws Exception |
| { |
| checkDescription( normalizerDescription, SchemaConstants.NORMALIZER ); |
| |
| // The Comparator OID |
| String oid = getOid( normalizerDescription, SchemaConstants.NORMALIZER ); |
| |
| // Get the schema |
| Schema schema = getSchema( schemaName, targetRegistries ); |
| |
| if ( schema == null ) |
| { |
| // The schema is not loaded. We can't create the requested Normalizer |
| String msg = I18n.err( I18n.ERR_10018, normalizerDescription.getName(), schemaName ); |
| LOG.warn( msg ); |
| throw new LdapUnwillingToPerformException( ResultCodeEnum.UNWILLING_TO_PERFORM, msg ); |
| } |
| |
| // The FQCN |
| String fqcn = getFqcn( normalizerDescription, SchemaConstants.NORMALIZER ); |
| |
| // get the byteCode |
| EntryAttribute byteCode = getByteCode( normalizerDescription, SchemaConstants.NORMALIZER ); |
| |
| // Class load the normalizer |
| AbstractNormalizer normalizer = classLoadNormalizer( schemaManager, oid, fqcn, byteCode ); |
| |
| // Update the common fields |
| setSchemaObjectProperties( normalizer, normalizerDescription, schema ); |
| |
| return normalizer; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public AbstractNormalizer getNormalizer( SchemaManager schemaManager, Entry entry, Registries targetRegistries, |
| String schemaName ) throws LdapException |
| { |
| checkEntry( entry, SchemaConstants.NORMALIZER ); |
| |
| // The Normalizer OID |
| String oid = getOid( entry, SchemaConstants.NORMALIZER ); |
| |
| // Get the schema |
| if ( !schemaManager.isSchemaLoaded( schemaName ) ) |
| { |
| // The schema is not loaded. We can't create the requested Normalizer |
| String msg = I18n.err( I18n.ERR_10018, entry.getDn().getName(), schemaName ); |
| LOG.warn( msg ); |
| throw new LdapUnwillingToPerformException( ResultCodeEnum.UNWILLING_TO_PERFORM, msg ); |
| } |
| |
| Schema schema = getSchema( schemaName, targetRegistries ); |
| |
| if ( schema == null ) |
| { |
| // The schema is disabled. We still have to update the backend |
| String msg = I18n.err( I18n.ERR_10019, entry.getDn().getName(), schemaName ); |
| LOG.info( msg ); |
| schema = schemaManager.getLoadedSchema( schemaName ); |
| } |
| |
| // The FQCN |
| String className = getFqcn( entry, SchemaConstants.NORMALIZER ); |
| |
| // The ByteCode |
| EntryAttribute byteCode = entry.get( MetaSchemaConstants.M_BYTECODE_AT ); |
| |
| try |
| { |
| // Class load the Normalizer |
| AbstractNormalizer normalizer = classLoadNormalizer( schemaManager, oid, className, byteCode ); |
| |
| // Update the common fields |
| setSchemaObjectProperties( normalizer, entry, schema ); |
| |
| // return the resulting Normalizer |
| return normalizer; |
| } |
| catch ( Exception e ) |
| { |
| throw new LdapUnwillingToPerformException( ResultCodeEnum.UNWILLING_TO_PERFORM, e.getMessage() ); |
| } |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| * @throws LdapInvalidAttributeValueException |
| * @throws LdapUnwillingToPerformException |
| */ |
| public MutableLdapSyntaxImpl getSyntax( SchemaManager schemaManager, Entry entry, Registries targetRegistries, |
| String schemaName ) throws LdapInvalidAttributeValueException, LdapUnwillingToPerformException |
| { |
| checkEntry( entry, SchemaConstants.SYNTAX ); |
| |
| // The Syntax OID |
| String oid = getOid( entry, SchemaConstants.SYNTAX ); |
| |
| // Get the schema |
| if ( !schemaManager.isSchemaLoaded( schemaName ) ) |
| { |
| // The schema is not loaded. We can't create the requested Syntax |
| String msg = I18n.err( I18n.ERR_10020, entry.getDn().getName(), schemaName ); |
| LOG.warn( msg ); |
| throw new LdapUnwillingToPerformException( ResultCodeEnum.UNWILLING_TO_PERFORM, msg ); |
| } |
| |
| Schema schema = getSchema( schemaName, targetRegistries ); |
| |
| if ( schema == null ) |
| { |
| // The schema is disabled. We still have to update the backend |
| String msg = I18n.err( I18n.ERR_10021, entry.getDn().getName(), schemaName ); |
| LOG.info( msg ); |
| schema = schemaManager.getLoadedSchema( schemaName ); |
| } |
| |
| // Create the new LdapSyntax instance |
| MutableLdapSyntaxImpl syntax = new MutableLdapSyntaxImpl( oid ); |
| |
| // The isHumanReadable field |
| EntryAttribute mHumanReadable = entry.get( MetaSchemaConstants.X_HUMAN_READABLE_AT ); |
| |
| if ( mHumanReadable != null ) |
| { |
| String val = mHumanReadable.getString(); |
| syntax.setHumanReadable( val.toUpperCase().equals( "TRUE" ) ); |
| } |
| |
| // Common properties |
| setSchemaObjectProperties( syntax, entry, schema ); |
| |
| return syntax; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| * @throws LdapUnwillingToPerformException |
| * @throws LdapInvalidAttributeValueException |
| */ |
| public MutableMatchingRuleImpl getMatchingRule( SchemaManager schemaManager, Entry entry, Registries targetRegistries, |
| String schemaName ) throws LdapUnwillingToPerformException, LdapInvalidAttributeValueException |
| { |
| checkEntry( entry, SchemaConstants.MATCHING_RULE ); |
| |
| // The MatchingRule OID |
| String oid = getOid( entry, SchemaConstants.MATCHING_RULE ); |
| |
| // Get the schema |
| if ( !schemaManager.isSchemaLoaded( schemaName ) ) |
| { |
| // The schema is not loaded. We can't create the requested MatchingRule |
| String msg = I18n.err( I18n.ERR_10022, entry.getDn().getName(), schemaName ); |
| LOG.warn( msg ); |
| throw new LdapUnwillingToPerformException( ResultCodeEnum.UNWILLING_TO_PERFORM, msg ); |
| } |
| |
| Schema schema = getSchema( schemaName, targetRegistries ); |
| |
| if ( schema == null ) |
| { |
| // The schema is disabled. We still have to update the backend |
| String msg = I18n.err( I18n.ERR_10023, entry.getDn().getName(), schemaName ); |
| LOG.info( msg ); |
| schema = schemaManager.getLoadedSchema( schemaName ); |
| } |
| |
| MutableMatchingRuleImpl matchingRule = new MutableMatchingRuleImpl( oid ); |
| |
| // The syntax field |
| EntryAttribute mSyntax = entry.get( MetaSchemaConstants.M_SYNTAX_AT ); |
| |
| if ( mSyntax != null ) |
| { |
| matchingRule.setSyntaxOid( mSyntax.getString() ); |
| } |
| |
| // The normalizer and comparator fields will be updated when we will |
| // apply the registry |
| |
| // Common properties |
| setSchemaObjectProperties( matchingRule, entry, schema ); |
| |
| return matchingRule; |
| } |
| |
| |
| /** |
| * Create a list of string from a multivalued attribute's values |
| */ |
| private List<String> getStrings( EntryAttribute attr ) |
| { |
| if ( attr == null ) |
| { |
| return EMPTY_LIST; |
| } |
| |
| List<String> strings = new ArrayList<String>( attr.size() ); |
| |
| for ( Value<?> value : attr ) |
| { |
| strings.add( value.getString() ); |
| } |
| |
| return strings; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public ObjectClass getObjectClass( SchemaManager schemaManager, Entry entry, Registries targetRegistries, |
| String schemaName ) throws LdapException |
| { |
| checkEntry( entry, SchemaConstants.OBJECT_CLASS ); |
| |
| // The ObjectClass OID |
| String oid = getOid( entry, SchemaConstants.OBJECT_CLASS ); |
| |
| // Get the schema |
| if ( !schemaManager.isSchemaLoaded( schemaName ) ) |
| { |
| // The schema is not loaded. We can't create the requested ObjectClass |
| String msg = I18n.err( I18n.ERR_10024, entry.getDn().getName(), schemaName ); |
| LOG.warn( msg ); |
| throw new LdapUnwillingToPerformException( ResultCodeEnum.UNWILLING_TO_PERFORM, msg ); |
| } |
| |
| Schema schema = getSchema( schemaName, targetRegistries ); |
| |
| if ( schema == null ) |
| { |
| // The schema is disabled. We still have to update the backend |
| String msg = I18n.err( I18n.ERR_10025, entry.getDn().getName(), schemaName ); |
| LOG.info( msg ); |
| schema = schemaManager.getLoadedSchema( schemaName ); |
| } |
| |
| // Create the ObjectClass instance |
| ObjectClass oc = new ObjectClass( oid ); |
| |
| // The Sup field |
| EntryAttribute mSuperiors = entry.get( MetaSchemaConstants.M_SUP_OBJECT_CLASS_AT ); |
| |
| if ( mSuperiors != null ) |
| { |
| oc.setSuperiorOids( getStrings( mSuperiors ) ); |
| } |
| |
| // The May field |
| EntryAttribute mMay = entry.get( MetaSchemaConstants.M_MAY_AT ); |
| |
| if ( mMay != null ) |
| { |
| oc.setMayAttributeTypeOids( getStrings( mMay ) ); |
| } |
| |
| // The Must field |
| EntryAttribute mMust = entry.get( MetaSchemaConstants.M_MUST_AT ); |
| |
| if ( mMust != null ) |
| { |
| oc.setMustAttributeTypeOids( getStrings( mMust ) ); |
| } |
| |
| // The objectClassType field |
| EntryAttribute mTypeObjectClass = entry.get( MetaSchemaConstants.M_TYPE_OBJECT_CLASS_AT ); |
| |
| if ( mTypeObjectClass != null ) |
| { |
| String type = mTypeObjectClass.getString(); |
| oc.setType( ObjectClassTypeEnum.getClassType( type ) ); |
| } |
| |
| // Common properties |
| setSchemaObjectProperties( oc, entry, schema ); |
| |
| return oc; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| * @throws LdapInvalidAttributeValueException |
| * @throws LdapUnwillingToPerformException |
| */ |
| public AttributeType getAttributeType( SchemaManager schemaManager, Entry entry, Registries targetRegistries, |
| String schemaName ) throws LdapInvalidAttributeValueException, LdapUnwillingToPerformException |
| { |
| checkEntry( entry, SchemaConstants.ATTRIBUTE_TYPE ); |
| |
| // The AttributeType OID |
| String oid = getOid( entry, SchemaConstants.ATTRIBUTE_TYPE ); |
| |
| // Get the schema |
| if ( !schemaManager.isSchemaLoaded( schemaName ) ) |
| { |
| // The schema is not loaded, this is an error |
| String msg = I18n.err( I18n.ERR_10026, entry.getDn().getName(), schemaName ); |
| LOG.warn( msg ); |
| throw new LdapUnwillingToPerformException( ResultCodeEnum.UNWILLING_TO_PERFORM, msg ); |
| } |
| |
| Schema schema = getSchema( schemaName, targetRegistries ); |
| |
| if ( schema == null ) |
| { |
| // The schema is disabled. We still have to update the backend |
| String msg = I18n.err( I18n.ERR_10027, entry.getDn().getName(), schemaName ); |
| LOG.info( msg ); |
| schema = schemaManager.getLoadedSchema( schemaName ); |
| } |
| |
| // Create the new AttributeType |
| AttributeType attributeType = new AttributeType( oid ); |
| |
| // Syntax |
| EntryAttribute mSyntax = entry.get( MetaSchemaConstants.M_SYNTAX_AT ); |
| |
| if ( ( mSyntax != null ) && ( mSyntax.get() != null ) ) |
| { |
| mSyntax.setHR( true ); |
| attributeType.setSyntaxOid( mSyntax.getString() ); |
| } |
| |
| // Syntax Length |
| EntryAttribute mSyntaxLength = entry.get( MetaSchemaConstants.M_LENGTH_AT ); |
| |
| if ( mSyntaxLength != null ) |
| { |
| mSyntaxLength.setHR( true ); |
| attributeType.setSyntaxLength( Integer.parseInt( mSyntaxLength.getString() ) ); |
| } |
| |
| // Equality |
| EntryAttribute mEquality = entry.get( MetaSchemaConstants.M_EQUALITY_AT ); |
| |
| if ( mEquality != null ) |
| { |
| mEquality.setHR( true ); |
| attributeType.setEqualityOid( mEquality.getString() ); |
| } |
| |
| // Ordering |
| EntryAttribute mOrdering = entry.get( MetaSchemaConstants.M_ORDERING_AT ); |
| |
| if ( mOrdering != null ) |
| { |
| mOrdering.setHR( true ); |
| attributeType.setOrderingOid( mOrdering.getString() ); |
| } |
| |
| // Substr |
| EntryAttribute mSubstr = entry.get( MetaSchemaConstants.M_SUBSTR_AT ); |
| |
| if ( mSubstr != null ) |
| { |
| mSubstr.setHR( true ); |
| attributeType.setSubstringOid( mSubstr.getString() ); |
| } |
| |
| EntryAttribute mSupAttributeType = entry.get( MetaSchemaConstants.M_SUP_ATTRIBUTE_TYPE_AT ); |
| |
| // Sup |
| if ( mSupAttributeType != null ) |
| { |
| mSupAttributeType.setHR( true ); |
| attributeType.setSuperiorOid( mSupAttributeType.getString() ); |
| } |
| |
| // isCollective |
| EntryAttribute mCollective = entry.get( MetaSchemaConstants.M_COLLECTIVE_AT ); |
| |
| if ( mCollective != null ) |
| { |
| mCollective.setHR( true ); |
| String val = mCollective.getString(); |
| attributeType.setCollective( val.equalsIgnoreCase( "TRUE" ) ); |
| } |
| |
| // isSingleValued |
| EntryAttribute mSingleValued = entry.get( MetaSchemaConstants.M_SINGLE_VALUE_AT ); |
| |
| if ( mSingleValued != null ) |
| { |
| mSingleValued.setHR( true ); |
| String val = mSingleValued.getString(); |
| attributeType.setSingleValued( val.equalsIgnoreCase( "TRUE" ) ); |
| } |
| |
| // isReadOnly |
| EntryAttribute mNoUserModification = entry.get( MetaSchemaConstants.M_NO_USER_MODIFICATION_AT ); |
| |
| if ( mNoUserModification != null ) |
| { |
| mNoUserModification.setHR( true ); |
| String val = mNoUserModification.getString(); |
| attributeType.setUserModifiable( !val.equalsIgnoreCase( "TRUE" ) ); |
| } |
| |
| // Usage |
| EntryAttribute mUsage = entry.get( MetaSchemaConstants.M_USAGE_AT ); |
| |
| if ( mUsage != null ) |
| { |
| mUsage.setHR( true ); |
| attributeType.setUsage( UsageEnum.getUsage( mUsage.getString() ) ); |
| } |
| |
| // Common properties |
| setSchemaObjectProperties( attributeType, entry, schema ); |
| |
| return attributeType; |
| } |
| |
| |
| /** |
| * Process the FQCN attribute |
| * @throws LdapInvalidAttributeValueException |
| */ |
| private String getFqcn( Entry entry, String objectType ) throws LdapInvalidAttributeValueException |
| { |
| // The FQCN |
| EntryAttribute mFqcn = entry.get( MetaSchemaConstants.M_FQCN_AT ); |
| |
| if ( mFqcn == null ) |
| { |
| String msg = I18n.err( I18n.ERR_10028, objectType, MetaSchemaConstants.M_FQCN_AT ); |
| LOG.warn( msg ); |
| throw new IllegalArgumentException( msg ); |
| } |
| |
| return mFqcn.getString(); |
| } |
| |
| |
| /** |
| * Process the FQCN attribute |
| */ |
| private String getFqcn( LoadableSchemaObject description, String objectType ) |
| { |
| // The FQCN |
| String mFqcn = description.getFqcn(); |
| |
| if ( mFqcn == null ) |
| { |
| String msg = I18n.err( I18n.ERR_10028, objectType, MetaSchemaConstants.M_FQCN_AT ); |
| LOG.warn( msg ); |
| throw new IllegalArgumentException( msg ); |
| } |
| |
| return mFqcn; |
| } |
| |
| |
| /** |
| * Process the ByteCode attribute |
| */ |
| private EntryAttribute getByteCode( LoadableSchemaObject description, String objectType ) |
| { |
| String byteCodeString = description.getBytecode(); |
| |
| if ( byteCodeString == null ) |
| { |
| String msg = I18n.err( I18n.ERR_10028, objectType, MetaSchemaConstants.M_BYTECODE_AT ); |
| LOG.warn( msg ); |
| throw new IllegalArgumentException( msg ); |
| } |
| |
| byte[] bytecode = Base64.decode( byteCodeString.toCharArray() ); |
| EntryAttribute attr = new DefaultEntryAttribute( MetaSchemaConstants.M_BYTECODE_AT, bytecode ); |
| |
| return attr; |
| } |
| |
| |
| /** |
| * Process the common attributes to all SchemaObjects : |
| * - obsolete |
| * - description |
| * - names |
| * - schemaName |
| * - specification (if any) |
| * - extensions |
| * - isReadOnly |
| * - isEnabled |
| * @throws org.apache.directory.shared.ldap.model.exception.LdapInvalidAttributeValueException |
| */ |
| private void setSchemaObjectProperties( MutableSchemaObject schemaObject, Entry entry, Schema schema ) |
| throws LdapInvalidAttributeValueException |
| { |
| // The isObsolete field |
| EntryAttribute mObsolete = entry.get( MetaSchemaConstants.M_OBSOLETE_AT ); |
| |
| if ( mObsolete != null ) |
| { |
| mObsolete.setHR( true ); |
| String val = mObsolete.getString(); |
| schemaObject.setObsolete( val.equalsIgnoreCase( "TRUE" ) ); |
| } |
| |
| // The description field |
| EntryAttribute mDescription = entry.get( MetaSchemaConstants.M_DESCRIPTION_AT ); |
| |
| if ( mDescription != null ) |
| { |
| mDescription.setHR( true ); |
| schemaObject.setDescription( mDescription.getString() ); |
| } |
| |
| // The names field |
| EntryAttribute names = entry.get( MetaSchemaConstants.M_NAME_AT ); |
| |
| if ( names != null ) |
| { |
| names.setHR( true ); |
| List<String> values = new ArrayList<String>(); |
| |
| for ( Value<?> name : names ) |
| { |
| values.add( name.getString() ); |
| } |
| |
| schemaObject.setNames( values ); |
| } |
| |
| // The isEnabled field |
| EntryAttribute mDisabled = entry.get( MetaSchemaConstants.M_DISABLED_AT ); |
| |
| // If the SchemaObject has an explicit m-disabled attribute, then use it. |
| // Otherwise, inherit it from the schema |
| if ( mDisabled != null ) |
| { |
| mDisabled.setHR( true ); |
| String val = mDisabled.getString(); |
| schemaObject.setEnabled( !val.equalsIgnoreCase( "TRUE" ) ); |
| } |
| else |
| { |
| schemaObject.setEnabled( schema != null && schema.isEnabled() ); |
| } |
| |
| // The isReadOnly field |
| EntryAttribute mIsReadOnly = entry.get( MetaSchemaConstants.M_NO_USER_MODIFICATION_AT ); |
| |
| if ( mIsReadOnly != null ) |
| { |
| mIsReadOnly.setHR( true ); |
| String val = mIsReadOnly.getString(); |
| schemaObject.setReadOnly( val.equalsIgnoreCase( "TRUE" ) ); |
| } |
| |
| // The specification field |
| /* |
| * TODO : create the M_SPECIFICATION_AT |
| EntryAttribute mSpecification = entry.get( MetaSchemaConstants.M_SPECIFICATION_AT ); |
| |
| if ( mSpecification != null ) |
| { |
| so.setSpecification( mSpecification.getString() ); |
| } |
| */ |
| |
| // The schemaName field |
| schemaObject.setSchemaName( schema.getSchemaName() ); |
| |
| // The extensions field |
| /* |
| * TODO create the M_EXTENSION_AT AT |
| EntryAttribute extensions = entry.get( MetaSchemaConstants.M_EXTENSION_AT ); |
| |
| if ( extensions != null ) |
| { |
| List<String> extensions = new ArrayList<String>(); |
| |
| for ( Value<?> extension:extensions ) |
| { |
| values.add( extension() ); |
| } |
| |
| so.setExtensions( values ); |
| } |
| */ |
| } |
| |
| |
| /** |
| * Process the common attributes to all SchemaObjects : |
| * - obsolete |
| * - description |
| * - names |
| * - schemaName |
| * - specification (if any) |
| * - extensions |
| * - isReadOnly |
| * - isEnabled |
| */ |
| private void setSchemaObjectProperties( MutableSchemaObject schemaObject, SchemaObject description, Schema schema ) |
| { |
| // The isObsolete field |
| schemaObject.setObsolete( description.isObsolete() ); |
| |
| // The description field |
| schemaObject.setDescription( description.getDescription() ); |
| |
| // The names field |
| schemaObject.setNames( description.getNames() ); |
| |
| // The isEnabled field. Has the description does not hold a |
| // Disable field, we will inherit from the schema enable field |
| schemaObject.setEnabled( schema.isEnabled() ); |
| |
| // The isReadOnly field. We don't have this data in the description, |
| // so set it to false |
| // TODO : should it be a X-READONLY extension ? |
| schemaObject.setReadOnly( false ); |
| |
| // The specification field |
| schemaObject.setSpecification( description.getSpecification() ); |
| |
| // The schemaName field |
| schemaObject.setSchemaName( schema.getSchemaName() ); |
| |
| // The extensions field |
| schemaObject.setExtensions( description.getExtensions() ); |
| } |
| } |
