Package 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, ACIItemSyntaxChecker, AttributeTypeDescriptionSyntaxChecker, AttributeTypeUsageSyntaxChecker, AudioSyntaxChecker, BinarySyntaxChecker, BitStringSyntaxChecker, BooleanSyntaxChecker, BootParameterSyntaxChecker, CertificateListSyntaxChecker, CertificatePairSyntaxChecker, CertificateSyntaxChecker, ComparatorSyntaxChecker, CountrySyntaxChecker, CsnSidSyntaxChecker, CsnSyntaxChecker, DataQualitySyntaxSyntaxChecker, DeliveryMethodSyntaxChecker, DerefAliasSyntaxChecker, DirectoryStringSyntaxChecker, DitContentRuleDescriptionSyntaxChecker, DitStructureRuleDescriptionSyntaxChecker, DlSubmitPermissionSyntaxChecker, DnSyntaxChecker, DsaQualitySyntaxSyntaxChecker, DseTypeSyntaxChecker, EnhancedGuideSyntaxChecker, FacsimileTelephoneNumberSyntaxChecker, FaxSyntaxChecker, GeneralizedTimeSyntaxChecker, GuideSyntaxChecker, Ia5StringSyntaxChecker, IntegerSyntaxChecker, JavaByteSyntaxChecker, JavaIntegerSyntaxChecker, JavaLongSyntaxChecker, JavaShortSyntaxChecker, JpegSyntaxChecker, LdapSyntaxDescriptionSyntaxChecker, MailPreferenceSyntaxChecker, MasterAndShadowAccessPointSyntaxChecker, MatchingRuleDescriptionSyntaxChecker, MatchingRuleUseDescriptionSyntaxChecker, MhsOrAddressSyntaxChecker, NameAndOptionalUIDSyntaxChecker, NameFormDescriptionSyntaxChecker, NisNetgroupTripleSyntaxChecker, NormalizerSyntaxChecker, NumberSyntaxChecker, NumericOidSyntaxChecker, NumericStringSyntaxChecker, ObjectClassDescriptionSyntaxChecker, ObjectClassTypeSyntaxChecker, ObjectNameSyntaxChecker, OctetStringSyntaxChecker, OidLenSyntaxChecker, OidSyntaxChecker, OtherMailboxSyntaxChecker, PostalAddressSyntaxChecker, PresentationAddressSyntaxChecker, PrintableStringSyntaxChecker, ProtocolInformationSyntaxChecker, RegexSyntaxChecker, SearchScopeSyntaxChecker, SubstringAssertionSyntaxChecker, SubtreeSpecificationSyntaxChecker, SupplierAndConsumerSyntaxChecker, SupplierInformationSyntaxChecker, SupplierOrConsumerSyntaxChecker, SupportedAlgorithmSyntaxChecker, SyntaxCheckerSyntaxChecker, 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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SyntaxChecker.SCBuilder<SC>	A static Builder for this class

Field Summary

Fields

Modifier and Type	Field	Description
protected static Logger	LOG	A logger for this class
static long	serialVersionUID	The mandatory serialVersionUID

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
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, hashCode, isValid, setBytecode, setFqcn

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

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

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

The mandatory serialVersionUID

See Also:

Constant Field Values

LOG

protected static final Logger LOG

A logger for this class

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

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