Package org.opends.dsml.protocol

Class DSMLServlet

  • All Implemented Interfaces:
    Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
    public class DSMLServlet
extends javax.servlet.http.HttpServlet
    This class provides the entry point for the DSML request. It parses the SOAP request, calls the appropriate class which performs the LDAP operation, and returns the response as a DSML response.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      DSMLServlet()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void doPost​(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
      The HTTP POST operation.
      void init​(javax.servlet.ServletConfig config)
      This method will be called by the Servlet Container when this servlet is being placed into service.
      static int nextMessageID()
      Retrieves a message ID that may be used for the next LDAP message sent to the Directory Server.

      • Methods inherited from class javax.servlet.http.HttpServlet

        doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service, service

      • Methods inherited from class javax.servlet.GenericServlet

        destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

    • Constructor Detail

      • DSMLServlet

        public DSMLServlet()

    • Method Detail

      • init

        public void init​(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException
        This method will be called by the Servlet Container when this servlet is being placed into service.
        Specified by:
        init in interface javax.servlet.Servlet
        Overrides:
        init in class javax.servlet.GenericServlet
        Parameters:
        config - - the ServletConfig object that contains configuration information for this servlet.
        Throws:
        javax.servlet.ServletException - If an error occurs during processing.

      • doPost

        public void doPost​(javax.servlet.http.HttpServletRequest req,
                   javax.servlet.http.HttpServletResponse res)
            throws javax.servlet.ServletException,
                   IOException
        The HTTP POST operation. This servlet expects a SOAP message with a DSML request payload.
        Overrides:
        doPost in class javax.servlet.http.HttpServlet
        Parameters:
        req - Information about the request received from the client.
        res - Information about the response to send to the client.
        Throws:
        javax.servlet.ServletException - If an error occurs during servlet processing.
        IOException - If an error occurs while interacting with the client.

      • nextMessageID

        public static int nextMessageID()
        Retrieves a message ID that may be used for the next LDAP message sent to the Directory Server.
        Returns:
        A message ID that may be used for the next LDAP message sent to the Directory Server.