View Javadoc

1   /*******************************************************************************
2    * Copyright (c) 2011 Michael Mimo Moratti.
3    *  
4    * Michael Mimo Moratti licenses this file to you under the Apache License, version 2.0
5    * (the "License"); you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at:
7    *     http://www.apache.org/licenses/LICENSE-2.0
8    * Unless required by applicable law or agreed to in writing, software
9    * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
10   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
11   * License for the specific language governing permissions and limitations
12   * under the License.
13   *******************************************************************************/
14  package ch.mimo.netty.handler.codec.icap;
15  
16  import org.jboss.netty.handler.codec.http.HttpMethod;
17  
18  
19  /**
20   * Defines a ICAP Request.
21   * 
22   * @author Michael Mimo Moratti (mimo@mimo.ch)
23   *
24   * @see IcapMessage
25   * @see DefaultIcapRequest
26   */
27  public interface IcapRequest extends IcapMessage {
28  	
29  	/**
30  	 * Sets the operation method for this icap request.
31  	 * @param method the @see {@link HttpMethod} provided by @see {@link IcapMethod}
32  	 * @return self in order to chain the method calls
33  	 */
34  	IcapMessage setMethod(IcapMethod method);
35  
36  	/**
37  	 * @return This operations method
38  	 */
39  	IcapMethod getMethod();
40  	
41  	/**
42  	 * Sets the operations uri.
43  	 * @param uri 
44  	 * @return self in order to chain the method calls
45  	 */
46  	IcapMessage setUri(String uri);
47  	
48  	/**
49  	 * @return String uri for this message
50  	 */
51  	String getUri();
52  }