DSMLExtendedOperation.java revision 1924
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
* add the following below this CDDL HEADER, with the fields enclosed
* by brackets "[]" replaced with your own identifying information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Portions Copyright 2006-2007 Sun Microsystems, Inc.
*/
package org.opends.dsml.protocol;
import java.io.IOException;
import org.opends.server.protocols.asn1.ASN1Element;
import org.opends.server.protocols.asn1.ASN1Exception;
import org.opends.server.protocols.asn1.ASN1OctetString;
import org.opends.server.protocols.asn1.ASN1Sequence;
import org.opends.server.protocols.ldap.ExtendedRequestProtocolOp;
import org.opends.server.protocols.ldap.ExtendedResponseProtocolOp;
import org.opends.server.protocols.ldap.LDAPMessage;
import org.opends.server.protocols.ldap.ProtocolOp;
import org.opends.server.tools.LDAPConnection;
import org.opends.server.types.LDAPException;
/**
* This class provides the functionality for the performing an
* LDAP EXTENDED operation based on the specified DSML request.
*/
public class DSMLExtendedOperation
{
private LDAPConnection connection;
/**
* Create an instance with the specified LDAP connection.
*
* @param connection The LDAP connection to send the request on.
*/
public DSMLExtendedOperation(LDAPConnection connection)
{
this.connection = connection;
}
/**
* Perform the LDAP EXTENDED operation and send the result back to the
* client.
*
* @param objFactory The object factory for this operation.
* @param extendedRequest The extended request for this operation.
*
* @return The result of the extended operation.
*
* @throws IOException If an I/O problem occurs.
*
* @throws LDAPException If an error occurs while interacting with an LDAP
* element.
*
* @throws ASN1Exception If an error occurs while interacting with an ASN.1
* element.
*/
public ExtendedResponse doOperation(ObjectFactory objFactory,
ExtendedRequest extendedRequest)
throws IOException, LDAPException, ASN1Exception
{
ExtendedResponse extendedResponse = objFactory.createExtendedResponse();
extendedResponse.setRequestID(extendedRequest.getRequestID());
String requestName = extendedRequest.getRequestName();
Object value = extendedRequest.getRequestValue();
ASN1OctetString asnValue = new ASN1OctetString(value.toString());
// Create and send the LDAP request to the server.
ProtocolOp op = new ExtendedRequestProtocolOp(requestName, asnValue);
LDAPMessage msg = new LDAPMessage(DSMLServlet.nextMessageID(), op);
connection.getLDAPWriter().writeMessage(msg);
// Read and decode the LDAP response from the server.
LDAPMessage responseMessage = connection.getLDAPReader().readMessage();
ExtendedResponseProtocolOp extendedOp =
responseMessage.getExtendedResponseProtocolOp();
int resultCode = extendedOp.getResultCode();
String errorMessage = extendedOp.getErrorMessage();
// Set the result code and error message for the DSML response.
extendedResponse.setResponseName(extendedOp.getOID());
extendedResponse.setResponse(extendedOp.getValue());
extendedResponse.setErrorMessage(errorMessage);
ResultCode code = objFactory.createResultCode();
code.setCode(resultCode);
extendedResponse.setResultCode(code);
return extendedResponse;
}
}