com.unboundid.ldap.sdk.unboundidds.controls
Class ExtendedSchemaInfoRequestControl

java.lang.Object
  extended by com.unboundid.ldap.sdk.Control
      extended by com.unboundid.ldap.sdk.unboundidds.controls.ExtendedSchemaInfoRequestControl
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ExtendedSchemaInfoRequestControl
extends Control

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class provides an implementation of a control which can be used to request that the Directory Server include extended information when returning a subschema subentry. In the UnboundID Directory Server, this will cause the server to include the X-SCHEMA-FILE extension (which contains the path to the file in which that schema element is defined) and the X-READ-ONLY extension (which indicates whether that schema element is read-only and cannot be altered by external clients).

This control is not based on any public specification, and has been defined by UnboundID Corp. It does not have a value, and may or may not be critical. It should only be included in search requests.

Example

The following example demonstrates the procedure to use for requesting the UnboundID Directory Server schema with extended information. Note that the LDAPInterface.getSchema and Schema.getSchema convenience methods cannot be used because they do not allow you to include controls in the request.
 String schemaDN = Schema.getSubschemaSubentryDN(connection, "");
 SearchRequest searchRequest = new SearchRequest(schemaDN, SearchScope.BASE,
      Filter.createPresenceFilter("objectClass"), "*", "+");
 searchRequest.addControl(new ExtendedSchemaInfoRequestControl());
 SearchResult searchResult = connection.search(searchRequest);

 Schema schema = null;
 if (searchResult.getEntryCount() == 1)
 {
   schema = new Schema(searchResult.getSearchEntries().get(0));
 }
 

See Also:
Serialized Form

Field Summary
static java.lang.String EXTENDED_SCHEMA_INFO_REQUEST_OID
          The OID (1.3.6.1.4.1.30221.2.5.12) for the extended schema info request control.
 
Constructor Summary
ExtendedSchemaInfoRequestControl()
          Creates a new extended schema info request control.
ExtendedSchemaInfoRequestControl(boolean isCritical)
          Creates a new extended schema info request control with the specified criticality.
ExtendedSchemaInfoRequestControl(Control control)
          Creates a new extended schema info request control which is decoded from the provided generic control.
 
Method Summary
 java.lang.String getControlName()
          Retrieves the user-friendly name for this control, if available.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this LDAP control to the provided buffer.
 
Methods inherited from class com.unboundid.ldap.sdk.Control
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

EXTENDED_SCHEMA_INFO_REQUEST_OID

public static final java.lang.String EXTENDED_SCHEMA_INFO_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.12) for the extended schema info request control.

See Also:
Constant Field Values
Constructor Detail

ExtendedSchemaInfoRequestControl

public ExtendedSchemaInfoRequestControl()
Creates a new extended schema info request control. It will not be marked critical.


ExtendedSchemaInfoRequestControl

public ExtendedSchemaInfoRequestControl(boolean isCritical)
Creates a new extended schema info request control with the specified criticality.

Parameters:
isCritical - Indicates whether this control should be marked critical.

ExtendedSchemaInfoRequestControl

public ExtendedSchemaInfoRequestControl(Control control)
                                 throws LDAPException
Creates a new extended schema info request control which is decoded from the provided generic control.

Parameters:
control - The generic control to be decoded as an extended schema info request control.
Throws:
LDAPException - If the provided control cannot be decoded as an extended schema info request control.
Method Detail

getControlName

public java.lang.String getControlName()
Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.

Overrides:
getControlName in class Control
Returns:
The user-friendly name for this control, or the OID if no user-friendly name is available.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided buffer.

Overrides:
toString in class Control
Parameters:
buffer - The buffer to which to append the string representation of this buffer.