2 * Copyright 2001-2006 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 saml/binding/HTTPResponse.h
20 * Interface to HTTP requests
23 #ifndef __saml_httpres_h__
24 #define __saml_httpres_h__
26 #include <saml/binding/GenericResponse.h>
31 * Interface to caller-supplied shim for issuing an 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 SAML_API HTTPResponse : public GenericResponse {
40 MAKE_NONCOPYABLE(HTTPResponse);
44 virtual ~HTTPResponse() {}
47 * Sets or clears a response header.
49 * @param name header name
50 * @param value value to set, or NULL to clear
52 virtual void setHeader(const char* name, const char* value)=0;
55 * Sets a client cookie.
57 * @param name cookie name
58 * @param value value to set, or NULL to clear
60 virtual void setCookie(const char* name, const char* value)=0;
63 * Redirect the client to the specified URL and complete the response.
64 * Any headers previously set will be sent ahead of the redirect.
66 * @param url location to redirect client
67 * @return a result code to return from the calling MessageEncoder
69 virtual long sendRedirect(const char* url)=0;
71 /** Some common HTTP status codes. */
73 SAML_HTTP_STATUS_OK = 200,
74 SAML_HTTP_STATUS_MOVED = 302
79 #endif /* __saml_httpres_h__ */