org.apache.directory.api.ldap.model.schema

Class AttributesFactory

java.lang.Object

org.apache.directory.api.ldap.model.schema.AttributesFactory

public class AttributesFactory
extends Object

A factory that generates an entry using the meta schema for schema elements.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.util.TimeProvider	timeProvider

Constructor Summary

Constructors

Constructor and Description
AttributesFactory()

Method Summary

Modifier and Type	Method and Description
Entry	convert(AttributeType attributeType, Schema schema, SchemaManager schemaManager) 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 ) )
Entry	convert(DitContentRule dITContentRule, Schema schema, SchemaManager schemaManager) Converts a DitContentRule into an Entry
Entry	convert(DitStructureRule ditStructureRule, Schema schema, SchemaManager schemaManager) Converts a DitStructureRule into an Entry
Entry	convert(LdapSyntax syntax, Schema schema, SchemaManager schemaManager) Convert a Syntax instance into an Entry
Entry	convert(MatchingRule matchingRule, Schema schema, SchemaManager schemaManager) Converts a MatchingRule into an Entry
Entry	convert(MatchingRuleUse matchingRuleUse, Schema schema, SchemaManager schemaManager) Converts a MatchingRuleUse into an Entry
Entry	convert(NameForm nameForm, Schema schema, SchemaManager schemaManager) Converts a NameForm into an Entry
Entry	convert(ObjectClass objectClass, Schema schema, SchemaManager schemaManager) Creates the attributes of an entry representing an objectClass.
Entry	convert(Schema schema, SchemaManager schemaManager) Converts a Schema to an Entry
Entry	convert(String oid, LdapComparator<? super Object> comparator, Schema schema, SchemaManager schemaManager) Convert a LdapComparator instance into an Entry
Entry	convert(String oid, Normalizer normalizer, Schema schema, SchemaManager schemaManager) Convert a Normalizer instance into an Entry
Entry	convert(SyntaxChecker syntaxChecker, Schema schema, SchemaManager schemaManager) Convert a SyntaxChecker instance into an Entry
Entry	getAttributes(SchemaObject obj, Schema schema, SchemaManager schemaManager) Get a SchemaObject as an Entry
private String	getBoolean(boolean value)
private void	injectCommon(SchemaObject object, Entry entry, SchemaManager schemaManager)
private void	injectNames(List<String> names, Entry entry, SchemaManager schemaManager)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

timeProvider

private org.apache.directory.api.util.TimeProvider timeProvider

Constructor Detail

AttributesFactory

public AttributesFactory()

Method Detail

getAttributes

public Entry getAttributes(SchemaObject obj,
                           Schema schema,
                           SchemaManager schemaManager)
                    throws LdapException

Get a SchemaObject as an Entry

Parameters:

obj - The schema oobject to convert

schema - The schema which this object belongs to

schemaManager - The SchemaManager

Returns:

The converted schema object as an Entry

Throws:

LdapException - If we can't convert teh schema object

convert

public Entry convert(Schema schema,
                     SchemaManager schemaManager)
              throws LdapException

Converts a Schema to an Entry

Parameters:

schema - The Schema to convert

schemaManager - The SchemaManager

Returns:

An Entry containing the converted Schema

Throws:

LdapException - If the conversion failed

convert

public Entry convert(SyntaxChecker syntaxChecker,
                     Schema schema,
                     SchemaManager schemaManager)

Convert a SyntaxChecker instance into an Entry

Parameters:

syntaxChecker - The SyntaxChecker to convert

schema - The schema containing this SyntaxChecker

schemaManager - The SchemaManager

Returns:

An Entry containing the converted SyntaxChecker

convert

public Entry convert(LdapSyntax syntax,
                     Schema schema,
                     SchemaManager schemaManager)
              throws LdapException

Convert a Syntax instance into an Entry

Parameters:

syntax - The LdapSytax to convert

schema - The schema containing this Syntax

