Class UPnPPlugin

java.lang.Object

com.biglybt.plugin.upnp.UPnPPlugin

All Implemented Interfaces:

AEDiagnosticsEvidenceGenerator, UPnPWANConnectionListener, UPnPListener, Plugin, UPnPMappingListener

public class UPnPPlugin
extends Object
implements Plugin, UPnPListener, UPnPMappingListener, UPnPWANConnectionListener, AEDiagnosticsEvidenceGenerator

Field Summary

Fields

Modifier and Type	Field	Description
private BooleanParameter	alert_device_probs_param
private BooleanParameter	alert_other_port_param
private BooleanParameter	alert_success_param
private StringParameter	desc_prefix_param
private BooleanParameter	grab_ports_param
private BooleanParameter	ignore_bad_devices
private LabelParameter	ignored_devices_list
private LoggerChannel	log
private Map<String,String>	log_no_repeat_map
private UPnPMappingManager	mapping_manager
private CopyOnWriteList<UPnPMapping>	mappings_cow
private StringParameter	nat_pmp_router
private NatPMPUPnP	nat_pmp_upnp
private BooleanParameter	natpmp_enable_param
private static final String	NATPMP_PLUGIN_CONFIGSECTION_ID
private PluginInterface	plugin_interface
private BooleanParameter	release_mappings_param
private Map<URL,String>	root_info_map
private StringParameter	selected_addresses_param
private StringParameter	selected_interfaces_param
private CopyOnWriteList<UPnPPluginService>	services_cow
private static final String	STATS_DISCOVER
private static final String	STATS_FOUND
private static final String[]	STATS_KEYS
private static final String	STATS_MAP_BAD
private static final String	STATS_MAP_OK
private static final String	STATS_READ_BAD
private static final String	STATS_READ_OK
protected AEMonitor	this_mon
private BooleanParameter	trace_to_log
private UPnP	upnp
private BooleanParameter	upnp_enable_param
private UPnPLogListener	upnp_log_listener
private static final String	UPNP_PLUGIN_CONFIGSECTION_ID

Constructor Summary

Constructors

Constructor	Description
UPnPPlugin()

Method Summary

Modifier and Type	Method	Description
protected void	addMapping(UPnPMapping mapping)
UPnPMapping	addMapping(String desc_resource, boolean tcp, int port, boolean enabled)
protected void	addService(UPnPWANConnection wan_service)
protected void	addService(UPnPWANIPv6FirewallControl firewall_service)
protected boolean	checkDeviceStats(UPnPRootDevice root)
protected boolean	checkDeviceStats(String USN, URL location)
protected void	checkState()
protected void	closeDown(boolean end_of_day)
boolean	deviceDiscovered(String USN, URL location)
void	generate(IndentWriter writer)
protected long	getDeviceStats(String USN, String stat_key)
String[]	getExternalIPAddresses()
UPnPMapping	getMapping(boolean tcp, int port)
UPnPMapping[]	getMappings()
protected String[]	getSelectedAddresses()
protected String[]	getSelectedInterfaces()
protected static String[]	getSelectedInterfaces(String si)
UPnPPluginService[]	getServices()
UPnPPluginService[]	getServices(UPnPDevice device)
protected void	ignoreDevice(String USN, URL location)
protected long	incrementDeviceStats(String USN, String stat_key)
void	initialize(PluginInterface _plugin_interface)	This method is called when the Plugin is loaded by the client
boolean	isEnabled()
static void	load(PluginInterface plugin_interface)
protected void	logAlert(int type, String resource, String[] params)
protected void	logNoRepeat(String usn, URL location, String msg, String suffix)
void	mappingChanged(UPnPMapping mapping)
void	mappingDestroyed(UPnPMapping mapping)
void	mappingResult(UPnPWANConnection connection, boolean ok)
void	mappingsReadResult(UPnPWANConnection connection, boolean ok)
protected int	processDevice(UPnPDevice device)
protected int	processServices(UPnPDevice device, UPnPService[] device_services)
void	refreshMappings()	Provided for use by other plugins.
void	refreshMappings(boolean force)	Provided for use by other plugins.
protected void	removeService(UPnPWANConnection wan_service, boolean replaced)
protected void	removeService(UPnPWANIPv6FirewallControl firewall_service, boolean replaced)
void	rootDeviceFound(UPnPRootDevice device)
protected void	setDeviceStats(String USN, String stat_key, long value)
protected void	setNATPMPEnableState()
protected void	startUp()
protected void	updateIgnoreList()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Plugin

getInitialProperties

Methods inherited from interface UPnPListener

deviceStatusUpdate

Field Details

UPNP_PLUGIN_CONFIGSECTION_ID

private static final String UPNP_PLUGIN_CONFIGSECTION_ID

See Also:

• Constant Field Values

NATPMP_PLUGIN_CONFIGSECTION_ID

private static final String NATPMP_PLUGIN_CONFIGSECTION_ID

See Also:

• Constant Field Values

STATS_DISCOVER

private static final String STATS_DISCOVER

See Also:

• Constant Field Values

STATS_FOUND

private static final String STATS_FOUND

See Also:

• Constant Field Values

STATS_READ_OK

private static final String STATS_READ_OK

See Also:

• Constant Field Values

STATS_READ_BAD

private static final String STATS_READ_BAD

See Also:

• Constant Field Values

STATS_MAP_OK

private static final String STATS_MAP_OK

See Also:

• Constant Field Values

STATS_MAP_BAD

private static final String STATS_MAP_BAD

See Also:

• Constant Field Values

