PortMapper (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.util.PortMapper

```
public class PortMapper
extends Object
```
Map services to internal or external application ports for this context. Not intended for the router's NTCP or SSU ports.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_CONSOLE_PORT` Default HTTP console port.
`static String`	`DEFAULT_HOST` Default host for local services.
`static int`	`DEFAULT_HTTPS_CONSOLE_PORT` Default HTTPS console port.
`static String`	`PROP_PREFER_HTTPS` Property to prefer HTTPS
`static String`	`SVC_BOB` BOB service
`static String`	`SVC_CONSOLE` Console service
`static String`	`SVC_EEPSITE` Eepsite service
`static String`	`SVC_HTTP_I2PCONTROL` HTTP I2PControl service name.
`static String`	`SVC_HTTP_PROXY` HTTP proxy service
`static String`	`SVC_HTTPS_CONSOLE` HTTPS console service
`static String`	`SVC_HTTPS_EEPSITE` HTTPS eepsite service name.
`static String`	`SVC_HTTPS_I2PCONTROL` HTTPS I2PControl service name.
`static String`	`SVC_HTTPS_PROXY` HTTPS proxy service
`static String`	`SVC_I2CP` not necessary, already in config?
`static String`	`SVC_I2CP_SSL` I2CP-SSL service name.
`static String`	`SVC_I2PSNARK` To indicate presence, alternative to WebAppStarter.isWebappRunning().
`static String`	`SVC_I2PTUNNEL` To indicate presence, alternative to WebAppStarter.isWebappRunning().
`static String`	`SVC_IMAGEGEN` To indicate presence, alternative to WebAppStarter.isWebappRunning().
`static String`	`SVC_IRC` IRC service
`static String`	`SVC_JSONRPC` To indicate presence, alternative to WebAppStarter.isWebappRunning().
`static String`	`SVC_POP` POP3 service
`static String`	`SVC_SAM` SAM service
`static String`	`SVC_SAM_SSL` SAM-SSL service name.
`static String`	`SVC_SAM_UDP` SAM-UDP service name.
`static String`	`SVC_SMTP` SMTP service
`static String`	`SVC_SOCKS` SOCKS service
`static String`	`SVC_SUSIDNS` To indicate presence, alternative to WebAppStarter.isWebappRunning().
`static String`	`SVC_SUSIMAIL` To indicate presence, alternative to WebAppStarter.isWebappRunning().
`static String`	`SVC_TAHOE` Tahoe-LAFS service

Constructor Summary
Constructors
Constructor and Description
PortMapper(I2PAppContext context)
Create a port mapper

Constructors
Constructor and Description
`PortMapper(I2PAppContext context)` Create a port mapper

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getActualHost(String service, String def)` Get the actual host for a service.
`String`	`getConsoleURL()` If PROP_PREFER_HTTPS is true or unset, return https URL unless console is http only.
`String`	`getConsoleURL(boolean preferHTTPS)` If preferHTTPS is true, return https URL unless console is http only.
`List<String>`	`getEepsiteURLs()` Get the list of eepsite URLs.
`String`	`getHost(String service, String def)` Get the registered host for a service.
`int`	`getPort(String service)` Get the registered port for a service
`int`	`getPort(String service, int def)` Get the registered port for a service
`boolean`	`isRegistered(String service)` Is the service registered?
`boolean`	`register(String service, int port)` Add the service
`boolean`	`register(String service, String host, int port)` Add the service.
`void`	`renderStatusHTML(Writer out)` For debugging only
`void`	`unregister(String service)` Remove the service
`void`	`unregister(String service, int port)` Remove the service, only if it is registered with the supplied port.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_CONSOLE_PORT
```
public static final int DEFAULT_CONSOLE_PORT
```
    Default HTTP console port.
    See Also:
    Constant Field Values
  - DEFAULT_HOST
```
public static final String DEFAULT_HOST
```
    Default host for local services.
    See Also:
    Constant Field Values
  - DEFAULT_HTTPS_CONSOLE_PORT
```
public static final int DEFAULT_HTTPS_CONSOLE_PORT
```
    Default HTTPS console port.
    See Also:
    Constant Field Values
  - PROP_PREFER_HTTPS
```
public static final String PROP_PREFER_HTTPS
```
    Property to prefer HTTPS
    See Also:
    Constant Field Values
  - SVC_BOB
```
public static final String SVC_BOB
```
    BOB service
    See Also:
    Constant Field Values
  - SVC_CONSOLE
```
public static final String SVC_CONSOLE
```
    Console service
    See Also:
    Constant Field Values
  - SVC_EEPSITE
```
public static final String SVC_EEPSITE
```
    Eepsite service
    See Also:
    Constant Field Values
  - SVC_HTTP_I2PCONTROL
```
public static final String SVC_HTTP_I2PCONTROL
```
    HTTP I2PControl service name.
    See Also:
    Constant Field Values
  - SVC_HTTP_PROXY
```
public static final String SVC_HTTP_PROXY
```
    HTTP proxy service
    See Also:
    Constant Field Values
  - SVC_HTTPS_CONSOLE
```
public static final String SVC_HTTPS_CONSOLE
```
    HTTPS console service
    See Also:
    Constant Field Values
  - SVC_HTTPS_EEPSITE
```
public static final String SVC_HTTPS_EEPSITE
```
    HTTPS eepsite service name.
    See Also:
    Constant Field Values
  - SVC_HTTPS_I2PCONTROL
```
public static final String SVC_HTTPS_I2PCONTROL
```
    HTTPS I2PControl service name.
    See Also:
    Constant Field Values
  - SVC_HTTPS_PROXY
```
public static final String SVC_HTTPS_PROXY
```
    HTTPS proxy service
    See Also:
    Constant Field Values
  - SVC_I2CP
```
public static final String SVC_I2CP
```
    not necessary, already in config?
    See Also:
    Constant Field Values
  - SVC_I2CP_SSL
```
public static final String SVC_I2CP_SSL
```
    I2CP-SSL service name.
    See Also:
    Constant Field Values
  - SVC_I2PSNARK
```
public static final String SVC_I2PSNARK
```
    To indicate presence, alternative to WebAppStarter.isWebappRunning(). For actual base URL, use getConsoleURL()
    See Also:
    Constant Field Values
  - SVC_I2PTUNNEL
```
public static final String SVC_I2PTUNNEL
```
    To indicate presence, alternative to WebAppStarter.isWebappRunning(). For actual base URL, use getConsoleURL() Note: This is only the webapp. Also requires TCG running to be useful. The webapp does not start TCG.
    See Also:
    Constant Field Values
  - SVC_IMAGEGEN
```
public static final String SVC_IMAGEGEN
```
    To indicate presence, alternative to WebAppStarter.isWebappRunning(). For actual base URL, use getConsoleURL()
    See Also:
    Constant Field Values
  - SVC_IRC
```
public static final String SVC_IRC
```
    IRC service
    See Also:
    Constant Field Values
  - SVC_JSONRPC
```
public static final String SVC_JSONRPC
```
    To indicate presence, alternative to WebAppStarter.isWebappRunning(). For actual base URL, use getConsoleURL()
    See Also:
    Constant Field Values
  - SVC_POP
```
public static final String SVC_POP
```
    POP3 service
    See Also:
    Constant Field Values
  - SVC_SAM
```
public static final String SVC_SAM
```
    SAM service
    See Also:
    Constant Field Values
  - SVC_SAM_SSL
```
public static final String SVC_SAM_SSL
```
    SAM-SSL service name.
    See Also:
    Constant Field Values
  - SVC_SAM_UDP
```
public static final String SVC_SAM_UDP
```
    SAM-UDP service name.
    See Also:
    Constant Field Values
  - SVC_SMTP
```
public static final String SVC_SMTP
```
    SMTP service
    See Also:
    Constant Field Values
  - SVC_SOCKS
```
public static final String SVC_SOCKS
```
    SOCKS service
    See Also:
    Constant Field Values
  - SVC_SUSIDNS
```
public static final String SVC_SUSIDNS
```
    To indicate presence, alternative to WebAppStarter.isWebappRunning(). For actual base URL, use getConsoleURL()
    See Also:
    Constant Field Values
  - SVC_SUSIMAIL
```
public static final String SVC_SUSIMAIL
```
    To indicate presence, alternative to WebAppStarter.isWebappRunning(). For actual base URL, use getConsoleURL()
    See Also:
    Constant Field Values
  - SVC_TAHOE
```
public static final String SVC_TAHOE
```
    Tahoe-LAFS service
    See Also:
    Constant Field Values
- Constructor Detail
  - PortMapper
```
public PortMapper(I2PAppContext context)
```
    Create a port mapper
    Parameters:
    context - unused for now
- Method Detail
  - getActualHost
```
public String getActualHost(String service,
                            String def)
```
    Get the actual host for a service. Will return "127.0.0.1" if the service was registered without a host. If the service was registered with the host "0.0.0.0", "::", or "0:0:0:0:0:0:0:0", it will return a public IP if we have one, else a local IP if we have one, else def. If it was not registered with a wildcard address, it will return the registered host.
    Parameters:
    def - default
    Returns:
    def if not registered
  - getConsoleURL
```
public String getConsoleURL()
```
    If PROP_PREFER_HTTPS is true or unset, return https URL unless console is http only. Default https://127.0.0.1:7667/ If PROP_PREFER_HTTPS is set to false, return http URL unless console is https only. Default http://127.0.0.1:7657/
    Returns:
    the console u r l
  - getConsoleURL
```
public String getConsoleURL(boolean preferHTTPS)
```
    If preferHTTPS is true, return https URL unless console is http only. Default https://127.0.0.1:7667/ If preferHTTPS is false, return http URL unless console is https only. Default http://127.0.0.1:7657/
    Returns:
    the console u r l
  - getEepsiteURLs
```
public List<String> getEepsiteURLs()
```
    Get the list of eepsite URLs.
    Returns:
    unsorted, non-empty, or null if none
  - getHost
```
public String getHost(String service,
                      String def)
```
    Get the registered host for a service. Will return "127.0.0.1" if the service was registered without a host.
    Parameters:
    def - default
    Returns:
    def if not registered
  - getPort
```
public int getPort(String service)
```
    Get the registered port for a service
    Parameters:
    service - the service name
    Returns:
    -1 if not registered
  - getPort
```
public int getPort(String service,
                   int def)
```
    Get the registered port for a service
    Parameters:
    service - the service name
    def - default
    Returns:
    def if not registered
  - isRegistered
```
public boolean isRegistered(String service)
```
    Is the service registered?
    Parameters:
    service - the service name
    Returns:
    true if registered
  - register
```
public boolean register(String service,
                        int port)
```
    Add the service
    Parameters:
    service - the service name
    port - > 0
    Returns:
    success, false if already registered
  - register
```
public boolean register(String service,
                        String host,
                        int port)
```
    Add the service. If service is SVC_EEPSITE or SVC_HTTPS_EEPSITE, the URL will be included in getEepsites()
    Parameters:
    service - the service name
    host - the hostname
    port - > 0
    Returns:
    success, false if already registered
  - renderStatusHTML
```
public void renderStatusHTML(Writer out)
                      throws IOException
```
    For debugging only
    Throws:
    IOException
  - unregister
```
public void unregister(String service)
```
    Remove the service
    Parameters:
    service - the service name
  - unregister
```
public void unregister(String service,
                       int port)
```
    Remove the service, only if it is registered with the supplied port. If service is SVC_EEPSITE or SVC_HTTPS_EEPSITE, the URL will be removed from getEepsites()
    Parameters:
    service - the service name
    port - the port number

Class PortMapper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CONSOLE_PORT

DEFAULT_HOST

DEFAULT_HTTPS_CONSOLE_PORT

PROP_PREFER_HTTPS

SVC_BOB

SVC_CONSOLE

SVC_EEPSITE

SVC_HTTP_I2PCONTROL

SVC_HTTP_PROXY

SVC_HTTPS_CONSOLE

SVC_HTTPS_EEPSITE

SVC_HTTPS_I2PCONTROL

SVC_HTTPS_PROXY

SVC_I2CP

SVC_I2CP_SSL

SVC_I2PSNARK

SVC_I2PTUNNEL

SVC_IMAGEGEN

SVC_IRC

SVC_JSONRPC

SVC_POP

SVC_SAM

SVC_SAM_SSL

SVC_SAM_UDP

SVC_SMTP

SVC_SOCKS

SVC_SUSIDNS

SVC_SUSIMAIL

SVC_TAHOE

Constructor Detail

PortMapper

Method Detail

getActualHost

getConsoleURL

getConsoleURL

getEepsiteURLs

getHost

getPort

getPort

isRegistered

register

register

renderStatusHTML

unregister

unregister