Interface PostOperation

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String PROP_OPERATION_NAME
      The name of the service registration property indicating the name(s) of the operation provided by the operation implementation.
      static String SERVICE_NAME
      The name of the Sling POST operation service.
    • Field Detail

      • PROP_OPERATION_NAME

        static final String PROP_OPERATION_NAME
        The name of the service registration property indicating the name(s) of the operation provided by the operation implementation. The value of this service property must be a single String or an array or java.util.Collection of Strings. If multiple strings are defined, the service is registered for all operation names.
        See Also:
        Constant Field Values
    • Method Detail

      • run

        void run​(org.apache.sling.api.SlingHttpServletRequest request,
                 PostResponse response,
                 SlingPostProcessor[] processors)
          throws PreconditionViolatedPersistenceException,
                 TemporaryPersistenceException,
                 org.apache.sling.api.resource.PersistenceException
        Executes the operation provided by this service implementation. This method is called by the Sling POST servlet.
        Parameters:
        request - The SlingHttpServletRequest object providing the request input for the operation.
        response - The HtmlResponse into which the operation steps should be recorded.
        processors - The SlingPostProcessor services to be called after applying the operation. This may be null if there are none.
        Throws:
        org.apache.sling.api.resource.PersistenceException - when the commit fails
        org.apache.sling.api.resource.ResourceNotFoundException - May be thrown if the operation requires an existing request resource. If this exception is thrown the Sling POST servlet sends back a 404/NOT FOUND response to the client.
        org.apache.sling.api.SlingException - May be thrown if an error Occurs running the operation.
        PreconditionViolatedPersistenceException - when a necessary precondition failed, and a retry without further changes doesn't make sense.
        TemporaryPersistenceException - when a commit failed, but a retry could make the operation work successfully.