View Javadoc

1   /*
2    * Copyright [2007] [University Corporation for Advanced Internet Development, Inc.]
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  
17  package org.opensaml.ws.transport.http;
18  
19  import org.opensaml.ws.transport.OutTransport;
20  
21  /**
22   * HTTP-based outbound transport.
23   */
24  public interface HTTPOutTransport extends OutTransport, HTTPTransport {
25  
26      /**
27       * Sets the HTTP version to use for outgoing messages.
28       * 
29       * @param version HTTP version to use for outgoing messages
30       */
31      public void setVersion(HTTP_VERSION version);
32  
33      /**
34       * Sets the given header with the given value.
35       * 
36       * @param name header name
37       * @param value header value
38       */
39      public void setHeader(String name, String value);
40  
41      /**
42       * Sets the given parameter with the given value.
43       * 
44       * @param name parameter name
45       * @param value parameter value
46       */
47      public void addParameter(String name, String value);
48  
49      /**
50       * Sets the status code for this transport.
51       * 
52       * @param code status code for this transport
53       */
54      public void setStatusCode(int code);
55      
56      /**
57       * Sends an HTTP 3XX redirect message back to the client.
58       * 
59       * @param location location to redirect the client to
60       */
61      public void sendRedirect(String location);
62  }