| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| package org.apache.sling.servlets.post; |
| |
| import org.apache.sling.api.SlingHttpServletRequest; |
| import org.apache.sling.api.servlets.HtmlResponse; |
| import org.apache.sling.servlets.post.exceptions.PreconditionViolatedPersistenceException; |
| import org.apache.sling.servlets.post.exceptions.TemporaryPersistenceException; |
| |
| /** |
| * The <code>SlingPostOperation</code> interface defines the service API to be |
| * implemented by service providers extending the Sling default POST servlet. |
| * Service providers may register OSGi services of this type to be used by the |
| * Sling default POST servlet to handle specific operations. |
| * <p> |
| * The <code>SlingPostOperation</code> service must be registered with a |
| * {@link #PROP_OPERATION_NAME} registration property giving the name(s) of the |
| * operations supported by the service. The names will be used to find the |
| * actual operation from the {@link SlingPostConstants#RP_OPERATION |
| * :operation} request parameter. |
| * <p> |
| * The Sling default POST servlet defines the <code>copy</code>, |
| * <code>move</code> and <code>delete</code> operation names. These names should |
| * not be used by <code>SlingPostOperation</code> service providers. |
| * |
| * @deprecated as of 2.0.8 (Bundle version 2.2.0) and replaced by |
| * {@link PostOperation}. |
| */ |
| @Deprecated |
| public interface SlingPostOperation { |
| |
| /** |
| * The name of the Sling POST operation service. |
| */ |
| public static final String SERVICE_NAME = "org.apache.sling.servlets.post.SlingPostOperation"; |
| |
| /** |
| * The name of the service registration property indicating the name(s) of |
| * the operation provided by the operation implementation (value is |
| * "sling.post.operation"). The value of this service property must be a |
| * single String or an array or <code>java.util.Collection</code> of |
| * Strings. If multiple strings are defined, the service is registered for |
| * all operation names. |
| */ |
| public static final String PROP_OPERATION_NAME = "sling.post.operation"; |
| |
| /** |
| * Executes the operation provided by this service implementation. This |
| * method is called by the Sling default POST servlet. |
| * |
| * @param request The <code>SlingHttpServletRequest</code> object providing |
| * the request input for the operation. |
| * @param response The <code>HtmlResponse</code> into which the operation |
| * steps should be recorded. |
| * @param processors The {@link SlingPostProcessor} services to be called |
| * after applying the operation. This may be <code>null</code> if |
| * there are none. |
| * @throws TemporaryPersistenceException May be thrown if an error occurs during |
| * the operation, for which it makes sense to retry it with the same |
| * parameters |
| * @throws PreconditionViolatedPersistenceException May be thrown if an error occurrs |
| * during the operation because preconditions are not fulfilled. |
| * If the operation should be repeated with the same parameters, it |
| * will fail again. |
| * @throws org.apache.sling.api.resource.ResourceNotFoundException May be |
| * thrown if the operation requires an existing request |
| * resource. If this exception is thrown the Sling default POST |
| * servlet sends back a <code>404/NOT FOUND</code> response to |
| * the client. |
| * @throws org.apache.sling.api.SlingException May be thrown if an error |
| * occurrs running the operation. |
| */ |
| void run(SlingHttpServletRequest request, HtmlResponse response, |
| SlingPostProcessor[] processors) throws PreconditionViolatedPersistenceException, TemporaryPersistenceException; |
| } |