|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.ExtendedSchemaInfoRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ExtendedSchemaInfoRequestControl
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).
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)); }
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 |
---|
public static final java.lang.String EXTENDED_SCHEMA_INFO_REQUEST_OID
Constructor Detail |
---|
public ExtendedSchemaInfoRequestControl()
public ExtendedSchemaInfoRequestControl(boolean isCritical)
isCritical
- Indicates whether this control should be marked
critical.public ExtendedSchemaInfoRequestControl(Control control) throws LDAPException
control
- The generic control to be decoded as an extended schema
info request control.
LDAPException
- If the provided control cannot be decoded as an
extended schema info request control.Method Detail |
---|
public java.lang.String getControlName()
getControlName
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which to append the string representation of
this buffer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |