1 /*
2 * Copyright 2008 Les Hazlewood
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 package org.apache.shiro.web.util;
17
18 import javax.servlet.ServletRequest;
19 import javax.servlet.ServletResponse;
20
21 /**
22 * A {@code RequestPairSource} is a component that can supply a {@link ServletRequest ServletRequest} and
23 * {@link ServletResponse ServletResponse} pair associated with a currently executing request. This is used for
24 * framework development support and is rarely used by end-users.
25 *
26 * @since 1.0
27 */
28 public interface RequestPairSource {
29
30 /**
31 * Returns the incoming {@link ServletRequest ServletRequest} associated with the component.
32 *
33 * @return the incoming {@link ServletRequest ServletRequest} associated with the component.
34 */
35 ServletRequest getServletRequest();
36
37 /**
38 * Returns the outgoing {@link ServletResponse ServletResponse} paired with the incoming
39 * {@link #getServletRequest() servletRequest}.
40 *
41 * @return the outgoing {@link ServletResponse ServletResponse} paired with the incoming
42 * {@link #getServletRequest() servletRequest}.
43 */
44 ServletResponse getServletResponse();
45 }