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

Class OidRegistry<T extends SchemaObject>

java.lang.Object

org.apache.directory.api.ldap.model.schema.registries.OidRegistry<T>

All Implemented Interfaces:

java.lang.Iterable<T>

public class OidRegistry<T extends SchemaObject>
extends java.lang.Object
implements java.lang.Iterable<T>

Object identifier registry. It stores the OIDs for AT, OC, MR, LS, MRU, DSR, DCR and NF. An OID is unique, and associated with a SO.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,T>	byOid Maps OID to a type of SchemaObject
private static boolean	IS_DEBUG Speedup for DEBUG mode
private boolean	isRelaxed A flag indicating that the Registry is relaxed or not
private static org.slf4j.Logger	LOG static class logger

Constructor Summary

Constructors

Constructor and Description
OidRegistry()

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	contains(java.lang.String oid) Tells if the given OID is present on this registry
OidRegistry<T>	copy() Copy the OidRegistry, without the contained values
java.util.List<java.lang.String>	getNameSet(java.lang.String oid) Gets the names associated with an OID.
java.lang.String	getPrimaryName(java.lang.String oid) Gets the primary name associated with an OID.
T	getSchemaObject(java.lang.String oid) Gets the SchemaObject associated with an OID.
boolean	isRelaxed() Tells if the Registry is permissive or if it must be checked against inconsistencies.
boolean	isStrict() Tells if the Registry is strict.
java.util.Iterator<T>	iterator() Lists all the SchemaObjects within the registry.
java.util.Iterator<java.lang.String>	iteratorOids() Lists all the OIDs within the registry.
(package private) void	put(T schemaObject) Store the given SchemaObject into the OidRegistry.
void	register(T schemaObject) Adds an OID name pair to the registry.
void	setRelaxed() Change the Registry to a relaxed mode, where invalid SchemaObjects can be registered.
void	setStrict() Change the Registry to a strict mode, where invalid SchemaObjects cannot be registered.
int	size()
java.lang.String	toString()
void	unregister(java.lang.String oid) Removes an oid from this registry.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

LOG

private static final org.slf4j.Logger LOG

static class logger

IS_DEBUG

private static final boolean IS_DEBUG

Speedup for DEBUG mode

byOid

private java.util.Map<java.lang.String,T extends SchemaObject> byOid

Maps OID to a type of SchemaObject

isRelaxed

private boolean isRelaxed

A flag indicating that the Registry is relaxed or not

Constructor Detail

OidRegistry

public OidRegistry()

Method Detail

contains

public boolean contains(java.lang.String oid)

Tells if the given OID is present on this registry

Parameters:

oid - The OID to lookup

Returns:

true if the OID already exists

getPrimaryName

public java.lang.String getPrimaryName(java.lang.String oid)
                                throws LdapException

Gets the primary name associated with an OID. The primary name is the first name specified for the OID.

Parameters:

oid - the object identifier

Returns:

the primary name

Throws:

LdapException - if oid does not exist

getSchemaObject

public T getSchemaObject(java.lang.String oid)
                  throws LdapException

Gets the SchemaObject associated with an OID.

Parameters:

oid - the object identifier

Returns:

the associated SchemaObject

Throws:

LdapException - if oid does not exist

getNameSet

public java.util.List<java.lang.String> getNameSet(java.lang.String oid)
                                            throws LdapException

Gets the names associated with an OID. An OID is unique however it may have many names used to refer to it. A good example is the cn and commonName attribute names for OID 2.5.4.3. Within a server one name within the set must be chosen as the primary name. This is used to name certain things within the server internally. If there is more than one name then the first name is taken to be the primary.

Parameters:

oid - the OID for which we return the set of common names

Returns:

a sorted set of names

Throws:

LdapException - if oid does not exist

iteratorOids

public java.util.Iterator<java.lang.String> iteratorOids()

Lists all the OIDs within the registry. This may be a really big list.

Returns:

all the OIDs registered

iterator

public java.util.Iterator<T> iterator()

Lists all the SchemaObjects within the registry. This may be a really big list.

Specified by:

iterator in interface java.lang.Iterable<T extends SchemaObject>

Returns:

all the SchemaObject registered

isRelaxed

public boolean isRelaxed()

Tells if the Registry is permissive or if it must be checked against inconsistencies.

Returns:

True if SchemaObjects can be added even if they break the consistency

isStrict

public boolean isStrict()

Tells if the Registry is strict.

Returns:

True if SchemaObjects cannot be added if they break the consistency

setRelaxed

public void setRelaxed()

Change the Registry to a relaxed mode, where invalid SchemaObjects can be registered.

setStrict

public void setStrict()

Change the Registry to a strict mode, where invalid SchemaObjects cannot be registered.

register

public void register(T schemaObject)
              throws LdapException

Adds an OID name pair to the registry.

Parameters:

schemaObject - The SchemaObject the oid belongs to

Throws:

LdapException

put

void put(T schemaObject)

Store the given SchemaObject into the OidRegistry. Available only to the current package. A weak form (no check is done) of the register method, define for clone methods.

Parameters:

schemaObject - The SchemaObject to inject into the OidRegistry

unregister

public void unregister(java.lang.String oid)
                throws LdapException

Removes an oid from this registry.

Parameters:

oid - the numeric identifier for the object

Throws:

LdapException - if the identifier is not numeric

copy

public OidRegistry<T> copy()

Copy the OidRegistry, without the contained values

Returns:

A new OidRegistry instance

size

public int size()

Returns:

The number of stored OIDs

clear

public void clear()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()