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

Class ImmutableLdapSyntaxRegistry

java.lang.Object

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

All Implemented Interfaces:

Iterable<LdapSyntax>, LdapSyntaxRegistry, SchemaObjectRegistry<LdapSyntax>

public class ImmutableLdapSyntaxRegistry
extends Object
implements LdapSyntaxRegistry

An immutable wrapper of the Syntax registry.

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
ImmutableLdapSyntaxRegistry(LdapSyntaxRegistry ldapSyntaxRegistry) Creates a new instance of ImmutableLdapSyntaxRegistry.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the registry from all its content
boolean	contains(String oid) Checks to see if an SchemaObject exists in the registry, by its OID or name.
ImmutableLdapSyntaxRegistry	copy() Copy the LdapSyntaxRegistry
LdapSyntax	get(String oid) Gets the SchemaObject associated with a given OID.
String	getOidByName(String name) Gets the numericOid for a name/alias if one is associated.
String	getSchemaName(String oid) Gets the name of the schema this schema object is associated with.
SchemaObjectType	getType()
Iterator<LdapSyntax>	iterator() Gets an iterator over the registered schema objects in the registry.
LdapSyntax	lookup(String oid) Looks up a SchemaObject by its unique Object Identifier or by name.
Iterator<String>	oidsIterator() Gets an iterator over the registered schema objects'OID in the registry.
void	register(LdapSyntax schemaObject) Registers a new SchemaObject with this registry.
void	renameSchema(String originalSchemaName, String newSchemaName) Modify all the SchemaObject using a schemaName when this name changes.
int	size()
LdapSyntax	unregister(LdapSyntax schemaObject) Removes the SchemaObject registered with this registry.
LdapSyntax	unregister(String numericOid) Removes the SchemaObject registered with this registry, using its numeric OID.
void	unregisterSchemaElements(String schemaName) Unregisters all SchemaObjects defined for a specific schema from this registry.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ImmutableLdapSyntaxRegistry

public ImmutableLdapSyntaxRegistry(LdapSyntaxRegistry ldapSyntaxRegistry)

Creates a new instance of ImmutableLdapSyntaxRegistry.

Parameters:

ldapSyntaxRegistry - The wrapped LdapSyntax registry

Method Detail

copy

public ImmutableLdapSyntaxRegistry copy()

Copy the LdapSyntaxRegistry

Specified by:

copy in interface LdapSyntaxRegistry

Specified by:

copy in interface SchemaObjectRegistry<LdapSyntax>

Returns:

SchemaObjectRegistry The copied registry

size

public int size()

Specified by:

size in interface SchemaObjectRegistry<LdapSyntax>

Returns:

The number of AttributeType stored

contains

public boolean contains(String oid)

Checks to see if an SchemaObject exists in the registry, by its OID or name.

Specified by:

contains in interface SchemaObjectRegistry<LdapSyntax>

Parameters:

oid - the object identifier or name of the SchemaObject

Returns:

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

getOidByName

public String getOidByName(String name)
                    throws LdapException

Gets the numericOid for a name/alias if one is associated. To prevent lookup failures due to case variance in the name, a failure to lookup the OID, will trigger a lookup using a lower cased version of the name and the name that failed to match will automatically be associated with the OID.

Specified by:

getOidByName in interface SchemaObjectRegistry<LdapSyntax>

Parameters:

name - The name we are looking the oid for

Returns:

The numericOID associated with this name

Throws:

LdapException - If the OID can't be found

getSchemaName

public String getSchemaName(String oid)
                     throws LdapException

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

Specified by:

getSchemaName in interface SchemaObjectRegistry<LdapSyntax>

Parameters:

oid - the object identifier or the name

Returns:

the schema name

Throws:

LdapException - if the schema object does not exist

getType

public SchemaObjectType getType()

Specified by:

getType in interface SchemaObjectRegistry<LdapSyntax>

Returns:

the type

iterator

public Iterator<LdapSyntax> iterator()

Gets an iterator over the registered schema objects in the registry.

Specified by:

iterator in interface Iterable<LdapSyntax>

Specified by:

iterator in interface SchemaObjectRegistry<LdapSyntax>

Returns:

an Iterator of homogeneous schema objects

lookup

public LdapSyntax lookup(String oid)
                  throws LdapException

Looks up a SchemaObject by its unique Object Identifier or by name.

Specified by:

lookup in interface SchemaObjectRegistry<LdapSyntax>

Parameters:

oid - the object identifier or name

Returns:

the SchemaObject instance for the id

Throws:

LdapException - if the SchemaObject does not exist

oidsIterator

public Iterator<String> oidsIterator()

Gets an iterator over the registered schema objects'OID in the registry.

Specified by:

oidsIterator in interface SchemaObjectRegistry<LdapSyntax>

Returns:

an Iterator of OIDs

register

public void register(LdapSyntax schemaObject)
              throws LdapException

Registers a new SchemaObject with this registry.

Specified by:

register in interface SchemaObjectRegistry<LdapSyntax>

Parameters:

schemaObject - the SchemaObject to register

Throws:

LdapException - if the SchemaObject is already registered or the registration operation is not supported

renameSchema

public void renameSchema(String originalSchemaName,
                         String newSchemaName)
                  throws LdapException

Modify all the SchemaObject using a schemaName when this name changes.

Specified by:

renameSchema in interface SchemaObjectRegistry<LdapSyntax>

Parameters:

originalSchemaName - The original Schema name

newSchemaName - The new Schema name

Throws:

LdapException - if the schema object does not exist

unregister

public LdapSyntax unregister(String numericOid)
                      throws LdapException

Removes the SchemaObject registered with this registry, using its numeric OID.

Specified by:

unregister in interface SchemaObjectRegistry<LdapSyntax>

Parameters:

numericOid - the numeric identifier

Throws:

LdapException - if the numeric identifier is invalid

unregisterSchemaElements

public void unregisterSchemaElements(String schemaName)
                              throws LdapException

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

Specified by:

unregisterSchemaElements in interface SchemaObjectRegistry<LdapSyntax>

Parameters:

schemaName - the name of the schema whose SchemaObjects will be removed from

Throws:

LdapException

get

public LdapSyntax get(String oid)

Gets the SchemaObject associated with a given OID.

Specified by:

get in interface SchemaObjectRegistry<LdapSyntax>

Parameters:

oid - The SchemaObject's OID we are looking for

Returns:

The SchemaObject, if any. Null otherwise

clear

public void clear()
           throws LdapException

Clear the registry from all its content

Specified by:

clear in interface SchemaObjectRegistry<LdapSyntax>

Throws:

LdapException

unregister

public LdapSyntax unregister(LdapSyntax schemaObject)
                      throws LdapException

Removes the SchemaObject registered with this registry.

Specified by:

unregister in interface SchemaObjectRegistry<LdapSyntax>

Parameters:

schemaObject - the schemaObject to unregister

Throws:

LdapException - if the schemaObject can't be unregistered is invalid