Skip navigation links

com.octetstring.vde.schema
Class AttributeType

java.lang.Object
com.octetstring.vde.schema.AttributeType

All Implemented Interfaces:

java.io.Serializable

public class AttributeType

extends java.lang.Object

implements java.io.Serializable

Class used to represent an LDAP attribute type definition

See Also:

Serialized Form

Constructor Summary

AttributeType()

AttributeType(java.lang.String rfctype)
Constructor accepting for input an RFC2252-style string representing an attribute type AttributeTypeDescription = "(" whsp numericoid whsp ; AttributeType identifier [ "NAME" qdescrs ] ; name used in AttributeType [ "DESC" qdstring ] ; description [ "OBSOLETE" whsp ] [ "SUP" woid ] ; derived from this other ; AttributeType [ "EQUALITY" woid ; Matching Rule name [ "ORDERING" woid ; Matching Rule name [ "SUBSTR" woid ] ; Matching Rule name [ "SYNTAX" whsp noidlen whsp ] ; see section 4.3 [ "SINGLE-VALUE" whsp ] ; default multi-valued [ "COLLECTIVE" whsp ] ; default not collective [ "NO-USER-MODIFICATION" whsp ]; default user modifiable [ "USAGE" whsp AttributeUsage ]; default userApplications extenstions whsp ")" AttributeUsage = "userApplications" / "directoryOperation" / "distributedOperation" / ; DSA-shared "dSAOperation" ; DSA-specific, value depends on server extensions = *( SP xstring SP qdstrings ) xstring = "X" - 1*( ALPHA/ HYPHEN/ USCORE ) qdstrings = qdescr / ( "(" whsp qdstringlist whsp ")" ) qdstringlist = [ qdstring *( SP qdstring ) ] qdstring = "'" dstring "'"

Method Summary

void	addExtension(DirectoryString extnName, DirectoryString extnValue)
int	getBound()
java.lang.String	getDescription()
java.lang.String	getEqualityMatch()
java.util.Map<DirectoryString,java.util.List<DirectoryString>>	getExtensions()
DirectoryString	getName()
java.lang.String	getOid()
java.lang.String	getOrderingMatch()
java.lang.String	getSubstrMatch()
DirectoryString	getSuperior()
java.lang.String	getSyntax()
java.lang.Class<? extends Syntax>	getSyntaxClass()
Syntax	getSyntaxInstance()
java.lang.String	getUsage()
boolean	isCaseInsensitiveMatch()
boolean	isCollective()
boolean	isNoUserModification()
boolean	isObsolete()
boolean	isSingleValue()
void	setBound(int newBound)
void	setCollective(boolean collective)
void	setDescription(java.lang.String description)
void	setEqualityMatch(java.lang.String equalityMatch)
void	setExtensions(java.util.Map<DirectoryString,java.util.List<DirectoryString>> extns)
void	setName(DirectoryString name)
void	setNoUserModification(boolean noUserModification)
void	setObsolete(boolean obsolete)
void	setOid(java.lang.String oid)
void	setOidForce(java.lang.String oid)
void	setOrderingMatch(java.lang.String orderingMatch)
void	setSingleValue(boolean singleValue)
void	setSubstrMatch(java.lang.String substrMatch)
void	setSuperior(DirectoryString superior)
void	setSyntax(java.lang.String syntax)
void	setUsage(java.lang.String usage)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeType

public AttributeType()

AttributeType

public AttributeType(java.lang.String rfctype)
              throws DirectoryException

Constructor accepting for input an RFC2252-style string representing an attribute type AttributeTypeDescription = "(" whsp numericoid whsp ; AttributeType identifier [ "NAME" qdescrs ] ; name used in AttributeType [ "DESC" qdstring ] ; description [ "OBSOLETE" whsp ] [ "SUP" woid ] ; derived from this other ; AttributeType [ "EQUALITY" woid ; Matching Rule name [ "ORDERING" woid ; Matching Rule name [ "SUBSTR" woid ] ; Matching Rule name [ "SYNTAX" whsp noidlen whsp ] ; see section 4.3 [ "SINGLE-VALUE" whsp ] ; default multi-valued [ "COLLECTIVE" whsp ] ; default not collective [ "NO-USER-MODIFICATION" whsp ]; default user modifiable [ "USAGE" whsp AttributeUsage ]; default userApplications extenstions whsp ")" AttributeUsage = "userApplications" / "directoryOperation" / "distributedOperation" / ; DSA-shared "dSAOperation" ; DSA-specific, value depends on server extensions = *( SP xstring SP qdstrings ) xstring = "X" - 1*( ALPHA/ HYPHEN/ USCORE ) qdstrings = qdescr / ( "(" whsp qdstringlist whsp ")" ) qdstringlist = [ qdstring *( SP qdstring ) ] qdstring = "'" dstring "'"

Throws:

DirectoryException

Method Detail

setExtensions

public void setExtensions(java.util.Map<DirectoryString,java.util.List<DirectoryString>> extns)

getExtensions

public java.util.Map<DirectoryString,java.util.List<DirectoryString>> getExtensions()

addExtension

public void addExtension(DirectoryString extnName,
                         DirectoryString extnValue)

getBound

public int getBound()

setBound

public void setBound(int newBound)

isCollective

public boolean isCollective()

setCollective

public void setCollective(boolean collective)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getEqualityMatch

public java.lang.String getEqualityMatch()

setEqualityMatch

public void setEqualityMatch(java.lang.String equalityMatch)

isCaseInsensitiveMatch

public boolean isCaseInsensitiveMatch()

getName

public DirectoryString getName()

setName

public void setName(DirectoryString name)
             throws DirectoryException

Throws:

DirectoryException

isNoUserModification

public boolean isNoUserModification()

setNoUserModification

public void setNoUserModification(boolean noUserModification)

isObsolete

public boolean isObsolete()

setObsolete

public void setObsolete(boolean obsolete)

getOid

public java.lang.String getOid()

setOid

public void setOid(java.lang.String oid)
            throws DirectoryException

Throws:

DirectoryException

setOidForce

public void setOidForce(java.lang.String oid)

getOrderingMatch

public java.lang.String getOrderingMatch()

setOrderingMatch

public void setOrderingMatch(java.lang.String orderingMatch)

isSingleValue

public boolean isSingleValue()

setSingleValue

public void setSingleValue(boolean singleValue)

getSubstrMatch

public java.lang.String getSubstrMatch()

setSubstrMatch

public void setSubstrMatch(java.lang.String substrMatch)

getSuperior

public DirectoryString getSuperior()

setSuperior

public void setSuperior(DirectoryString superior)

getSyntax

public java.lang.String getSyntax()

setSyntax

public void setSyntax(java.lang.String syntax)

getUsage

public java.lang.String getUsage()

setUsage

public void setUsage(java.lang.String usage)

getSyntaxClass

public java.lang.Class<? extends Syntax> getSyntaxClass()

getSyntaxInstance

public Syntax getSyntaxInstance()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Skip navigation links