schemaManager - The SchemaManager

Returns:

And entry defining a LdapSyntax

Throws:

LdapException - If the conversion failed

convert

public Entry convert(String oid,
                     Normalizer normalizer,
                     Schema schema,
                     SchemaManager schemaManager)

Convert a Normalizer instance into an Entry

Parameters:

oid - The Normalizer's OID

normalizer - The Normalizer to convert

schema - The schema containing this Normalizer

schemaManager - The SchemaManager

Returns:

An Entry defining a Normalizer

convert

public Entry convert(String oid,
                     LdapComparator<? super Object> comparator,
                     Schema schema,
                     SchemaManager schemaManager)

Convert a LdapComparator instance into an Entry

Parameters:

oid - The LdapComparator's OID

comparator - The LdapComparator to convert

schema - The schema containing this Comparator

schemaManager - The SchemaManager

Returns:

An Entry defining a LdapComparator

convert

public Entry convert(MatchingRule matchingRule,
                     Schema schema,
                     SchemaManager schemaManager)
              throws LdapException

Converts a MatchingRule into an Entry

Parameters:

matchingRule - The MatchingRule to convert

schema - The schema containing this ObjectClass

schemaManager - The SchemaManager

Returns:

The converted MatchingRule

Throws:

LdapException - If the conversion failed

convert

public Entry convert(MatchingRuleUse matchingRuleUse,
                     Schema schema,
                     SchemaManager schemaManager)

Converts a MatchingRuleUse into an Entry

Parameters:

matchingRuleUse - The MatchingRuleUse to convert

schema - The schema containing this MatchingRuleUse

schemaManager - The SchemaManager

Returns:

The converted MatchingRuleUse

convert

public Entry convert(DitStructureRule ditStructureRule,
                     Schema schema,
                     SchemaManager schemaManager)

Converts a DitStructureRule into an Entry

Parameters:

ditStructureRule - The DitStructureRule to convert

schema - The schema containing this DitStructureRule

schemaManager - The SchemaManager

Returns:

The converted DitStructureRule

convert

public Entry convert(DitContentRule dITContentRule,
                     Schema schema,
                     SchemaManager schemaManager)

Converts a DitContentRule into an Entry

Parameters:

dITContentRule - The DitContentRule to convert

schema - The schema containing this DitContentRule

schemaManager - The SchemaManager

Returns:

The converted DitContentRule

convert

public Entry convert(NameForm nameForm,
                     Schema schema,
                     SchemaManager schemaManager)

Converts a NameForm into an Entry

Parameters:

nameForm - The NameForm to convert

schema - The schema containing this NameForm

schemaManager - The SchemaManager

Returns:

The converted NameForm

convert

public Entry convert(AttributeType attributeType,
                     Schema schema,
                     SchemaManager schemaManager)
              throws LdapException

    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 )
    )
 

Parameters:

attributeType - The AttributeType to convert

schema - The schema containing this AttributeType

schemaManager - The SchemaManager

Returns:

The converted AttributeType

Throws:

LdapException - If the conversion failed

convert

public Entry convert(ObjectClass objectClass,
                     Schema schema,
                     SchemaManager schemaManager)
              throws LdapException

Creates the attributes of an entry representing an objectClass.

  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 )
  )
 

Parameters:

objectClass - the objectClass to produce a meta schema entry for

schema - The schema containing this ObjectClass

schemaManager - The SchemaManager

Returns:

the attributes of the metaSchema entry representing the objectClass

Throws:

LdapException - If the conversion failed

injectCommon

private void injectCommon(SchemaObject object,
                          Entry entry,
                          SchemaManager schemaManager)
                   throws LdapException

Throws:

LdapException

injectNames

private void injectNames(List<String> names,
                         Entry entry,
                         SchemaManager schemaManager)
                  throws LdapException

Throws:

LdapException

getBoolean

private String getBoolean(boolean value)