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

java.lang.Object
  org.apache.directory.api.ldap.model.schema.AbstractSchemaObject
      org.apache.directory.api.ldap.model.schema.LoadableSchemaObject
          org.apache.directory.api.ldap.model.schema.SyntaxChecker

All Implemented Interfaces:

Serializable, SchemaObject

Direct Known Subclasses:

AccessPointSyntaxChecker, AttributeTypeDescriptionSyntaxChecker, AttributeTypeUsageSyntaxChecker, BinarySyntaxChecker, BitStringSyntaxChecker, BooleanSyntaxChecker, CountrySyntaxChecker, CsnSidSyntaxChecker, CsnSyntaxChecker, DataQualitySyntaxSyntaxChecker, DeliveryMethodSyntaxChecker, DerefAliasSyntaxChecker, DirectoryStringSyntaxChecker, DitContentRuleDescriptionSyntaxChecker, DitStructureRuleDescriptionSyntaxChecker, DlSubmitPermissionSyntaxChecker, DnSyntaxChecker, DsaQualitySyntaxSyntaxChecker, DseTypeSyntaxChecker, GeneralizedTimeSyntaxChecker, Ia5StringSyntaxChecker, IntegerSyntaxChecker, JavaByteSyntaxChecker, JavaIntegerSyntaxChecker, JavaLongSyntaxChecker, JavaShortSyntaxChecker, JpegSyntaxChecker, LdapSyntaxDescriptionSyntaxChecker, MailPreferenceSyntaxChecker, MasterAndShadowAccessPointSyntaxChecker, MatchingRuleDescriptionSyntaxChecker, MatchingRuleUseDescriptionSyntaxChecker, MhsOrAddressSyntaxChecker, NameAndOptionalUIDSyntaxChecker, NameFormDescriptionSyntaxChecker, NumberSyntaxChecker, NumericOidSyntaxChecker, NumericStringSyntaxChecker, ObjectClassDescriptionSyntaxChecker, ObjectClassTypeSyntaxChecker, ObjectNameSyntaxChecker, OctetStringSyntaxChecker, OidLenSyntaxChecker, OidSyntaxChecker, OtherMailboxSyntaxChecker, PostalAddressSyntaxChecker, PrintableStringSyntaxChecker, ProtocolInformationSyntaxChecker, RegexSyntaxChecker, SearchScopeSyntaxChecker, SubtreeSpecificationSyntaxChecker, SupplierAndConsumerSyntaxChecker, SupplierInformationSyntaxChecker, SupplierOrConsumerSyntaxChecker, TelephoneNumberSyntaxChecker, TeletexTerminalIdentifierSyntaxChecker, TelexNumberSyntaxChecker, UtcTimeSyntaxChecker, UuidSyntaxChecker

public abstract class SyntaxChecker
extends LoadableSchemaObject

Used to validate values of a particular syntax. This interface does not correlate to any LDAP or X.500 construct. It has been created as a means to enforce a syntax within the Eve server.

Author:

Apache Directory Project

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.directory.api.ldap.model.schema.AbstractSchemaObject

description, extensions, isEnabled, isObsolete, isReadOnly, locked, names, objectType, oid, schemaName, specification

Constructor Summary

protected	SyntaxChecker() The SyntaxChecker default constructor where the oid is set after instantiation.
protected	SyntaxChecker(String oid) The SyntaxChecker base constructor

Method Summary

void	assertSyntax(Object value) Asserts whether or not the attribute's value conforms to the attribute syntax.
boolean	equals(Object o)
abstract boolean	isValidSyntax(Object value) Determines if the attribute's value conforms to the attribute syntax.
void	setSchemaManager(SchemaManager schemaManager) Store the SchemaManager in this instance.
String	toString()

Methods inherited from class org.apache.directory.api.ldap.model.schema.LoadableSchemaObject

copy, getBytecode, getFqcn, isValid, setBytecode, setFqcn

Methods inherited from class org.apache.directory.api.ldap.model.schema.AbstractSchemaObject

addExtension, addExtension, addName, clear, compareOid, copy, getDescription, getExtensions, getName, getNames, getObjectType, getOid, getSchemaName, getSpecification, hashCode, isDisabled, isEnabled, isObsolete, isReadOnly, lock, setDescription, setEnabled, setExtensions, setNames, setNames, setObsolete, setOid, setReadOnly, setSchemaName, setSpecification, unlock

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SyntaxChecker

protected SyntaxChecker(String oid)

The SyntaxChecker base constructor

Parameters:

oid - The associated OID

SyntaxChecker

protected SyntaxChecker()

The SyntaxChecker default constructor where the oid is set after instantiation.

Method Detail

isValidSyntax

public abstract boolean isValidSyntax(Object value)

Determines if the attribute's value conforms to the attribute syntax.

Parameters:

value - the value of some attribute with the syntax

Returns:

true if the value is in the valid syntax, false otherwise

assertSyntax

public void assertSyntax(Object value)
                  throws LdapException

Asserts whether or not the attribute's value conforms to the attribute syntax.

Parameters:

value - the value of some attribute with the syntax

Throws:

LdapException - if the value does not conform to the attribute syntax.

setSchemaManager

public void setSchemaManager(SchemaManager schemaManager)

Store the SchemaManager in this instance. It may be necessary for some syntaxChecker which needs to have access to the oidNormalizer Map.

Parameters:

schemaManager - the schemaManager to store

equals

public boolean equals(Object o)

Specified by:

equals in interface SchemaObject

Overrides:

equals in class LoadableSchemaObject

toString

public String toString()

Overrides:

toString in class Object