| /* |
| * 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.utils; |
| |
| |
| import java.util.Comparator; |
| |
| import javax.naming.NamingException; |
| |
| import org.apache.directory.server.constants.MetaSchemaConstants; |
| import org.apache.directory.server.core.entry.DefaultServerAttribute; |
| import org.apache.directory.server.core.entry.DefaultServerEntry; |
| import org.apache.directory.server.core.entry.ServerEntry; |
| import org.apache.directory.server.schema.bootstrap.Schema; |
| import org.apache.directory.server.schema.registries.Registries; |
| import org.apache.directory.shared.ldap.constants.SchemaConstants; |
| import org.apache.directory.shared.ldap.entry.EntryAttribute; |
| import org.apache.directory.shared.ldap.schema.AttributeType; |
| import org.apache.directory.shared.ldap.schema.DITContentRule; |
| import org.apache.directory.shared.ldap.schema.DITStructureRule; |
| import org.apache.directory.shared.ldap.schema.MatchingRule; |
| import org.apache.directory.shared.ldap.schema.MatchingRuleUse; |
| import org.apache.directory.shared.ldap.schema.NameForm; |
| import org.apache.directory.shared.ldap.schema.Normalizer; |
| import org.apache.directory.shared.ldap.schema.ObjectClass; |
| import org.apache.directory.shared.ldap.schema.SchemaObject; |
| import org.apache.directory.shared.ldap.schema.Syntax; |
| import org.apache.directory.shared.ldap.schema.syntax.SyntaxChecker; |
| import org.apache.directory.shared.ldap.util.DateUtils; |
| |
| |
| /** |
| * A factory that generates an entry using the meta schema for schema |
| * elements. |
| * |
| * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> |
| * @version $Rev$ |
| */ |
| public class AttributesFactory |
| { |
| public ServerEntry getAttributes( SchemaObject obj, Schema schema, Registries registries ) throws NamingException |
| { |
| if ( obj instanceof Syntax ) |
| { |
| return getAttributes( ( Syntax ) obj, schema, registries ); |
| } |
| else if ( obj instanceof MatchingRule ) |
| { |
| return getAttributes( ( MatchingRule ) obj, schema, registries ); |
| } |
| else if ( obj instanceof AttributeType ) |
| { |
| return getAttributes( ( AttributeType ) obj, schema, registries ); |
| } |
| else if ( obj instanceof ObjectClass ) |
| { |
| return getAttributes( ( ObjectClass ) obj, schema, registries ); |
| } |
| else if ( obj instanceof MatchingRuleUse ) |
| { |
| return getAttributes( ( MatchingRuleUse ) obj, schema, registries ); |
| } |
| else if ( obj instanceof DITStructureRule ) |
| { |
| return getAttributes( ( DITStructureRule ) obj, schema, registries ); |
| } |
| else if ( obj instanceof DITContentRule ) |
| { |
| return getAttributes( ( DITContentRule ) obj, schema, registries ); |
| } |
| else if ( obj instanceof NameForm ) |
| { |
| return getAttributes( ( NameForm ) obj, schema, registries ); |
| } |
| |
| throw new IllegalArgumentException( "Unknown SchemaObject type: " + obj.getClass() ); |
| } |
| |
| |
| public ServerEntry getAttributes( Schema schema, Registries registries ) throws NamingException |
| { |
| ServerEntry entry = new DefaultServerEntry( registries ); |
| |
| entry.put( SchemaConstants.OBJECT_CLASS_AT, SchemaConstants.TOP_OC, MetaSchemaConstants.META_SCHEMA_OC ); |
| entry.put( SchemaConstants.CN_AT, schema.getSchemaName() ); |
| entry.put( SchemaConstants.CREATORS_NAME_AT, schema.getOwner() ); |
| entry.put( SchemaConstants.CREATE_TIMESTAMP_AT, DateUtils.getGeneralizedTime() ); |
| |
| if ( schema.isDisabled() ) |
| { |
| entry.put( MetaSchemaConstants.M_DISABLED_AT, "TRUE" ); |
| } |
| |
| String[] dependencies = schema.getDependencies(); |
| |
| if ( dependencies != null && dependencies.length > 0 ) |
| { |
| EntryAttribute attr = new DefaultServerAttribute( registries.getAttributeTypeRegistry().lookup( MetaSchemaConstants.M_DEPENDENCIES_AT ) ); |
| |
| for ( String dependency:dependencies ) |
| { |
| attr.add( dependency ); |
| } |
| |
| entry.put( attr ); |
| } |
| |
| return entry; |
| } |
| |
| |
| public ServerEntry getAttributes( SyntaxChecker syntaxChecker, Schema schema, Registries registries ) |
| { |
| ServerEntry entry = new DefaultServerEntry( registries ); |
| |
| entry.put( SchemaConstants.OBJECT_CLASS_AT, SchemaConstants.TOP_OC, MetaSchemaConstants.META_SYNTAX_CHECKER_OC ); |
| entry.put( MetaSchemaConstants.M_OID_AT, syntaxChecker.getSyntaxOid() ); |
| entry.put( MetaSchemaConstants.M_FQCN_AT, syntaxChecker.getClass().getName() ); |
| entry.put( SchemaConstants.CREATORS_NAME_AT, schema.getOwner() ); |
| entry.put( SchemaConstants.CREATE_TIMESTAMP_AT, DateUtils.getGeneralizedTime() ); |
| |
| return entry; |
| } |
| |
| |
| public ServerEntry getAttributes( Syntax syntax, Schema schema, Registries registries ) throws NamingException |
| { |
| ServerEntry entry = new DefaultServerEntry( registries ); |
| |
| entry.put( SchemaConstants.OBJECT_CLASS_AT, SchemaConstants.TOP_OC, MetaSchemaConstants.META_SYNTAX_OC ); |
| entry.put( MetaSchemaConstants.X_HUMAN_READABLE_AT, getBoolean( syntax.isHumanReadable() ) ); |
| entry.put( SchemaConstants.CREATORS_NAME_AT, schema.getOwner() ); |
| entry.put( SchemaConstants.CREATE_TIMESTAMP_AT, DateUtils.getGeneralizedTime() ); |
| injectCommon( syntax, entry, registries ); |
| |
| return entry; |
| } |
| |
| |
| public ServerEntry getAttributes( String oid, Normalizer normalizer, Schema schema, Registries registries ) |
| { |
| ServerEntry entry = new DefaultServerEntry( registries ); |
| |
| entry.put( SchemaConstants.OBJECT_CLASS_AT, SchemaConstants.TOP_OC, MetaSchemaConstants.META_NORMALIZER_OC ); |
| entry.put( MetaSchemaConstants.M_OID_AT, oid ); |
| entry.put( MetaSchemaConstants.M_FQCN_AT, normalizer.getClass().getName() ); |
| entry.put( SchemaConstants.CREATORS_NAME_AT, schema.getOwner() ); |
| entry.put( SchemaConstants.CREATE_TIMESTAMP_AT, DateUtils.getGeneralizedTime() ); |
| return entry; |
| } |
| |
| |
| public ServerEntry getAttributes( String oid, Comparator comparator, Schema schema, Registries registries ) |
| { |
| ServerEntry entry = new DefaultServerEntry( registries ); |
| |
| entry.put( SchemaConstants.OBJECT_CLASS_AT, SchemaConstants.TOP_OC, MetaSchemaConstants.META_COMPARATOR_OC ); |
| entry.put( MetaSchemaConstants.M_OID_AT, oid ); |
| entry.put( MetaSchemaConstants.M_FQCN_AT, comparator.getClass().getName() ); |
| entry.put( SchemaConstants.CREATORS_NAME_AT, schema.getOwner() ); |
| entry.put( SchemaConstants.CREATE_TIMESTAMP_AT, DateUtils.getGeneralizedTime() ); |
| return entry; |
| } |
| |
| |
| /** |
| * |
| * @param matchingRule |
| * @return Attributes |
| * @throws NamingException |
| */ |
| public ServerEntry getAttributes( MatchingRule matchingRule, Schema schema, Registries registries ) throws NamingException |
| { |
| ServerEntry entry = new DefaultServerEntry( registries ); |
| |
| entry.put( SchemaConstants.OBJECT_CLASS_AT, SchemaConstants.TOP_OC, MetaSchemaConstants.META_MATCHING_RULE_OC ); |
| entry.put( MetaSchemaConstants.M_SYNTAX_AT, matchingRule.getSyntax().getOid() ); |
| entry.put( SchemaConstants.CREATORS_NAME_AT, schema.getOwner() ); |
| entry.put( SchemaConstants.CREATE_TIMESTAMP_AT, DateUtils.getGeneralizedTime() ); |
| injectCommon( matchingRule, entry, registries ); |
| return entry; |
| } |
| |
| |
| public ServerEntry getAttributes( MatchingRuleUse matchingRuleUse, Schema schema, Registries registries ) |
| { |
| ServerEntry entry = new DefaultServerEntry( registries ); |
| |
| entry.put( SchemaConstants.OBJECT_CLASS_AT, SchemaConstants.TOP_OC, "" ); |
| entry.put( SchemaConstants.CREATORS_NAME_AT, schema.getOwner() ); |
| entry.put( SchemaConstants.CREATE_TIMESTAMP_AT, DateUtils.getGeneralizedTime() ); |
| return entry; |
| } |
| |
| |
| public ServerEntry getAttributes( DITStructureRule dITStructureRule, Schema schema, Registries registries ) |
| { |
| ServerEntry entry = new DefaultServerEntry( registries ); |
| |
| entry.put( SchemaConstants.OBJECT_CLASS_AT, SchemaConstants.TOP_OC, "" ); |
| entry.put( SchemaConstants.CREATORS_NAME_AT, schema.getOwner() ); |
| entry.put( SchemaConstants.CREATE_TIMESTAMP_AT, DateUtils.getGeneralizedTime() ); |
| return entry; |
| } |
| |
| |
| public ServerEntry getAttributes( DITContentRule dITContentRule, Schema schema, Registries registries ) |
| { |
| ServerEntry entry = new DefaultServerEntry( registries ); |
| |
| entry.put( SchemaConstants.OBJECT_CLASS_AT, SchemaConstants.TOP_OC, "" ); |
| entry.put( SchemaConstants.CREATORS_NAME_AT, schema.getOwner() ); |
| entry.put( SchemaConstants.CREATE_TIMESTAMP_AT, DateUtils.getGeneralizedTime() ); |
| return entry; |
| } |
| |
| |
| public ServerEntry getAttributes( NameForm nameForm, Schema schema, Registries registries ) |
| { |
| ServerEntry entry = new DefaultServerEntry( registries ); |
| |
| entry.put( SchemaConstants.OBJECT_CLASS_AT, SchemaConstants.TOP_OC, "" ); |
| entry.put( SchemaConstants.CREATORS_NAME_AT, schema.getOwner() ); |
| entry.put( SchemaConstants.CREATE_TIMESTAMP_AT, DateUtils.getGeneralizedTime() ); |
| return entry; |
| } |
| |
| |
| /** |
| * <pre> |
| * objectclass ( 1.3.6.1.4.1.18060.0.4.0.3.3 |
| * NAME 'metaAttributeType' |
| * DESC 'meta definition of the AttributeType object' |
| * SUP metaTop |
| * STRUCTURAL |
| * MUST ( m-name $ m-syntax ) |
| * MAY ( m-supAttributeType $ m-obsolete $ m-equality $ m-ordering $ |
| * m-substr $ m-singleValue $ m-collective $ m-noUserModification $ |
| * m-usage $ m-extensionAttributeType ) |
| * ) |
| * </pre> |
| * |
| * @param attributeType |
| * @return Attributes |
| * @throws NamingException |
| */ |
| public ServerEntry getAttributes( AttributeType attributeType, Schema schema, Registries registries ) throws NamingException |
| { |
| ServerEntry entry = new DefaultServerEntry( registries ); |
| |
| entry.put( SchemaConstants.OBJECT_CLASS_AT, SchemaConstants.TOP_OC, MetaSchemaConstants.META_ATTRIBUTE_TYPE_OC ); |
| entry.put( MetaSchemaConstants.M_SYNTAX_AT, attributeType.getSyntax().getOid() ); |
| entry.put( MetaSchemaConstants.M_COLLECTIVE_AT, getBoolean( attributeType.isCollective() ) ); |
| entry.put( MetaSchemaConstants.M_NO_USER_MODIFICATION_AT, getBoolean( ! attributeType.isCanUserModify() ) ); |
| entry.put( MetaSchemaConstants.M_SINGLE_VALUE_AT, getBoolean( attributeType.isSingleValue() ) ); |
| entry.put( MetaSchemaConstants.M_USAGE_AT, attributeType.getUsage().toString() ); |
| entry.put( SchemaConstants.CREATORS_NAME_AT, schema.getOwner() ); |
| entry.put( SchemaConstants.CREATE_TIMESTAMP_AT, DateUtils.getGeneralizedTime() ); |
| |
| injectCommon( attributeType, entry, registries ); |
| |
| AttributeType superior = attributeType.getSuperior(); |
| |
| if ( superior != null ) |
| { |
| // use name if we can for clarity |
| String sup = superior.getName(); |
| |
| if ( sup == null ) |
| { |
| sup = superior.getOid(); |
| } |
| |
| entry.put( MetaSchemaConstants.M_SUP_ATTRIBUTE_TYPE_AT, sup ); |
| } |
| |
| if ( attributeType.getEquality() != null ) |
| { |
| String equality = attributeType.getEquality().getName(); |
| |
| if ( equality == null ) |
| { |
| equality = attributeType.getEquality().getOid(); |
| } |
| |
| entry.put( MetaSchemaConstants.M_EQUALITY_AT, equality ); |
| } |
| |
| if ( attributeType.getSubstr() != null ) |
| { |
| String substr = attributeType.getSubstr().getName(); |
| |
| if ( substr == null ) |
| { |
| substr = attributeType.getSubstr().getOid(); |
| } |
| |
| entry.put( MetaSchemaConstants.M_SUBSTR_AT, substr ); |
| } |
| |
| if ( attributeType.getOrdering() != null ) |
| { |
| String ordering = attributeType.getOrdering().getName(); |
| |
| if ( ordering == null ) |
| { |
| ordering = attributeType.getOrdering().getOid(); |
| } |
| |
| entry.put( MetaSchemaConstants.M_ORDERING_AT, ordering ); |
| } |
| |
| return entry; |
| } |
| |
| |
| /** |
| * Creates the attributes of an entry representing an objectClass. |
| * |
| * <pre> |
| * objectclass ( 1.3.6.1.4.1.18060.0.4.0.3.2 |
| * NAME 'metaObjectClass' |
| * DESC 'meta definition of the objectclass object' |
| * SUP metaTop |
| * STRUCTURAL |
| * MUST m-oid |
| * MAY ( m-name $ m-obsolete $ m-supObjectClass $ m-typeObjectClass $ m-must $ |
| * m-may $ m-extensionObjectClass ) |
| * ) |
| * </pre> |
| * |
| * @param objectClass the objectClass to produce a meta schema entry for |
| * @return the attributes of the metaSchema entry representing the objectClass |
| * @throws NamingException if there are any problems |
| */ |
| public ServerEntry getAttributes( ObjectClass objectClass, Schema schema, Registries registries ) throws NamingException |
| { |
| ServerEntry entry = new DefaultServerEntry( registries ); |
| |
| entry.put( SchemaConstants.OBJECT_CLASS_AT, SchemaConstants.TOP_OC, MetaSchemaConstants.META_OBJECT_CLASS_OC ); |
| entry.put( MetaSchemaConstants.M_TYPE_OBJECT_CLASS_AT, objectClass.getType().toString() ); |
| entry.put( SchemaConstants.CREATORS_NAME_AT, schema.getOwner() ); |
| entry.put( SchemaConstants.CREATE_TIMESTAMP_AT, DateUtils.getGeneralizedTime() ); |
| |
| injectCommon( objectClass, entry, registries ); |
| |
| // handle the superior objectClasses |
| if ( objectClass.getSuperClasses() != null && objectClass.getSuperClasses().length != 0 ) |
| { |
| EntryAttribute attr = new DefaultServerAttribute( registries.getAttributeTypeRegistry().lookup( MetaSchemaConstants.M_SUP_OBJECT_CLASS_AT ) ); |
| ObjectClass[] superClasses = objectClass.getSuperClasses(); |
| |
| for ( ObjectClass superClass:superClasses ) |
| { |
| attr.add( getNameOrNumericoid( superClass ) ); |
| } |
| |
| entry.put( attr ); |
| } |
| |
| // add the must list |
| if ( objectClass.getMustList() != null && objectClass.getMustList().length != 0 ) |
| { |
| EntryAttribute attr = new DefaultServerAttribute( registries.getAttributeTypeRegistry().lookup( MetaSchemaConstants.M_MUST_AT ) ); |
| AttributeType[] mustList = objectClass.getMustList(); |
| |
| for ( AttributeType attributeType:mustList ) |
| { |
| attr.add( getNameOrNumericoid( attributeType ) ); |
| } |
| |
| entry.put( attr ); |
| } |
| |
| // add the may list |
| if ( objectClass.getMayList() != null && objectClass.getMayList().length != 0 ) |
| { |
| EntryAttribute attr = new DefaultServerAttribute( registries.getAttributeTypeRegistry().lookup( MetaSchemaConstants.M_MAY_AT ) ); |
| AttributeType[] mayList = objectClass.getMayList(); |
| |
| for ( AttributeType attributeType:mayList ) |
| { |
| attr.add( getNameOrNumericoid( attributeType ) ); |
| } |
| |
| entry.put( attr ); |
| } |
| |
| return entry; |
| } |
| |
| |
| private final String getNameOrNumericoid( SchemaObject object ) |
| { |
| // first try to use user friendly name if we can |
| if ( object.getName() != null ) |
| { |
| return object.getName(); |
| } |
| |
| return object.getOid(); |
| } |
| |
| |
| private final void injectCommon( SchemaObject object, ServerEntry entry, Registries registries ) throws NamingException |
| { |
| injectNames( object.getNamesRef(), entry, registries ); |
| entry.put( MetaSchemaConstants.M_OBSOLETE_AT, getBoolean( object.isObsolete() ) ); |
| entry.put( MetaSchemaConstants.M_OID_AT, object.getOid() ); |
| |
| if ( object.getDescription() != null ) |
| { |
| entry.put( MetaSchemaConstants.M_DESCRIPTION_AT, object.getDescription() ); |
| } |
| } |
| |
| |
| private final void injectNames( String[] names, ServerEntry entry, Registries registries ) throws NamingException |
| { |
| if ( names == null || names.length == 0 ) |
| { |
| return; |
| } |
| |
| EntryAttribute attr = new DefaultServerAttribute( registries.getAttributeTypeRegistry().lookup( MetaSchemaConstants.M_NAME_AT ) ); |
| |
| for ( String name:names ) |
| { |
| attr.add( name ); |
| } |
| |
| entry.put( attr ); |
| } |
| |
| |
| private final String getBoolean( boolean value ) |
| { |
| if ( value ) |
| { |
| return "TRUE"; |
| } |
| else |
| { |
| return "FALSE"; |
| } |
| } |
| } |
