org.opends.server.schema

Class SomeSchemaElement

java.lang.Object

org.opends.server.schema.SomeSchemaElement

All Implemented Interfaces:

SchemaFileElement

public class SomeSchemaElement
extends Object
implements SchemaFileElement

Represents a schema element which is either a SDK attribute type or an objectclass from the server.

In absence of a common interface, this class allows to process all elements in the same way, and to provide useful server-oriented methods like getSchemaFile() or getOrigin().

Constructor Summary

Constructors

Constructor and Description
SomeSchemaElement(org.forgerock.opendj.ldap.schema.AttributeType attributeType) Builds SomeSchemaElement.
SomeSchemaElement(ObjectClass objectClass) Builds SomeSchemaElement.

Method Summary

Methods

Modifier and Type	Method and Description
static org.forgerock.opendj.ldap.schema.AttributeType	changeSuperiorType(org.forgerock.opendj.ldap.schema.AttributeType attributeType, org.forgerock.opendj.ldap.schema.AttributeType newSuperiorType) Returns a copy of the provided attribute type, changing the superior attribute type.
String	getAttributeName() Returns the attribute name of the wrapped element.
org.forgerock.opendj.ldap.schema.AttributeType	getAttributeType() Returns the wrapped schema element as an attribute type.
String	getDefinitionWithFileName() Retrieves the definition string used to create this attribute type and including the X-SCHEMA-FILE extension.
Map<String,List<String>>	getExtraProperties() Retrieves the "extra" properties for this schema definition.
String	getNameOrOID() Returns the name or OID of the wrapped element.
Iterable<String>	getNames() Returns the names of the wrapped element.
ObjectClass	getObjectClass() Returns the wrapped schema element as an object class.
String	getOID() Returns the OID of the wrapped element.
String	getOrigin() Returns the origin of the provided schema element.
String	getSchemaFile() Returns the name of the schema file that contains the definition of the wrapped element.
boolean	isAttributeType() Returns whether the wrapped element is an attribute type.
boolean	isObjectClass() Returns whether the wrapped element is an object class.
void	setExtraPropertyMultipleValues(ServerContext serverContext, String property, List<String> values) Sets a multi-valued extra property on the wrapped element.
void	setExtraPropertySingleValue(ServerContext serverContext, String property, String value) Sets a single-valued extra property on the wrapped element.
void	setSchemaFile(ServerContext serverContext, String schemaFile) Sets the name of the schema file that contains the definition of the wrapped element.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SomeSchemaElement

public SomeSchemaElement(ObjectClass objectClass)

Builds SomeSchemaElement.

Parameters:

objectClass - the common schema element to wrap

SomeSchemaElement

public SomeSchemaElement(org.forgerock.opendj.ldap.schema.AttributeType attributeType)

Builds SomeSchemaElement.

Parameters:

attributeType - the attribute type element to wrap

Method Detail

getObjectClass

public ObjectClass getObjectClass()

Returns the wrapped schema element as an object class.

Returns:

the wrapped object class

getAttributeType

public org.forgerock.opendj.ldap.schema.AttributeType getAttributeType()

Returns the wrapped schema element as an attribute type.

Returns:

the wrapped attribute type

isAttributeType

public boolean isAttributeType()

Returns whether the wrapped element is an attribute type.

Returns:

true when the wrapped element is an attribute type, false otherwise

isObjectClass

public boolean isObjectClass()

Returns whether the wrapped element is an object class.

Returns:

true when the wrapped element is an object class, false otherwise

getOID

public String getOID()

Returns the OID of the wrapped element.

Returns:

the OID of the wrapped element.

getNameOrOID

public String getNameOrOID()

Returns the name or OID of the wrapped element.

Returns:

the name or OID of the wrapped element.

getNames

public Iterable<String> getNames()

Returns the names of the wrapped element.

Returns:

the names of the wrapped element.

getExtraProperties

public Map<String,List<String>> getExtraProperties()

Description copied from interface: SchemaFileElement

Retrieves the "extra" properties for this schema definition.

FIXME Contrary to the SDK, this method returns a modifiable Map.

Specified by:

getExtraProperties in interface SchemaFileElement

Returns:

Returns a Map of the "extra" properties for this schema definition, where the key is the property name and the value is a List of Strings representing the property values. Single valued properties have a List with a single element inside.

toString

public String toString()

Overrides:

toString in class Object

getDefinitionWithFileName

public String getDefinitionWithFileName()

Retrieves the definition string used to create this attribute type and including the X-SCHEMA-FILE extension.

Returns:

The definition string used to create this attribute type including the X-SCHEMA-FILE extension.

getSchemaFile

public String getSchemaFile()

Returns the name of the schema file that contains the definition of the wrapped element.

Returns:

the name of the schema file that contains the definition of the wrapped element.

setSchemaFile

public void setSchemaFile(ServerContext serverContext,
                 String schemaFile)

Sets the name of the schema file that contains the definition of the wrapped element.

Parameters:

serverContext - the server context

schemaFile - the name of the schema file that contains the definition of the wrapped element.

getOrigin

public String getOrigin()

Returns the origin of the provided schema element.

Returns:

the origin of the provided schema element.

getAttributeName

public String getAttributeName()

Returns the attribute name of the wrapped element.

Returns:

the attribute name of the wrapped element.

setExtraPropertySingleValue

public void setExtraPropertySingleValue(ServerContext serverContext,
                               String property,
                               String value)

Sets a single-valued extra property on the wrapped element.

Parameters:

serverContext - the server context

property - the property to set

value - the value to set

setExtraPropertyMultipleValues

public void setExtraPropertyMultipleValues(ServerContext serverContext,
                                  String property,
                                  List<String> values)

Sets a multi-valued extra property on the wrapped element.

Parameters:

serverContext - the server context

property - the property to set

values - the values to set

changeSuperiorType

public static org.forgerock.opendj.ldap.schema.AttributeType changeSuperiorType(org.forgerock.opendj.ldap.schema.AttributeType attributeType,
                                                                org.forgerock.opendj.ldap.schema.AttributeType newSuperiorType)

Returns a copy of the provided attribute type, changing the superior attribute type.

Parameters:

attributeType - the attribute type for which a modified copy must be built

newSuperiorType - the new superior attribute type to set, null means remove the superior type

Returns:

an attribute type builder to build an updated copy of the provided attribute type