|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IcapMessage
An ICAP message that contains common operations for @see IcapRequest
and @see IcapResponse
.
Method Summary | |
---|---|
IcapMessage |
addHeader(String name,
Object value)
Adds a new header with the specified name and value. |
IcapMessage |
clearHeaders()
Removes all headers from this message. |
boolean |
containsHeader(String name)
|
boolean |
containsHttpRequest()
|
boolean |
containsHttpResponse()
|
IcapMessageElementEnum |
getBodyType()
|
Encapsulated |
getEncapsulatedHeader()
|
String |
getHeader(String name)
Returns the header value with the specified header name. |
Set<String> |
getHeaderNames()
|
Set<Map.Entry<String,String>> |
getHeaders()
Returns the all header names and values that this message contains. |
Set<String> |
getHeaders(String name)
Returns the header values with the specified header name. |
org.jboss.netty.handler.codec.http.HttpRequest |
getHttpRequest()
|
org.jboss.netty.handler.codec.http.HttpResponse |
getHttpResponse()
|
int |
getPreviewAmount()
|
IcapVersion |
getProtocolVersion()
|
boolean |
isPreviewMessage()
|
IcapMessage |
removeHeader(String name)
Removes the header with the specified name. |
IcapMessage |
setBody(IcapMessageElementEnum body)
Sets the indication that this icap message contains a body of some kind. |
IcapMessage |
setEncapsulatedHeader(Encapsulated encapsulated)
Sets the @see Encapsulated Encapsulation header for this message |
IcapMessage |
setHeader(String name,
Iterable<?> values)
Sets a new header with the specified name and values. |
IcapMessage |
setHeader(String name,
Object value)
Sets a new header with the specified name and value. |
IcapMessage |
setHttpRequest(org.jboss.netty.handler.codec.http.HttpRequest httpRequest)
|
IcapMessage |
setHttpResponse(org.jboss.netty.handler.codec.http.HttpResponse response)
Adds a @see HttpResponse to the Icap message. |
IcapMessage |
setProtocolVersion(IcapVersion version)
Sets the protocol version of this message. |
Method Detail |
---|
String getHeader(String name)
null
if there is no such headerSet<String> getHeaders(String name)
List
of header values. An empty list if there is no
such header.Set<Map.Entry<String,String>> getHeaders()
List
of the header name-value pairs. An empty list
if there is no header in this message.boolean containsHeader(String name)
name
- header name
true
if and only if there is a header with the specified
header name.Set<String> getHeaderNames()
Set
of all header names that this message contains.IcapMessage addHeader(String name, Object value)
name
- header namevalue
- for the given name
IcapMessage setHeader(String name, Object value)
name
- header namevalue
- for the given name
IcapMessage setHeader(String name, Iterable<?> values)
name
- header namevalues
- for the given name
IcapMessage removeHeader(String name)
int getPreviewAmount()
Integer
preview header value.IcapMessage clearHeaders()
IcapVersion getProtocolVersion()
IcapMessage setProtocolVersion(IcapVersion version)
version
- @see IcapVersion
boolean isPreviewMessage()
boolean containsHttpRequest()
org.jboss.netty.handler.codec.http.HttpRequest getHttpRequest()
HttpRequest
IcapMessage setHttpRequest(org.jboss.netty.handler.codec.http.HttpRequest httpRequest)
httpRequest
-
boolean containsHttpResponse()
org.jboss.netty.handler.codec.http.HttpResponse getHttpResponse()
HttpResponse
IcapMessage setHttpResponse(org.jboss.netty.handler.codec.http.HttpResponse response)
HttpResponse
to the Icap message.
response
- the @see HttpResponse
IcapMessage setEncapsulatedHeader(Encapsulated encapsulated)
Encapsulated
Encapsulation header for this message
encapsulated
- @see Encapsulated
instance
Encapsulated getEncapsulatedHeader()
Encapsulated
Encapsulated header valueIcapMessage setBody(IcapMessageElementEnum body)
body
- @see IcapMessageElementEnum
IcapMessageElementEnum getBodyType()
IcapMessageElementEnum
message body indicator.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |