View Javadoc

1   //
2   //  ========================================================================
3   //  Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd.
4   //  ------------------------------------------------------------------------
5   //  All rights reserved. This program and the accompanying materials
6   //  are made available under the terms of the Eclipse Public License v1.0
7   //  and Apache License v2.0 which accompanies this distribution.
8   //
9   //      The Eclipse Public License is available at
10  //      http://www.eclipse.org/legal/epl-v10.html
11  //
12  //      The Apache License v2.0 is available at
13  //      http://www.opensource.org/licenses/apache2.0.php
14  //
15  //  You may elect to redistribute this code under either of these licenses.
16  //  ========================================================================
17  //
18  
19  package org.eclipse.jetty.client.api;
20  
21  import java.nio.ByteBuffer;
22  
23  import org.eclipse.jetty.client.util.ByteBufferContentProvider;
24  import org.eclipse.jetty.client.util.PathContentProvider;
25  
26  /**
27   * {@link ContentProvider} provides a repeatable source of request content.
28   * <p />
29   * Implementations should return a new "view" over the same content every time {@link #iterator()} is invoked.
30   * <p />
31   * Applications should rely on utility classes such as {@link ByteBufferContentProvider}
32   * or {@link PathContentProvider}.
33   */
34  public interface ContentProvider extends Iterable<ByteBuffer>
35  {
36      /**
37       * @return the content length, if known, or -1 if the content length is unknown
38       */
39      long getLength();
40  }