01: /*
02: * Copyright 2005 Joe Walker
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16: package org.directwebremoting.extend;
17:
18: import java.io.IOException;
19: import java.io.OutputStream;
20:
21: /**
22: * A representation of the file that we are writing out.
23: * @author Joe Walker [joe at getahead dot ltd dot uk]
24: */
25: public interface FileGenerator {
26: /**
27: * Write the file to the give {@link OutputStream}.
28: * The system will take care of opening and closing the stream
29: * @param out The stream to write to.
30: * @throws IOException If there are creation problems
31: */
32: void generateFile(OutputStream out) throws IOException;
33:
34: /**
35: * What is the MimeType for the given file
36: * @return a valid mime-type
37: */
38: String getMimeType();
39:
40: /**
41: * Accessor for the filename of this download
42: * @return An appropriate filename which may have to be some sort of default
43: */
44: String getFilename();
45: }
|