1 /* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
2 *
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 package org.springframework.security.util;
17
18 /**
19 * <code>PortMapper</code> implementations provide callers with information
20 * about which HTTP ports are associated with which HTTPS ports on the system,
21 * and vice versa.
22 *
23 * @author Ben Alex
24 * @version $Id: PortMapper.java 2217 2007-10-27 00:45:30Z luke_t $
25 */
26 public interface PortMapper {
27 //~ Methods ========================================================================================================
28
29 /**
30 * Locates the HTTP port associated with the specified HTTPS port.<P>Returns <code>null</code> if unknown.</p>
31 *
32 * @param httpsPort
33 *
34 * @return the HTTP port or <code>null</code> if unknown
35 */
36 Integer lookupHttpPort(Integer httpsPort);
37
38 /**
39 * Locates the HTTPS port associated with the specified HTTP port.<P>Returns <code>null</code> if unknown.</p>
40 *
41 * @param httpPort
42 *
43 * @return the HTTPS port or <code>null</code> if unknown
44 */
45 Integer lookupHttpsPort(Integer httpPort);
46 }