-
- All Superinterfaces:
- Serializable
- All Known Subinterfaces:
- UnsolicitedNotification
- All Known Implementing Classes:
- StartTlsResponse
public interface ExtendedResponse extends Serializable
This interface represents an LDAP extended operation response as defined in RFC 2251.ExtendedResponse ::= [APPLICATION 24] SEQUENCE { COMPONENTS OF LDAPResult, responseName [10] LDAPOID OPTIONAL, response [11] OCTET STRING OPTIONAL }
It comprises an optional object identifier and an optional ASN.1 BER encoded value.The methods in this class can be used by the application to get low level information about the extended operation response. However, typically, the application will be using methods specific to the class that implements this interface. Such a class should have decoded the BER buffer in the response and should provide methods that allow the user to access that data in the response in a type-safe and friendly manner.
For example, suppose the LDAP server supported a 'get time' extended operation. It would supply GetTimeRequest and GetTimeResponse classes. The GetTimeResponse class might look like:
A program would use then these classes as follows:public class GetTimeResponse implements ExtendedResponse { public java.util.Date getDate() {...}; public long getTime() {...}; .... }
GetTimeResponse resp = (GetTimeResponse) ectx.extendedOperation(new GetTimeRequest()); java.util.Date now = resp.getDate();
- Since:
- 1.3
- See Also:
ExtendedRequest
-
-
Method Summary
Methods Modifier and Type Method and Description byte[]
getEncodedValue()
Retrieves the ASN.1 BER encoded value of the LDAP extended operation response.String
getID()
Retrieves the object identifier of the response.
-
-
-
Method Detail
-
getID
String getID()
Retrieves the object identifier of the response. The LDAP protocol specifies that the response object identifier is optional. If the server does not send it, the response will contain no ID (i.e. null).- Returns:
- A possibly null object identifier string representing the LDAP ExtendedResponse.responseName component.
-
getEncodedValue
byte[] getEncodedValue()
Retrieves the ASN.1 BER encoded value of the LDAP extended operation response. Null is returned if the value is absent from the response sent by the LDAP server. The result is the raw BER bytes including the tag and length of the response value. It does not include the response OID.- Returns:
- A possibly null byte array representing the ASN.1 BER encoded contents of the LDAP ExtendedResponse.response component.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/naming/ldap/extendedresponse.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.