Package org.forgerock.opendj.ldap.messages

Interface RequestVisitor<R,​P,​E extends Exception>

  • Type Parameters:
    R - The return type of this visitor's methods. Use Void for visitors that do not need to return results.
    P - The type of the additional parameter to this visitor's methods. Use Void for visitors that do not need an additional parameter.
    E - The type of the exception thrown by the visitor method if it fails, or NeverThrowsException if the visitor cannot fail.
    All Known Implementing Classes:
    AbstractRequestVisitor, ChangeRecordVisitor
    public interface RequestVisitor<R,​P,​E extends Exception>
    A visitor of Requests, in the style of the visitor design pattern.

    Classes implementing this interface can query requests in a type-safe manner. When a visitor is passed to a request's accept method, the corresponding visit method most applicable to that request is invoked.

    • Method Detail

      • visitRequest

        R visitRequest​(P p,
               AbandonRequest request)
        throws E extends Exception
        Visits an Abandon request.
        Parameters:
        p - A visitor specified parameter.
        request - The Abandon request.
        Returns:
        Returns a visitor specified result.
        Throws:
        E - If the visitor failed.
        E extends Exception

      • visitRequest

        R visitRequest​(P p,
               AddRequest request)
        throws E extends Exception
        Visits an Add request.
        Parameters:
        p - A visitor specified parameter.
        request - The Add request.
        Returns:
        Returns a visitor specified result.
        Throws:
        E - If the visitor failed.
        E extends Exception

      • visitRequest

        R visitRequest​(P p,
               BindRequest request)
        throws E extends Exception
        Visits an Bind request.
        Parameters:
        p - A visitor specified parameter.
        request - The Bind request.
        Returns:
        Returns a visitor specified result.
        Throws:
        E - If the visitor failed.
        E extends Exception

      • visitRequest

        R visitRequest​(P p,
               CompareRequest request)
        throws E extends Exception
        Visits an Compare request.
        Parameters:
        p - A visitor specified parameter.
        request - The Compare request.
        Returns:
        Returns a visitor specified result.
        Throws:
        E - If the visitor failed.
        E extends Exception

      • visitRequest

        R visitRequest​(P p,
               DeleteRequest request)
        throws E extends Exception
        Visits an Delete request.
        Parameters:
        p - A visitor specified parameter.
        request - The Delete request.
        Returns:
        Returns a visitor specified result.
        Throws:
        E - If the visitor failed.
        E extends Exception

      • visitRequest

        R visitRequest​(P p,
               ExtendedRequest<?> request)
        throws E extends Exception
        Visits an Extended request.
        Parameters:
        p - A visitor specified parameter.
        request - The Extended request.
        Returns:
        Returns a visitor specified result.
        Throws:
        E - If the visitor failed.
        E extends Exception

      • visitRequest

        R visitRequest​(P p,
               InvalidRequest request)
        throws E extends Exception
        Visits an Invalid request.
        Parameters:
        p - A visitor specified parameter.
        request - The Invalid request.
        Returns:
        Returns a visitor specified result.
        Throws:
        E - If the visitor failed.
        E extends Exception

      • visitRequest

        R visitRequest​(P p,
               ModifyDnRequest request)
        throws E extends Exception
        Visits an ModifyDN request.
        Parameters:
        p - A visitor specified parameter.
        request - The ModifyDN request.
        Returns:
        Returns a visitor specified result.
        Throws:
        E - If the visitor failed.
        E extends Exception

      • visitRequest

        R visitRequest​(P p,
               ModifyRequest request)
        throws E extends Exception
        Visits an Modify request.
        Parameters:
        p - A visitor specified parameter.
        request - The Modify request.
        Returns:
        Returns a visitor specified result.
        Throws:
        E - If the visitor failed.
        E extends Exception

      • visitRequest

        R visitRequest​(P p,
               SearchRequest request)
        throws E extends Exception
        Visits an Search request.
        Parameters:
        p - A visitor specified parameter.
        request - The Search request.
        Returns:
        Returns a visitor specified result.
        Throws:
        E - If the visitor failed.
        E extends Exception

      • visitRequest

        R visitRequest​(P p,
               UnbindRequest request)
        throws E extends Exception
        Visits an Unbind request.
        Parameters:
        p - A visitor specified parameter.
        request - The Unbind request.
        Returns:
        Returns a visitor specified result.
        Throws:
        E - If the visitor failed.
        E extends Exception

      • visitRequest

        R visitRequest​(P p,
               UnknownRequest request)
        throws E extends Exception
        Visits an Unknown request.
        Parameters:
        p - A visitor specified parameter.
        request - The Unknown request.
        Returns:
        Returns a visitor specified result.
        Throws:
        E - If the visitor failed.
        E extends Exception