From 1e74b0f8f046cc9e69ba9eddbc180bf10ab83e06 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Thu, 20 Sep 2012 16:58:20 +0000
Subject: [PATCH] CR-701 Fix for OPENDJ-596: Include more examples in LDAP SDK Javadoc
---
opendj3/opendj-ldap-sdk/src/main/java/org/forgerock/opendj/ldap/responses/WhoAmIExtendedResult.java | 18 ++++++++++++++++++
1 files changed, 18 insertions(+), 0 deletions(-)
diff --git a/opendj3/opendj-ldap-sdk/src/main/java/org/forgerock/opendj/ldap/responses/WhoAmIExtendedResult.java b/opendj3/opendj-ldap-sdk/src/main/java/org/forgerock/opendj/ldap/responses/WhoAmIExtendedResult.java
index e3cb1cb..028f662 100644
--- a/opendj3/opendj-ldap-sdk/src/main/java/org/forgerock/opendj/ldap/responses/WhoAmIExtendedResult.java
+++ b/opendj3/opendj-ldap-sdk/src/main/java/org/forgerock/opendj/ldap/responses/WhoAmIExtendedResult.java
@@ -45,6 +45,24 @@
* <p>
* The authorization identity is specified using an authorization ID, or
* {@code authzId}, as defined in RFC 4513 section 5.2.1.8.
+ * <p>
+ * The following example demonstrates use of the Who Am I? request and response.
+ *
+ * <pre>
+ * Connection connection = ...;
+ * String name = ...;
+ * char[] password = ...;
+ *
+ * Result result = connection.bind(name, password);
+ * if (result.isSuccess()) {
+ * WhoAmIExtendedRequest request = Requests.newWhoAmIExtendedRequest();
+ * WhoAmIExtendedResult extResult = connection.extendedRequest(request);
+ *
+ * if (extResult.isSuccess()) {
+ * // Authz ID: " + extResult.getAuthorizationID());
+ * }
+ * }
+ * </pre>
*
* @see org.forgerock.opendj.ldap.requests.WhoAmIExtendedRequest
* @see org.forgerock.opendj.ldap.controls.AuthorizationIdentityRequestControl
--
Gitblit v1.10.0