org.apache.directory.server.schema.registries
Interface SyntaxCheckerRegistry

All Known Implementing Classes:

DefaultSyntaxCheckerRegistry

public interface SyntaxCheckerRegistry

SyntaxChecker registry component's service interface.

Version:

$Rev: 504773 $

Author:

Apache Directory Project

Method Summary

java.lang.String	getSchemaName(java.lang.String oid) Gets the name of the schema this schema object is associated with.
boolean	hasSyntaxChecker(java.lang.String oid) Checks to see if a SyntaxChecker exists.
java.util.Iterator<org.apache.directory.shared.ldap.schema.syntax.SyntaxChecker>	iterator() Get's an iterator over all the syntaxCheckers associated with this registry.
org.apache.directory.shared.ldap.schema.syntax.SyntaxChecker	lookup(java.lang.String oid) Looks up a SyntaxChecker by its unique Object Identifier.
void	register(org.apache.directory.shared.ldap.schema.syntax.SyntaxCheckerDescription description, org.apache.directory.shared.ldap.schema.syntax.SyntaxChecker syntaxChecker) Registers a SyntaxChecker with this registry.
void	renameSchema(java.lang.String originalSchemaName, java.lang.String newSchemaName) Renames the schemaName associated with entities within this registry to a new schema name.
java.util.Iterator<org.apache.directory.shared.ldap.schema.syntax.SyntaxCheckerDescription>	syntaxCheckerDescriptionIterator() Get's an iterator over all the syntaxCheckerDescriptions associated with this registry.
void	unregister(java.lang.String numericOid) Unregisters a registered syntaxChecker from this registry.
void	unregisterSchemaElements(java.lang.String schemaName) Unregisters all syntaxCheckers defined for a specific schema from this registry.

Method Detail

register

void register(org.apache.directory.shared.ldap.schema.syntax.SyntaxCheckerDescription description,
              org.apache.directory.shared.ldap.schema.syntax.SyntaxChecker syntaxChecker)
              throws javax.naming.NamingException

Registers a SyntaxChecker with this registry.

Parameters:

description - the syntaxCheckerDescription for this syntaxChecker

syntaxChecker - the SyntaxChecker to register

Throws:

javax.naming.NamingException - if the SyntaxChecker is already registered or the registration operation is not supported

lookup

org.apache.directory.shared.ldap.schema.syntax.SyntaxChecker lookup(java.lang.String oid)
                                                                    throws javax.naming.NamingException

Looks up a SyntaxChecker by its unique Object Identifier.

Parameters:

oid - the object identifier

Returns:

the SyntaxChecker for the oid

Throws:

javax.naming.NamingException - if there is a backing store failure or the SyntaxChecker does not exist.

getSchemaName

java.lang.String getSchemaName(java.lang.String oid)
                               throws javax.naming.NamingException

Gets the name of the schema this schema object is associated with.

Parameters:

oid - the object identifier

Returns:

the schema name

Throws:

javax.naming.NamingException - if the schema object does not exist

hasSyntaxChecker

boolean hasSyntaxChecker(java.lang.String oid)

Checks to see if a SyntaxChecker exists. Backing store failures simply return false.

Parameters:

oid - the object identifier

Returns:

true if a SyntaxChecker definition exists for the oid, false otherwise

iterator

java.util.Iterator<org.apache.directory.shared.ldap.schema.syntax.SyntaxChecker> iterator()

Get's an iterator over all the syntaxCheckers associated with this registry.

Returns:

an Iterator over all the syntaxCheckers

syntaxCheckerDescriptionIterator

java.util.Iterator<org.apache.directory.shared.ldap.schema.syntax.SyntaxCheckerDescription> syntaxCheckerDescriptionIterator()

Get's an iterator over all the syntaxCheckerDescriptions associated with this registry.

Returns:

an Iterator over all the syntaxCheckerDescriptions

unregister

void unregister(java.lang.String numericOid)
                throws javax.naming.NamingException

Unregisters a registered syntaxChecker from this registry.

Parameters:

numericOid - the numeric oid of the syntax this checker is associated with

Throws:

javax.naming.NamingException - if the numericOid is not valid

unregisterSchemaElements

void unregisterSchemaElements(java.lang.String schemaName)

Unregisters all syntaxCheckers defined for a specific schema from this registry.

Parameters:

schemaName - the name of the schema whose syntaxCheckers will be removed

renameSchema

void renameSchema(java.lang.String originalSchemaName,
                  java.lang.String newSchemaName)

Renames the schemaName associated with entities within this registry to a new schema name.

Parameters:

originalSchemaName - the original schema name

newSchemaName - the new name to give to the schema