org.apache.sling.servlets.post.PostResponse Maven / Gradle / Ivy
Show all versions of aem-sdk-api Show documentation
/*
* 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 java.io.IOException;
import javax.servlet.http.HttpServletResponse;
/**
* The PostResponse interface defines the API of a response
* container which can (and should) be used by {@link PostOperation} services to
* prepare responses to be sent back to the client.
*
* This bundle provides a preconfigured {@link HtmlResponse} and a
* {@link JSONResponse} implementation of this interface. Clients may extend the
* {@link AbstractPostResponse} class to provide their own response
* implementations.
*/
public interface PostResponse {
/**
* Sets the referer property
* @param referer the referer
*/
public void setReferer(String referer);
/**
* Returns the referer previously set by {@link #setReferer(String)}
* @return the referer
*/
public String getReferer();
/**
* Sets the absolute path of the item upon which the request operated.
* @param path the path
*/
public void setPath(String path);
/**
* Returns the absolute path of the item upon which the request operated.
*
* If the {@link #setPath(String)} method has not been called yet, this
* method returns null.
* @return the path (might be null)
*/
public String getPath();
/**
* Sets whether the request was a create request or not.
* @param isCreateRequest true if the request was a create request
*/
public void setCreateRequest(boolean isCreateRequest);
/**
* Returns true if this was a create request.
*
* Before calling the {@link #setCreateRequest(boolean)} method, this method
* always returns false.
* @return if this was a create request
*/
public boolean isCreateRequest();
/**
* Sets the location of this modification. This is the externalized form of
* the {@link #getPath() current path}.
*
* @param location the location
*/
public void setLocation(String location);
/**
* Returns the location of the modification.
*
* If the {@link #setLocation(String)} method has not been called yet, this
* method returns null.
* @return the location
*/
public String getLocation();
/**
* Sets the parent location of the modification. This is the externalized
* form of the parent node of the {@link #getPath() current path}.
* @param parentLocation the parent location of the modification
*/
public void setParentLocation(String parentLocation);
/**
* Returns the parent location of the modification.
*
* If the {@link #setParentLocation(String)} method has not been called yet,
* this method returns null.
* @return the parent location
*/
public String getParentLocation();
/**
* Sets the title of the response message
*
* @param title the title
*/
public void setTitle(String title);
/**
* Sets the response status code properties
*
* @param code the code
* @param message the message
*/
public void setStatus(int code, String message);
/**
* Returns the status code of this instance. If the status code has never
* been set by calling the {@link #setStatus(int, String)} method, the
* status code is determined by checking if there was an error. If there was
* an error, the response is assumed to be unsuccessful and 500 is returned.
* If there is no error, the response is assumed to be successful and 200 is
* returned.
* @return the status code
*/
public int getStatusCode();
/**
* Returns the status message or null if no has been set with
* the {@link #setStatus(int, String)} method.
* @return the status message (might be null)
*/
public String getStatusMessage();
/**
* Sets the recorded error causing the operation to fail.
* @param error the throwable
*/
public void setError(Throwable error);
/**
* Returns any recorded error or null
*
* @return an error or null
*/
public Throwable getError();
/**
* Returns true if no {@link #getError() error} is set and if
* the {@link #getStatusCode() status code} is one of the 2xx codes.
* @return true if the status code is 2xx
*/
public boolean isSuccessful();
// ---------- ChangeLog ----------------------------------------------------
/**
* Records a 'created' change
*
* @param path path of the item that was created
*/
public void onCreated(String path);
/**
* Records a 'modified' change
*
* @param path path of the item that was modified
*/
public void onModified(String path);
/**
* Records a 'deleted' change
*
* @param path path of the item that was deleted
*/
public void onDeleted(String path);
/**
* Records a 'moved' change.
*
* Note: the moved change only records the basic move command. the implied
* changes on the moved properties and sub nodes are not recorded.
*
* @param srcPath source path of the node that was moved
* @param dstPath destination path of the node that was moved.
*/
public void onMoved(String srcPath, String dstPath);
/**
* Records a 'copied' change.
*
* Note: the copy change only records the basic copy command. the implied
* changes on the copied properties and sub nodes are not recorded.
*
* @param srcPath source path of the node that was copied
* @param dstPath destination path of the node that was copied.
*/
public void onCopied(String srcPath, String dstPath);
/**
* Records a generic change of the given type with arguments.
*
* @param type The type of the modification
* @param arguments The arguments to the modifications
*/
void onChange(String type, String... arguments);
/**
* Writes the response back over the provided HTTP channel. The actual
* format of the response is implementation dependent.
*
* @param response to send to
* @param setStatus whether to set the status code on the response
* @throws IOException if an i/o exception occurs
*/
void send(HttpServletResponse response, boolean setStatus)
throws IOException;
}