This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.naming.ldap
interface ExtendedResponse
- All Superinterfaces:
- Serializable
- 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:
public class GetTimeResponse implements ExtendedResponse {
public java.util.Date getDate() {...};
public long getTime() {...};
....
}
A program would use then these classes as follows:
GetTimeResponse resp =
(GetTimeResponse) ectx.extendedOperation(new GetTimeRequest());
java.util.Date now = resp.getDate();
Method Summary |
byte[] |
Retrieves the ASN.1 BER encoded value of the LDAP extended operation
response.
|
String |
Retrieves the object identifier of the response.
|
getEncodedValue
public 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.
getID
public 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.
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.