1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.container

File Response.java

 

Code metrics

0
0
0
1
55
9
0
-
-
0
-

Classes

Class Line # Actions
Response 30 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.container;
21   
22    import java.io.IOException;
23    import java.io.OutputStream;
24   
25    /**
26    * Represents a server response.
27    *
28    * @version $Id: 4d1594bc515bf1741850ce3d759c27a0bd06e490 $
29    */
 
30    public interface Response
31    {
32    /**
33    * Returns an OutputStream suitable for writing binary data in the response.
34    *
35    * @return the binary OutputStream for the response, or {@code null} if the response does not allow writing data
36    * @throws IOException if an output exception occurred
37    */
38    OutputStream getOutputStream() throws IOException;
39   
40    /**
41    * Sets the length of the content body in the response. If this length is not relevant to the type of connection, it
42    * will simply be ignored.
43    *
44    * @param length an integer specifying the length of the content being returned to the client
45    */
46    void setContentLength(int length);
47   
48    /**
49    * Sets the content type of the response being sent to the client, as a MIME type string. For example, {@code
50    * text/html}. If the MIME type is not relevant to the type of connection, it will simply be ignored.
51    *
52    * @param mimeType the MIME type for this response, according to the RFC 2045.
53    */
54    void setContentType(String mimeType);
55    }