com.novell.ldap
Class LDAPSyntaxSchema

java.lang.Object
  com.novell.ldap.LDAPAttribute
      com.novell.ldap.LDAPSchemaElement
          com.novell.ldap.LDAPSyntaxSchema

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable, java.io.Externalizable, java.io.Serializable

public class LDAPSyntaxSchema

extends LDAPSchemaElement

implements java.io.Externalizable

Represents a syntax definition in the directory schema.

The LDAPSyntaxSchema class represents the definition of a syntax. It is used to discover the known set of syntaxes in effect for the subschema.

Although this extends LDAPSchemaElement, it does not use the name or obsolete members. Therefore, calls to the getName method always return null and to the isObsolete method always returns false. There is also no matching getSyntaxNames method in LDAPSchema. Note also that adding and removing syntaxes is not typically a supported feature of LDAP servers.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.novell.ldap.LDAPSchemaElement

description, hashQualifier, names, obsolete, oid, qualifier

Constructor Summary

LDAPSyntaxSchema()
This constructor was added to support default Serialization

LDAPSyntaxSchema(java.lang.String raw)
Constructs a syntax from the raw string value returned on a schema query for LDAPSyntaxes.

LDAPSyntaxSchema(java.lang.String oid, java.lang.String description)
Constructs a syntax for adding to or deleting from the schema.

Method Summary

protected java.lang.String	formatString() Returns a string in a format suitable for directly adding to a directory, as a value of the particular schema element class.
static java.lang.Object	readDSML(java.io.InputStream input) This method is used to deserialize the DSML encoded representation of this class.
protected void	setDeserializedValues(java.io.BufferedInputStream istream)
protected void	writeValue(java.lang.StringBuffer buff)
protected void	writeValue(java.io.Writer out)

Methods inherited from class com.novell.ldap.LDAPSchemaElement

addValue, addValue, getDescription, getID, getNames, getQualifier, getQualifierNames, isObsolete, removeValue, removeValue, setQualifier, toString

Methods inherited from class com.novell.ldap.LDAPAttribute

addBase64Value, addBase64Value, addBase64Value, addURLValue, addURLValue, addValue, clone, compareTo, getBaseName, getBaseName, getByteValue, getByteValueArray, getByteValues, getLangSubtype, getName, getStringValue, getStringValueArray, getStringValues, getSubtypes, getSubtypes, hasSubtype, hasSubtypes, readExternal, removeValue, setValue, size, writeDSML, writeExternal

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Constructor Detail

LDAPSyntaxSchema

public LDAPSyntaxSchema()

This constructor was added to support default Serialization

LDAPSyntaxSchema

public LDAPSyntaxSchema(java.lang.String raw)

Constructs a syntax from the raw string value returned on a schema query for LDAPSyntaxes.

Parameters:

raw - The raw string value returned from a schema query for ldapSyntaxes.

LDAPSyntaxSchema

public LDAPSyntaxSchema(java.lang.String oid,
                        java.lang.String description)

Constructs a syntax for adding to or deleting from the schema.

Adding and removing syntaxes is not typically a supported feature of LDAP servers. Novell eDirectory does not allow syntaxes to be added or removed.

Parameters:

oid - The unique object identifier of the syntax - in dotted numerical format.

description - An optional description of the syntax.

Method Detail

formatString

protected java.lang.String formatString()

Returns a string in a format suitable for directly adding to a directory, as a value of the particular schema element class.

Specified by:

formatString in class LDAPSchemaElement

Returns:

A string representation of the syntax's definition.

setDeserializedValues

protected void setDeserializedValues(java.io.BufferedInputStream istream)
                              throws java.io.IOException

Overrides:

setDeserializedValues in class LDAPAttribute

Throws:

java.io.IOException

writeValue

protected void writeValue(java.io.Writer out)
                   throws java.io.IOException

Overrides:

writeValue in class LDAPAttribute

Throws:

java.io.IOException

writeValue

protected void writeValue(java.lang.StringBuffer buff)

Overrides:

writeValue in class LDAPAttribute

readDSML

public static java.lang.Object readDSML(java.io.InputStream input)
                                 throws java.io.IOException

This method is used to deserialize the DSML encoded representation of this class.

Parameters:

input - InputStream for the DSML formatted data.

Returns:

Deserialized form of this class.

Throws:

java.io.IOException - when serialization fails.