org.apache.directory.server.core.schema.bootstrap
Interface BootstrapSchema

All Known Implementing Classes:
AbstractBootstrapSchema

public interface BootstrapSchema

A configuration of related Schema objects bundled together and identified as a group.

Version:
$Rev: 434573 $
Author:
Apache Directory Project

Method Summary
 java.lang.String getBaseClassName()
          Gets the base class name for bootstrap Schema class files.
 java.lang.String getDefaultBaseClassName()
          Gets the default base class name for bootstrap Schema class files.
 java.lang.String[] getDependencies()
          Gets the names of other schemas that this objects within this BootstrapSchema depends upon.
 java.lang.String getFullClassName(ProducerTypeEnum type)
          Gets the class name for bootstrap Schema class producer type.
 java.lang.String getFullDefaultBaseClassName(ProducerTypeEnum type)
          If the base class name for the target class does not resolve, we attempt to load another backup class using this default base class name which tries another package for the target class factory to load.
 java.lang.String getOwner()
          Gets the name of the owner of the schema objects within this BootstrapSchema.
 java.lang.String getPackageName()
          Gets the package name of the schema's object factories.
 java.lang.String getSchemaName()
          Gets the name of the logical schema the objects of this BootstrapSchema belong to: e.g.
 java.lang.String getUnqualifiedClassName()
          Gets the unqualified class name for Schema class.
 java.lang.String getUnqualifiedClassName(ProducerTypeEnum type)
          Gets the unqualified class name for bootstrap Schema class producer type.
 

Method Detail

getOwner

java.lang.String getOwner()
Gets the name of the owner of the schema objects within this BootstrapSchema.

Returns:
the identifier for the owner of this set's objects

getSchemaName

java.lang.String getSchemaName()
Gets the name of the logical schema the objects of this BootstrapSchema belong to: e.g. krb5-kdc may be the logical LDAP schema name.

Returns:
the name of the logical schema

getPackageName

java.lang.String getPackageName()
Gets the package name of the schema's object factories.

Returns:
the name of the schema's package name

getDependencies

java.lang.String[] getDependencies()
Gets the names of other schemas that this objects within this BootstrapSchema depends upon. These dependent schemas are those whose ConfigurationSets will be processed first.

Returns:
the String names of schema dependencies

getBaseClassName

java.lang.String getBaseClassName()
Gets the base class name for bootstrap Schema class files. This name is the schema name with the first character capitalized and qualified by the package name. So for a bootstrap schema name of 'bar' within the 'foo' package would return foo.Bar as the base class name.

Returns:
the base of all bootstrap schema class names for this schema

getDefaultBaseClassName

java.lang.String getDefaultBaseClassName()
Gets the default base class name for bootstrap Schema class files. This name is the schema name with the first character capitalized and qualified by the default package name. So for a bootstrap schema name of 'bar' within the 'foo' package would return foo.Bar as the base class name.

Returns:
the default base of all bootstrap schema class names for this schema

getFullClassName

java.lang.String getFullClassName(ProducerTypeEnum type)
Gets the class name for bootstrap Schema class producer type.

Returns:
the bootstrap schema class name for a producer type in this schema

getFullDefaultBaseClassName

java.lang.String getFullDefaultBaseClassName(ProducerTypeEnum type)
If the base class name for the target class does not resolve, we attempt to load another backup class using this default base class name which tries another package for the target class factory to load.

Returns:
the default base class name

getUnqualifiedClassName

java.lang.String getUnqualifiedClassName(ProducerTypeEnum type)
Gets the unqualified class name for bootstrap Schema class producer type.

Returns:
the bootstrap schema class name for a producer type in this schema

getUnqualifiedClassName

java.lang.String getUnqualifiedClassName()
Gets the unqualified class name for Schema class.

Returns:
the bootstrap schema class name


Copyright © 2003-2010 Apache Software Foundation. All Rights Reserved.