Class ExtendedSchemaInfoRequestControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.unboundidds.controls.ExtendedSchemaInfoRequestControl
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ExtendedSchemaInfoRequestControl extends Control
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 Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 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).
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
This control is not based on any public specification, and has been defined by Ping Identity Corporation 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 Directory Server schema with extended information. Note that theLDAPInterface.getSchema
andSchema.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
Fields Modifier and Type Field Description 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
Constructors Constructor Description 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ExtendedSchemaInfoRequestControl
decodeJSONControl(JSONObject controlObject, boolean strict)
Attempts to decode the provided object as a JSON representation of an extended schema info request control.java.lang.String
getControlName()
Retrieves the user-friendly name for this control, if available.JSONObject
toJSONControl()
Retrieves a representation of this extended schema info request control as a JSON object.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, decodeJSONControl, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
-
-
-
-
Field Detail
-
EXTENDED_SCHEMA_INFO_REQUEST_OID
@NotNull 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(@NotNull 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
@NotNull 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 classControl
- Returns:
- The user-friendly name for this control, or the OID if no user-friendly name is available.
-
toJSONControl
@NotNull public JSONObject toJSONControl()
Retrieves a representation of this extended schema info request control as a JSON object. The JSON object uses the following fields (note that since this control does not have a value, neither thevalue-base64
norvalue-json
fields may be present):-
oid
-- A mandatory string field whose value is the object identifier for this control. For the extended scheam info request control, the OID is "1.3.6.1.4.1.30221.2.5.12". -
control-name
-- An optional string field whose value is a human-readable name for this control. This field is only intended for descriptive purposes, and when decoding a control, theoid
field should be used to identify the type of control. -
criticality
-- A mandatory Boolean field used to indicate whether this control is considered critical.
- Overrides:
toJSONControl
in classControl
- Returns:
- A JSON object that contains a representation of this control.
-
-
decodeJSONControl
@NotNull public static ExtendedSchemaInfoRequestControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
Attempts to decode the provided object as a JSON representation of an extended schema info request control.- Parameters:
controlObject
- The JSON object to be decoded. It must not benull
.strict
- Indicates whether to use strict mode when decoding the provided JSON object. If this istrue
, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this isfalse
, then unrecognized fields will be ignored.- Returns:
- The extended schema info request control that was decoded from the provided JSON object.
- Throws:
LDAPException
- If the provided JSON object cannot be parsed as a valid extended schema info request control.
-
-