2009-02-12 07:09:29 +01:00
|
|
|
/*
|
2009-08-28 09:15:49 +02:00
|
|
|
* Copyright 2009 Red Hat, Inc.
|
2009-02-12 07:09:29 +01:00
|
|
|
*
|
2009-08-28 09:15:49 +02:00
|
|
|
* Red Hat licenses this file to you under the Apache License, version 2.0
|
|
|
|
* (the "License"); you may not use this file except in compliance with the
|
|
|
|
* License. You may obtain a copy of the License at:
|
2009-02-12 07:09:29 +01:00
|
|
|
*
|
2009-08-28 09:15:49 +02:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2009-02-12 07:09:29 +01:00
|
|
|
*
|
2009-08-28 09:15:49 +02:00
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
|
|
* License for the specific language governing permissions and limitations
|
|
|
|
* under the License.
|
2009-02-12 07:09:29 +01:00
|
|
|
*/
|
2011-12-09 04:38:59 +01:00
|
|
|
package io.netty.handler.codec.http;
|
2009-02-12 07:09:29 +01:00
|
|
|
|
2009-11-17 06:12:55 +01:00
|
|
|
import java.util.Collections;
|
|
|
|
import java.util.List;
|
2010-01-08 09:29:37 +01:00
|
|
|
import java.util.Map;
|
2009-11-17 06:12:55 +01:00
|
|
|
import java.util.Set;
|
|
|
|
|
2011-12-09 04:38:59 +01:00
|
|
|
import io.netty.buffer.ChannelBuffer;
|
|
|
|
import io.netty.buffer.ChannelBuffers;
|
|
|
|
import io.netty.channel.ChannelPipeline;
|
2009-02-12 07:09:29 +01:00
|
|
|
|
|
|
|
/**
|
2009-06-19 17:01:47 +02:00
|
|
|
* An HTTP chunk which is used for HTTP chunked transfer-encoding.
|
2009-07-17 14:49:32 +02:00
|
|
|
* {@link HttpMessageDecoder} generates {@link HttpChunk} after
|
|
|
|
* {@link HttpMessage} when the content is large or the encoding of the content
|
|
|
|
* is 'chunked. If you prefer not to receive {@link HttpChunk} in your handler,
|
|
|
|
* please {@link HttpChunkAggregator} after {@link HttpMessageDecoder} in the
|
|
|
|
* {@link ChannelPipeline}.
|
2009-07-20 05:37:35 +02:00
|
|
|
* @apiviz.landmark
|
2009-02-12 07:09:29 +01:00
|
|
|
*/
|
|
|
|
public interface HttpChunk {
|
2009-03-09 09:50:24 +01:00
|
|
|
|
2009-06-19 16:49:26 +02:00
|
|
|
/**
|
2009-11-17 05:16:24 +01:00
|
|
|
* The 'end of content' marker in chunked encoding.
|
2009-06-19 16:49:26 +02:00
|
|
|
*/
|
2011-11-06 17:54:21 +01:00
|
|
|
HttpChunkTrailer LAST_CHUNK = new HttpChunkTrailer() {
|
2010-11-12 01:45:39 +01:00
|
|
|
@Override
|
2009-11-17 05:58:49 +01:00
|
|
|
public ChannelBuffer getContent() {
|
|
|
|
return ChannelBuffers.EMPTY_BUFFER;
|
|
|
|
}
|
|
|
|
|
2010-11-12 01:45:39 +01:00
|
|
|
@Override
|
2009-11-20 05:12:16 +01:00
|
|
|
public void setContent(ChannelBuffer content) {
|
|
|
|
throw new IllegalStateException("read-only");
|
|
|
|
}
|
|
|
|
|
2010-11-12 01:45:39 +01:00
|
|
|
@Override
|
2009-11-17 05:58:49 +01:00
|
|
|
public boolean isLast() {
|
|
|
|
return true;
|
|
|
|
}
|
2009-11-17 06:12:55 +01:00
|
|
|
|
2010-11-12 01:45:39 +01:00
|
|
|
@Override
|
2010-01-26 05:31:54 +01:00
|
|
|
public void addHeader(String name, Object value) {
|
2009-11-17 06:12:55 +01:00
|
|
|
throw new IllegalStateException("read-only");
|
|
|
|
}
|
|
|
|
|
2010-11-12 01:45:39 +01:00
|
|
|
@Override
|
2009-11-17 06:12:55 +01:00
|
|
|
public void clearHeaders() {
|
|
|
|
// NOOP
|
|
|
|
}
|
|
|
|
|
2010-11-12 01:45:39 +01:00
|
|
|
@Override
|
2009-11-17 06:12:55 +01:00
|
|
|
public boolean containsHeader(String name) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2010-11-12 01:45:39 +01:00
|
|
|
@Override
|
2009-11-17 06:12:55 +01:00
|
|
|
public String getHeader(String name) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
2010-11-12 01:45:39 +01:00
|
|
|
@Override
|
2009-11-17 06:12:55 +01:00
|
|
|
public Set<String> getHeaderNames() {
|
|
|
|
return Collections.emptySet();
|
|
|
|
}
|
|
|
|
|
2010-11-12 01:45:39 +01:00
|
|
|
@Override
|
2009-11-17 06:12:55 +01:00
|
|
|
public List<String> getHeaders(String name) {
|
|
|
|
return Collections.emptyList();
|
|
|
|
}
|
|
|
|
|
2010-11-12 01:45:39 +01:00
|
|
|
@Override
|
2010-01-08 09:29:37 +01:00
|
|
|
public List<Map.Entry<String, String>> getHeaders() {
|
|
|
|
return Collections.emptyList();
|
|
|
|
}
|
|
|
|
|
2010-11-12 01:45:39 +01:00
|
|
|
@Override
|
2009-11-17 06:12:55 +01:00
|
|
|
public void removeHeader(String name) {
|
|
|
|
// NOOP
|
|
|
|
}
|
|
|
|
|
2010-11-12 01:45:39 +01:00
|
|
|
@Override
|
2010-01-26 05:31:54 +01:00
|
|
|
public void setHeader(String name, Object value) {
|
2009-11-17 06:12:55 +01:00
|
|
|
throw new IllegalStateException("read-only");
|
|
|
|
}
|
|
|
|
|
2010-11-12 01:45:39 +01:00
|
|
|
@Override
|
2010-01-26 05:31:54 +01:00
|
|
|
public void setHeader(String name, Iterable<?> values) {
|
2009-11-17 06:12:55 +01:00
|
|
|
throw new IllegalStateException("read-only");
|
|
|
|
}
|
2009-11-17 05:58:49 +01:00
|
|
|
};
|
2009-03-09 09:50:24 +01:00
|
|
|
|
2009-06-19 16:49:26 +02:00
|
|
|
/**
|
|
|
|
* Returns {@code true} if and only if this chunk is the 'end of content'
|
|
|
|
* marker.
|
|
|
|
*/
|
2009-02-12 07:09:29 +01:00
|
|
|
boolean isLast();
|
2009-06-19 16:49:26 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the content of this chunk. If this is the 'end of content'
|
2009-11-17 05:59:33 +01:00
|
|
|
* marker, {@link ChannelBuffers#EMPTY_BUFFER} will be returned.
|
2009-06-19 16:49:26 +02:00
|
|
|
*/
|
2009-02-12 07:09:29 +01:00
|
|
|
ChannelBuffer getContent();
|
2009-11-20 05:12:16 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the content of this chunk. If an empty buffer is specified,
|
|
|
|
* this chunk becomes the 'end of content' marker.
|
|
|
|
*/
|
|
|
|
void setContent(ChannelBuffer content);
|
2009-02-12 07:09:29 +01:00
|
|
|
}
|