public class

PortMapperImpl

extends Object
implements PortMapper
java.lang.Object
   ↳ org.springframework.security.web.PortMapperImpl

Class Overview

Concrete implementation of PortMapper that obtains HTTP:HTTPS pairs from the application context.

By default the implementation will assume 80:443 and 8080:8443 are HTTP:HTTPS pairs respectively. If different pairs are required, use setPortMappings(Map).

Summary

Public Constructors
PortMapperImpl()
Public Methods
Map<Integer, Integer> getTranslatedPortMappings()
Returns the translated (Integer -> Integer) version of the original port mapping specified via setHttpsPortMapping()
Integer lookupHttpPort(Integer httpsPort)
Locates the HTTP port associated with the specified HTTPS port.
Integer lookupHttpsPort(Integer httpPort)
Locates the HTTPS port associated with the specified HTTP port.
void setPortMappings(Map<String, String> newMappings)
Set to override the default HTTP port to HTTPS port mappings of 80:443, and 8080:8443.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.security.web.PortMapper

Public Constructors

public PortMapperImpl ()

Public Methods

public Map<Integer, Integer> getTranslatedPortMappings ()

Returns the translated (Integer -> Integer) version of the original port mapping specified via setHttpsPortMapping()

public Integer lookupHttpPort (Integer httpsPort)

Locates the HTTP port associated with the specified HTTPS port.

Returns null if unknown.

Returns
  • the HTTP port or null if unknown

public Integer lookupHttpsPort (Integer httpPort)

Locates the HTTPS port associated with the specified HTTP port.

Returns null if unknown.

Returns
  • the HTTPS port or null if unknown

public void setPortMappings (Map<String, String> newMappings)

Set to override the default HTTP port to HTTPS port mappings of 80:443, and 8080:8443. In a Spring XML ApplicationContext, a definition would look something like this: 

  <property name="portMappings">
      <map>
          <entry key="80"><value>443</value></entry>
          <entry key="8080"><value>8443</value></entry>
      </map>
 </property>

Parameters
newMappings A Map consisting of String keys and String values, where for each entry the key is the string representation of an integer HTTP port number, and the value is the string representation of the corresponding integer HTTPS port number.
Throws
IllegalArgumentException if input map does not consist of String keys and values, each representing an integer port number in the range 1-65535 for that mapping.