| org.geotools.data.ows.Request
All known Subclasses: org.geotools.data.ows.AbstractRequest,
| Request | | public interface Request (Code) | | This represents a Request to be made against a Open Web Service.
author:
rgould |
| Method Summary | |
| Response | createResponse(String contentType, InputStream inputStream)
Each Request must know how to create it's counterpart Response. | | public URL | getFinalURL()
Once the properties of the request are configured, this will return
the URL that points to the server and contains all of the appropriate
name/value parameters. | | String | getPostContentType()
If this request uses POST, it must specify the content type of the data
that is to be written out during performPostOutput(). | | public Properties | getProperties()
| | void | performPostOutput(OutputStream outputStream)
This is called during the connection to the server, allowing this
request to write out data to the server by using the provided
outputStream.
Implementors of this method do not need to call outputStream.flush() or
outputStream.close(). | | boolean | requiresPost()
This method indicates whether this request needs to transmit some data
to the server using POST. | | public void | setProperty(String name, String value)
Sets the name/value property for this request.
Note that when using this method, it is up to the programmer to
provide their own encoding of value according to the
OWS specifications! The code will not do this for you. |
| REQUEST | | final public static String REQUEST(Code) | | Represents the REQUEST parameter
|
| VERSION | | final public static String VERSION(Code) | | Represents the VERSION parameter
|
| WMTVER | | final public static String WMTVER(Code) | | Represents the WMTVER parameter
|
| createResponse | | Response createResponse(String contentType, InputStream inputStream) throws ServiceException, IOException(Code) | | Each Request must know how to create it's counterpart Response.
Given the content type and input stream (containin the response data),
this method must return an appropriate Response object.
Parameters:
contentType - the MIME type of the data in the inputStream
Parameters:
inputStream - contains the data from the response
throws:
ServiceException -
throws:
IOException - |
| getFinalURL | | public URL getFinalURL()(Code) | | Once the properties of the request are configured, this will return
the URL that points to the server and contains all of the appropriate
name/value parameters.
a URL that can be used to issue the request |
| getPostContentType | | String getPostContentType()(Code) | | If this request uses POST, it must specify the content type of the data
that is to be written out during performPostOutput().
For open web services, this is usually "application/xml".
the MIME type of the data to be sent during the request |
| getProperties | | public Properties getProperties()(Code) | | a copy of this request's properties |
| performPostOutput | | void performPostOutput(OutputStream outputStream) throws IOException(Code) | | This is called during the connection to the server, allowing this
request to write out data to the server by using the provided
outputStream.
Implementors of this method do not need to call outputStream.flush() or
outputStream.close(). The framework will call them immediately after
calling this method.
Parameters:
outputStream - |
| requiresPost | | boolean requiresPost()(Code) | | This method indicates whether this request needs to transmit some data
to the server using POST. If this returns true, performPostOutput() will be called
during the connection, allowing the data to be written out to the server.
true if this request needs POST support, false otherwise. |
| setProperty | | public void setProperty(String name, String value)(Code) | | Sets the name/value property for this request.
Note that when using this method, it is up to the programmer to
provide their own encoding of value according to the
OWS specifications! The code will not do this for you.
Different OWS specifications define different ways to do this. There are
notorious differences between WMS 1.1.1 (section 6.2.1) and
WMS 1.3.0 (section 6.3.2) for example.
If value is null, "name" is removed from the properties table.
Parameters:
name - the name of the property
Parameters:
value - the value of the property |
|
|