STATS_KEYS

private static final String[] STATS_KEYS

plugin_interface

private PluginInterface plugin_interface

log

private LoggerChannel log

mapping_manager

private UPnPMappingManager mapping_manager

upnp

private UPnP upnp

upnp_log_listener

private UPnPLogListener upnp_log_listener

nat_pmp_upnp

private NatPMPUPnP nat_pmp_upnp

natpmp_enable_param

private BooleanParameter natpmp_enable_param

nat_pmp_router

private StringParameter nat_pmp_router

upnp_enable_param

private BooleanParameter upnp_enable_param

trace_to_log

private BooleanParameter trace_to_log

desc_prefix_param

private StringParameter desc_prefix_param

alert_success_param

private BooleanParameter alert_success_param

grab_ports_param

private BooleanParameter grab_ports_param

alert_other_port_param

private BooleanParameter alert_other_port_param

alert_device_probs_param

private BooleanParameter alert_device_probs_param

release_mappings_param

private BooleanParameter release_mappings_param

selected_interfaces_param

private StringParameter selected_interfaces_param

selected_addresses_param

private StringParameter selected_addresses_param

ignore_bad_devices

private BooleanParameter ignore_bad_devices

ignored_devices_list

private LabelParameter ignored_devices_list

mappings_cow

private CopyOnWriteList<UPnPMapping> mappings_cow

services_cow

private CopyOnWriteList<UPnPPluginService> services_cow

root_info_map

private Map<URL,String> root_info_map

log_no_repeat_map

private Map<String,String> log_no_repeat_map

this_mon

protected AEMonitor this_mon

Constructor Details

UPnPPlugin

public UPnPPlugin()

Method Details

load

public static void load(PluginInterface plugin_interface)

initialize

public void initialize(PluginInterface _plugin_interface)

Description copied from interface: Plugin

This method is called when the Plugin is loaded by the client

Specified by:

initialize in interface Plugin

Parameters:

_plugin_interface - the interface that the plugin must use to communicate with the client

updateIgnoreList

protected void updateIgnoreList()

ignoreDevice

protected void ignoreDevice(String USN,
 URL location)

startUp

protected void startUp()

closeDown

protected void closeDown(boolean end_of_day)

deviceDiscovered

public boolean deviceDiscovered(String USN,
 URL location)

Specified by:

deviceDiscovered in interface UPnPListener

logNoRepeat

protected void logNoRepeat(String usn,
 URL location,
 String msg,
 String suffix)

rootDeviceFound

public void rootDeviceFound(UPnPRootDevice device)

Specified by:

rootDeviceFound in interface UPnPListener

checkDeviceStats

protected boolean checkDeviceStats(UPnPRootDevice root)

checkDeviceStats

protected boolean checkDeviceStats(String USN,
 URL location)

incrementDeviceStats

protected long incrementDeviceStats(String USN,
 String stat_key)

getDeviceStats

protected long getDeviceStats(String USN,
 String stat_key)

setDeviceStats

protected void setDeviceStats(String USN,
 String stat_key,
 long value)

mappingResult

public void mappingResult(UPnPWANConnection connection,
 boolean ok)

Specified by:

mappingResult in interface UPnPWANConnectionListener

mappingsReadResult

public void mappingsReadResult(UPnPWANConnection connection,
 boolean ok)

Specified by:

mappingsReadResult in interface UPnPWANConnectionListener

getSelectedInterfaces

protected String[] getSelectedInterfaces()

getSelectedInterfaces

protected static String[] getSelectedInterfaces(String si)

getSelectedAddresses

protected String[] getSelectedAddresses()

processDevice

protected int processDevice(UPnPDevice device)
                     throws UPnPException

Throws:

UPnPException

processServices

protected int processServices(UPnPDevice device,
 UPnPService[] device_services)
                       throws UPnPException

Throws:

UPnPException

addService

protected void addService(UPnPWANConnection wan_service)
                   throws UPnPException

Throws:

UPnPException

removeService

protected void removeService(UPnPWANConnection wan_service,
 boolean replaced)

addService

protected void addService(UPnPWANIPv6FirewallControl firewall_service)
                   throws UPnPException

Throws:

UPnPException

removeService

protected void removeService(UPnPWANIPv6FirewallControl firewall_service,
 boolean replaced)

addMapping

protected void addMapping(UPnPMapping mapping)

mappingChanged

public void mappingChanged(UPnPMapping mapping)

Specified by:

mappingChanged in interface UPnPMappingListener

mappingDestroyed

public void mappingDestroyed(UPnPMapping mapping)

Specified by:

mappingDestroyed in interface UPnPMappingListener

checkState

protected void checkState()

getExternalIPAddresses

public String[] getExternalIPAddresses()

getServices

public UPnPPluginService[] getServices()

getServices

public UPnPPluginService[] getServices(UPnPDevice device)

addMapping

public UPnPMapping addMapping(String desc_resource,
 boolean tcp,
 int port,
 boolean enabled)

getMapping

public UPnPMapping getMapping(boolean tcp,
 int port)

getMappings

public UPnPMapping[] getMappings()

isEnabled

public boolean isEnabled()

setNATPMPEnableState

protected void setNATPMPEnableState()

logAlert

protected void logAlert(int type,
 String resource,
 String[] params)

refreshMappings

public void refreshMappings()

Provided for use by other plugins.

refreshMappings

public void refreshMappings(boolean force)

Provided for use by other plugins.

generate

public void generate(IndentWriter writer)

Specified by:

generate in interface AEDiagnosticsEvidenceGenerator