2 * Copyright 2001-2009 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file xmltooling/io/HTTPResponse.h
20 * Interface to HTTP responses.
23 #ifndef __xmltooling_httpres_h__
24 #define __xmltooling_httpres_h__
26 #include <xmltooling/io/GenericResponse.h>
28 namespace xmltooling {
31 * Interface to HTTP response.
33 * <p>To supply information to the surrounding web server environment,
34 * a shim must be supplied in the form of this interface to adapt the
35 * library to different proprietary server APIs.
37 * <p>This interface need not be threadsafe.
39 class XMLTOOL_API HTTPResponse : public GenericResponse {
43 virtual ~HTTPResponse();
45 void setContentType(const char* type);
48 * Sets or clears a response header.
50 * @param name header name
51 * @param value value to set, or NULL to clear
53 virtual void setResponseHeader(const char* name, const char* value)=0;
56 * Sets a client cookie.
58 * @param name cookie name
59 * @param value value to set, or NULL to clear
61 virtual void setCookie(const char* name, const char* value);
64 * Redirect the client to the specified URL and complete the response.
65 * Any headers previously set will be sent ahead of the redirect.
67 * @param url location to redirect client
68 * @return a result code to return from the calling MessageEncoder
70 virtual long sendRedirect(const char* url)=0;
72 /** Some common HTTP status codes. */
74 XMLTOOLING_HTTP_STATUS_OK = 200,
75 XMLTOOLING_HTTP_STATUS_MOVED = 302,
76 XMLTOOLING_HTTP_STATUS_UNAUTHORIZED = 401,
77 XMLTOOLING_HTTP_STATUS_FORBIDDEN = 403,
78 XMLTOOLING_HTTP_STATUS_NOTFOUND = 404,
79 XMLTOOLING_HTTP_STATUS_ERROR = 500
82 long sendError(std::istream& inputStream);
84 using GenericResponse::sendResponse;
85 long sendResponse(std::istream& inputStream);
89 #endif /* __xmltooling_httpres_h__ */