| /* |
| * 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.schema; |
| |
| |
| import static org.apache.directory.server.core.integ.IntegrationUtils.getRootContext; |
| import static org.apache.directory.server.core.integ.IntegrationUtils.getSchemaContext; |
| import static org.junit.Assert.assertEquals; |
| import static org.junit.Assert.assertFalse; |
| import static org.junit.Assert.assertNotNull; |
| import static org.junit.Assert.assertNull; |
| import static org.junit.Assert.assertTrue; |
| import static org.junit.Assert.fail; |
| |
| import java.util.ArrayList; |
| import java.util.List; |
| |
| import javax.naming.NamingEnumeration; |
| import javax.naming.NamingException; |
| import javax.naming.directory.Attribute; |
| import javax.naming.directory.Attributes; |
| import javax.naming.directory.BasicAttribute; |
| import javax.naming.directory.BasicAttributes; |
| import javax.naming.directory.DirContext; |
| import javax.naming.directory.ModificationItem; |
| import javax.naming.directory.SearchControls; |
| import javax.naming.directory.SearchResult; |
| |
| import org.apache.directory.api.ldap.model.entry.DefaultEntry; |
| import org.apache.directory.api.ldap.model.entry.Entry; |
| import org.apache.directory.api.ldap.model.name.Dn; |
| import org.apache.directory.api.ldap.model.schema.AttributeType; |
| import org.apache.directory.api.ldap.model.schema.SchemaManager; |
| import org.apache.directory.api.ldap.model.schema.parsers.AttributeTypeDescriptionSchemaParser; |
| import org.apache.directory.api.ldap.util.JndiUtils; |
| import org.apache.directory.ldap.client.api.LdapConnection; |
| import org.apache.directory.server.core.annotations.CreateDS; |
| import org.apache.directory.server.core.integ.AbstractLdapTestUnit; |
| import org.apache.directory.server.core.integ.FrameworkRunner; |
| import org.apache.directory.server.core.integ.IntegrationUtils; |
| import org.junit.Before; |
| import org.junit.Test; |
| import org.junit.runner.RunWith; |
| |
| |
| /** |
| * An integration test class for testing persistence for various operations |
| * on the subschemaSubentry with server restarts. |
| * |
| * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> |
| */ |
| @RunWith(FrameworkRunner.class) |
| @CreateDS(name = "SchemaPersistenceIT-class") |
| public class SchemaPersistenceIT extends AbstractLdapTestUnit |
| { |
| private static final String SUBSCHEMA_SUBENTRY = "subschemaSubentry"; |
| private static final AttributeTypeDescriptionSchemaParser ATTRIBUTE_TYPE_DESCRIPTION_SCHEMA_PARSER = new AttributeTypeDescriptionSchemaParser(); |
| public static SchemaManager schemaManager; |
| private static LdapConnection connection; |
| |
| |
| @Before |
| public void setup() throws Exception |
| { |
| connection = IntegrationUtils.getAdminConnection( getService() ); |
| schemaManager = getService().getSchemaManager(); |
| } |
| |
| |
| /** |
| * Tests to see if an attributeType is persisted when added, then server |
| * is shutdown, then restarted again. |
| * |
| * @throws Exception on error |
| */ |
| @Test |
| public void testAddAttributeTypePersistence() throws Exception |
| { |
| try |
| { |
| enableSchema( "nis" ); |
| List<String> descriptions = new ArrayList<String>(); |
| |
| // ------------------------------------------------------------------- |
| // test successful add with everything |
| // ------------------------------------------------------------------- |
| |
| descriptions.add( |
| "( 1.3.6.1.4.1.18060.0.4.1.2.10000 " + |
| " NAME 'type0' " + |
| " OBSOLETE SUP 2.5.4.41 " + |
| " EQUALITY caseExactIA5Match " + |
| " ORDERING octetStringOrderingMatch " + |
| " SUBSTR caseExactIA5SubstringsMatch " + |
| " COLLECTIVE " + |
| " SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 " + |
| " USAGE userApplications " + |
| " X-SCHEMA 'nis' )" ); |
| |
| descriptions.add( |
| "( 1.3.6.1.4.1.18060.0.4.1.2.10001 " + |
| " NAME ( 'type1' 'altName' ) " + |
| " SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 " + |
| " SUP 2.5.4.41 " + |
| " USAGE userApplications " + |
| " X-SCHEMA 'nis' )" ); |
| |
| modify( DirContext.ADD_ATTRIBUTE, descriptions, "attributeTypes" ); |
| |
| checkAttributeTypePresent( "1.3.6.1.4.1.18060.0.4.1.2.10000", "nis", true ); |
| checkAttributeTypePresent( "1.3.6.1.4.1.18060.0.4.1.2.10001", "nis", true ); |
| |
| // sync operation happens anyway on shutdowns but just to make sure we can do it again |
| getService().sync(); |
| |
| getService().shutdown(); |
| getService().startup(); |
| |
| Attributes attrs = new BasicAttributes( "objectClass", "metaSchema", true ); |
| attrs.put( "cn", "blah" ); |
| getSchemaContext( getService() ).createSubcontext( "cn=blah", attrs ); |
| |
| checkAttributeTypePresent( "1.3.6.1.4.1.18060.0.4.1.2.10000", "nis", true ); |
| checkAttributeTypePresent( "1.3.6.1.4.1.18060.0.4.1.2.10001", "nis", true ); |
| } |
| catch ( Exception e ) |
| { |
| throw e; |
| } |
| } |
| |
| |
| /** |
| * Tests to see if we can create a schema with a mixed case name (see DIRSERVER-1718) |
| * |
| * @throws Exception on error |
| */ |
| @Test |
| public void testAddSchemaMixedCase() throws Exception |
| { |
| try |
| { |
| Dn dn = new Dn( "cn=DuMMy,ou=schema" ); |
| |
| Entry dummySchema = new DefaultEntry( |
| dn, |
| "objectClass: top", |
| "objectClass: metaSchema", |
| "cn: DuMMy" ); |
| |
| connection.add( dummySchema ); |
| |
| assertNotNull( connection.lookup( "cn=dummy,ou=schema" ) ); |
| |
| // sync operation happens anyway on shutdowns but just to make sure we can do it again |
| getService().sync(); |
| |
| getService().shutdown(); |
| getService().startup(); |
| |
| // Check that the schema still exists |
| assertNotNull( connection.lookup( "cn=dummy,ou=schema" ) ); |
| |
| // Now, delete the schema |
| connection.delete( "cn=dummy,ou=schema" ); |
| |
| assertNull( connection.lookup( "cn=dummy,ou=schema" ) ); |
| |
| // sync operation happens anyway on shutdowns but just to make sure we can do it again |
| getService().sync(); |
| |
| getService().shutdown(); |
| getService().startup(); |
| |
| // Check that the schema does not exists |
| assertNull( connection.lookup( "cn=dummy,ou=schema" ) ); |
| } |
| catch ( Exception e ) |
| { |
| throw e; |
| } |
| } |
| |
| |
| // ----------------------------------------------------------------------- |
| // Private Utility Methods |
| // ----------------------------------------------------------------------- |
| |
| private void modify( int op, List<String> descriptions, String opAttr ) throws Exception |
| { |
| Dn dn = new Dn( getSubschemaSubentryDN() ); |
| Attribute attr = new BasicAttribute( opAttr ); |
| |
| for ( String description : descriptions ) |
| { |
| attr.add( description ); |
| } |
| |
| Attributes mods = new BasicAttributes( true ); |
| mods.put( attr ); |
| |
| getRootContext( getService() ).modifyAttributes( JndiUtils.toName( dn ), op, mods ); |
| } |
| |
| |
| private void enableSchema( String schemaName ) throws Exception |
| { |
| // now enable the test schema |
| ModificationItem[] mods = new ModificationItem[1]; |
| Attribute attr = new BasicAttribute( "m-disabled", "FALSE" ); |
| mods[0] = new ModificationItem( DirContext.REPLACE_ATTRIBUTE, attr ); |
| getSchemaContext( getService() ).modifyAttributes( "cn=" + schemaName, mods ); |
| } |
| |
| |
| /** |
| * Get's the subschemaSubentry attribute value from the rootDSE. |
| * |
| * @return the subschemaSubentry distinguished name |
| * @throws NamingException if there are problems accessing the RootDSE |
| */ |
| private String getSubschemaSubentryDN() throws Exception |
| { |
| SearchControls controls = new SearchControls(); |
| controls.setSearchScope( SearchControls.OBJECT_SCOPE ); |
| controls.setReturningAttributes( new String[] |
| { SUBSCHEMA_SUBENTRY } ); |
| |
| NamingEnumeration<SearchResult> results = getRootContext( getService() ).search( "", "(objectClass=*)", |
| controls ); |
| SearchResult result = results.next(); |
| results.close(); |
| Attribute subschemaSubentry = result.getAttributes().get( SUBSCHEMA_SUBENTRY ); |
| return ( String ) subschemaSubentry.get(); |
| } |
| |
| |
| /** |
| * Gets the subschemaSubentry attributes for the global schema. |
| * |
| * @return all operational attributes of the subschemaSubentry |
| * @throws NamingException if there are problems accessing this entry |
| */ |
| private Attributes getSubschemaSubentryAttributes() throws Exception |
| { |
| SearchControls controls = new SearchControls(); |
| controls.setSearchScope( SearchControls.OBJECT_SCOPE ); |
| controls.setReturningAttributes( new String[] |
| { "+", "*" } ); |
| |
| NamingEnumeration<SearchResult> results = getRootContext( getService() ).search( getSubschemaSubentryDN(), |
| "(objectClass=*)", controls ); |
| SearchResult result = results.next(); |
| results.close(); |
| return result.getAttributes(); |
| } |
| |
| |
| private void checkAttributeTypePresent( String oid, String schemaName, boolean isPresent ) throws Exception |
| { |
| // ------------------------------------------------------------------- |
| // check first to see if it is present in the subschemaSubentry |
| // ------------------------------------------------------------------- |
| |
| Attributes attrs = getSubschemaSubentryAttributes(); |
| Attribute attrTypes = attrs.get( "attributeTypes" ); |
| AttributeType attributeType = null; |
| |
| for ( int ii = 0; ii < attrTypes.size(); ii++ ) |
| { |
| String desc = ( String ) attrTypes.get( ii ); |
| |
| if ( desc.indexOf( oid ) != -1 ) |
| { |
| attributeType = ATTRIBUTE_TYPE_DESCRIPTION_SCHEMA_PARSER |
| .parseAttributeTypeDescription( desc ); |
| break; |
| } |
| } |
| |
| if ( isPresent ) |
| { |
| assertNotNull( attributeType ); |
| assertEquals( oid, attributeType.getOid() ); |
| } |
| else |
| { |
| assertNull( attributeType ); |
| } |
| |
| // ------------------------------------------------------------------- |
| // check next to see if it is present in the schema partition |
| // ------------------------------------------------------------------- |
| |
| attrs = null; |
| |
| if ( isPresent ) |
| { |
| attrs = getSchemaContext( getService() ).getAttributes( |
| "m-oid=" + oid + ",ou=attributeTypes,cn=" + schemaName ); |
| assertNotNull( attrs ); |
| } |
| else |
| { |
| //noinspection EmptyCatchBlock |
| try |
| { |
| attrs = getSchemaContext( getService() ).getAttributes( |
| "m-oid=" + oid + ",ou=attributeTypes,cn=" + schemaName ); |
| fail( "should never get here" ); |
| } |
| catch ( NamingException e ) |
| { |
| } |
| assertNull( attrs ); |
| } |
| |
| // ------------------------------------------------------------------- |
| // check to see if it is present in the attributeTypeRegistry |
| // ------------------------------------------------------------------- |
| |
| if ( isPresent ) |
| { |
| assertTrue( getService().getSchemaManager().getAttributeTypeRegistry().contains( oid ) ); |
| } |
| else |
| { |
| assertFalse( getService().getSchemaManager().getAttributeTypeRegistry().contains( oid ) ); |
| } |
| } |
| } |
