SitemapOutputComponent


1   /*
2    * Copyright 1999-2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
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.apache.cocoon.sitemap;
17  
18  import org.apache.avalon.framework.component.Component;
19  
20  import java.io.IOException  ;
21  import java.io.OutputStream  ;
22  
23  /**
24   * This interface marks a component as a sitemap component that produces
25   * a response, like a serializer or a reader.
26   * 
27   * @author <a HREF="mailto:Giacomo.Pati@pwr.ch">Giacomo Pati</a>
28   * @author <a HREF="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
29   * @version CVS $Id: SitemapOutputComponent.java 30932 2004-07-29 17:35:38Z vgritsenko $
30   */
31  public interface SitemapOutputComponent extends Component {
32  
33      /**
34       * Set the {@link OutputStream} where the requested resource should
35       * be serialized.
36       */
37      void setOutputStream(OutputStream   out) throws IOException  ;
38  
39      /**
40       * Get the mime-type of the output of this <code>Component</code>.
41       */
42      String   getMimeType();
43  
44      /**
45       * Test if the component wants to set the content length
46       */
47      boolean shouldSetContentLength();
48  }
49

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags