View Javadoc

    1   /* Copyright 2004 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.acegisecurity.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,v 1.2 2005/11/17 00:56:09 benalex Exp $
    25   */
    26  public interface PortMapper {
    27      //~ Methods ================================================================
    28
    29      /***
    30       * Locates the HTTP port associated with the specified HTTPS port.
    31       *
    32       * <P>
    33       * Returns <code>null</code> if unknown.
    34       * </p>
    35       *
    36       * @param httpsPort
    37       *
    38       * @return the HTTP port or <code>null</code> if unknown
    39       */
    40      public Integer lookupHttpPort(Integer httpsPort);
    41
    42      /***
    43       * Locates the HTTPS port associated with the specified HTTP port.
    44       *
    45       * <P>
    46       * Returns <code>null</code> if unknown.
    47       * </p>
    48       *
    49       * @param httpPort
    50       *
    51       * @return the HTTPS port or <code>null</code> if unknown
    52       */
    53      public Integer lookupHttpsPort(Integer httpPort);
    54  }