| java.lang.Object
 org.geoserver.ows.Response
All known Subclasses: org.geoserver.wfs.response.LockFeatureTypeResponse, org.geoserver.wfsv.response.v1_1_0.GetDiffHtmlOutputFormat, org.geoserver.wfsv.response.v1_1_0.GetDiffTransactionOutputFormat, org.geoserver.wfs.response.HitsOutputFormat, org.geoserver.ows.adapters.ResponseAdapter, org.geoserver.wfs.response.GetCapabilitiesResponse, org.geoserver.wfsv.response.v1_1_0.VersionedXmlSchemaEncoder, org.geoserver.ows.MessageResponse, org.geoserver.wfs.response.TransactionResponse, org.geoserver.wfsv.response.v1_1_0.GetLogHtmlOutputFormat, org.geoserver.wfsv.response.v1_0_0.VersionedXmlSchemaEncoder, org.geoserver.wfsv.response.v1_1_0.VersionedGML3OutputFormat, org.geoserver.wfs.WFSDescribeFeatureTypeOutputFormat, org.geoserver.wfs.WFSGetFeatureOutputFormat,
| Response | | abstract public class Response (Code) | | Response to an operation, which serializes the result of the operation to an
output stream.
A response must specify the following information:
Optionally, a response may declare a well-known name for it. This well
known name corresponds to the "outputFormat" parameter which is supported
on many types of OWS request.
author:
Justin Deoliveira, The Open Planning Project, jdeolive@openplans.org |
| Constructor Summary | |
| public | Response(Class binding)
Constructor which specified the class this response is bound to. | | public | Response(Class binding, String outputFormat)
Constructor which specified the class this response is bound to, and a
common name for the type of response. | | public | Response(Class binding, Set outputFormats)
Constructor which specified the class this response is bound to, and a
set of common names for the type of response. |
| binding | | final Class binding(Code) | | Class of object to serialize
|
| outputFormats | | final Set outputFormats(Code) | | The well known "outputFormat" of the response
|
| Response | | public Response(Class binding)(Code) | | Constructor which specified the class this response is bound to.
Parameters:
binding - The class of object the response serializes. |
| Response | | public Response(Class binding, String outputFormat)(Code) | | Constructor which specified the class this response is bound to, and a
common name for the type of response.
Parameters:
binding - The class of object the response serializes
Parameters:
outputFormat - A common name for the response. |
| Response | | public Response(Class binding, Set outputFormats)(Code) | | Constructor which specified the class this response is bound to, and a
set of common names for the type of response.
Parameters:
binding - The class of object the response serializes
Parameters:
outputFormats - A set of common names for the response. |
| canHandle | | public boolean canHandle(Operation operation)(Code) | | Determines if the response can handle the operation being performed.
This method is called before
Response.write(Object,OutputStream,Operation) .
Subclasses should override this method to perform additional checks
against the operation being performed. Example might be checking the
version of the service.
Parameters:
operation - The operation being performed. true if the response can handle the operation,otherwise false |
| getBinding | | final public Class getBinding()(Code) | | The type of object the response can handle. |
| getHeaders | | public String[][] getHeaders(Object value, Operation operation) throws ServiceException(Code) | | Returns a 2xn array of Strings, each of which is an HTTP header pair
to be set on the HTTP Response. Can return null if there are
no headers to be set on the response.
Parameters:
value - The value to serialize
Parameters:
operation - The operation being performed. 2xn string array containing string-pairs of HTTP headers/values |
| getMimeType | | abstract public String getMimeType(Object value, Operation operation) throws ServiceException(Code) | | Returns the mime type to be uses when writing the response.
Parameters:
value - The value to serialize
Parameters:
operation - The operation being performed. The mime type of the response, must not be null |
| getOutputFormats | | final public Set getOutputFormats()(Code) | | Set of common or well-known name for the response, may be empty. |
| write | | abstract public void write(Object value, OutputStream output, Operation operation) throws IOException, ServiceException(Code) | | Serializes value to output.
The operation bean is provided for context.
Parameters:
value - The value to serialize.
Parameters:
output - The output stream.
Parameters:
operation - The operation which resulted in value
throws:
IOException - Any I/O errors that occur
throws:
ServiceException - Any service errors that occur |
|
|