Interface WhoAmIExtendedRequest
-
- All Superinterfaces:
ExtendedRequest<WhoAmIExtendedResult>
,ProtocolOp
,Request
public interface WhoAmIExtendedRequest extends ExtendedRequest<WhoAmIExtendedResult>
The who am I extended request as defined in RFC 4532. This operation allows clients to obtain the primary authorization identity, in its primary form, that the server has associated with the user or application entity.The following example demonstrates use of the Who Am I? request and response.
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()); } }
This operation may preferable to the Authorization Identity Controls mechanism defined in RFC 3829, which uses Bind request and response controls to request and return the authorization identity. Bind controls are not protected by security layers established by the Bind operation that includes them. While it is possible to establish security layers using StartTLS prior to the Bind operation, it is often desirable to use security layers established by the Bind operation. An extended operation sent after a Bind operation is protected by the security layers established by the Bind operation.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.forgerock.opendj.ldap.messages.Request
Request.RequestType
-
-
Field Summary
Fields Modifier and Type Field Description static ExtendedRequestDecoder<WhoAmIExtendedRequest,WhoAmIExtendedResult>
DECODER
A decoder which can be used to decode who am I extended operation requests.static String
OID
The OID for the who am I extended operation request.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WhoAmIExtendedRequest
addControl(Control control)
Adds the provided control to this protocol-op.WhoAmIExtendedRequest
addControls(Iterable<? extends Control> controls)
Adds the provided controls to this protocol-op.<C extends Control>
CgetControl(ControlDecoder<C> decoder, DecodeOptions options)
Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder.List<Control>
getControls()
Returns aList
containing the controls included with this protocol-op.String
getOid()
Returns the numeric OID associated with this extended request.ExtendedResultDecoder<WhoAmIExtendedResult>
getResultDecoder()
Returns a decoder which can be used to decoded responses to this extended request.ByteString
getValue()
Returns the value, if any, associated with this extended request.boolean
hasValue()
Returnstrue
if this extended request has a value.-
Methods inherited from interface org.forgerock.opendj.ldap.messages.ProtocolOp
containsControl, getControl
-
-
-
-
Field Detail
-
DECODER
static final ExtendedRequestDecoder<WhoAmIExtendedRequest,WhoAmIExtendedResult> DECODER
A decoder which can be used to decode who am I extended operation requests.
-
OID
static final String OID
The OID for the who am I extended operation request.- See Also:
- Constant Field Values
-
-
Method Detail
-
addControl
WhoAmIExtendedRequest addControl(Control control)
Description copied from interface:ProtocolOp
Adds the provided control to this protocol-op.- Specified by:
addControl
in interfaceExtendedRequest<WhoAmIExtendedResult>
- Specified by:
addControl
in interfaceProtocolOp
- Specified by:
addControl
in interfaceRequest
- Parameters:
control
- The control to be added to this protocol-op.- Returns:
- This protocol-op.
-
addControls
WhoAmIExtendedRequest addControls(Iterable<? extends Control> controls)
Description copied from interface:ProtocolOp
Adds the provided controls to this protocol-op.- Specified by:
addControls
in interfaceExtendedRequest<WhoAmIExtendedResult>
- Specified by:
addControls
in interfaceProtocolOp
- Specified by:
addControls
in interfaceRequest
- Parameters:
controls
- The controls to be added to this protocol-op.- Returns:
- This protocol-op.
-
getControl
<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
Description copied from interface:ProtocolOp
Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder.- Specified by:
getControl
in interfaceExtendedRequest<WhoAmIExtendedResult>
- Specified by:
getControl
in interfaceProtocolOp
- Type Parameters:
C
- The type of control to be decoded and returned.- Parameters:
decoder
- The control decoder.options
- The set of decode options which should be used when decoding the control.- Returns:
- The decoded control, or
null
if the control is not included with this protocol-op. - Throws:
DecodeException
- If the control could not be decoded because it was malformed in some way (e.g. the control value was missing, or its content could not be decoded).
-
getControls
List<Control> getControls()
Description copied from interface:ProtocolOp
Returns aList
containing the controls included with this protocol-op. The returnedList
may be modified if permitted by this protocol-op.- Specified by:
getControls
in interfaceExtendedRequest<WhoAmIExtendedResult>
- Specified by:
getControls
in interfaceProtocolOp
- Returns:
- A
List
containing the controls.
-
getOid
String getOid()
Description copied from interface:ExtendedRequest
Returns the numeric OID associated with this extended request.- Specified by:
getOid
in interfaceExtendedRequest<WhoAmIExtendedResult>
- Returns:
- The numeric OID associated with this extended request.
-
getResultDecoder
ExtendedResultDecoder<WhoAmIExtendedResult> getResultDecoder()
Description copied from interface:ExtendedRequest
Returns a decoder which can be used to decoded responses to this extended request.- Specified by:
getResultDecoder
in interfaceExtendedRequest<WhoAmIExtendedResult>
- Returns:
- A decoder which can be used to decoded responses to this extended request.
-
getValue
ByteString getValue()
Description copied from interface:ExtendedRequest
Returns the value, if any, associated with this extended request. Its format is defined by the specification of this extended request.- Specified by:
getValue
in interfaceExtendedRequest<WhoAmIExtendedResult>
- Returns:
- The value associated with this extended request, or
null
if there is no value.
-
hasValue
boolean hasValue()
Description copied from interface:ExtendedRequest
Returnstrue
if this extended request has a value. In some circumstances it may be useful to determine if a extended request has a value, without actually calculating the value and incurring any performance costs.- Specified by:
hasValue
in interfaceExtendedRequest<WhoAmIExtendedResult>
- Returns:
true
if this extended request has a value, orfalse
if there is no value.
-
-