ControlPoint (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- org.cybergarage.upnp.ControlPoint

All Implemented Interfaces:
HTTPRequestListener
Direct Known Subclasses:
UPnP
```
public class ControlPoint
extends Object
implements HTTPRequestListener
```
Main UPnP control point implementation for device discovery and control.
This class implements HTTPRequestListener to provide comprehensive UPnP control point functionality including device discovery, service enumeration, action invocation, and event subscription management. It serves as the primary interface for UPnP control applications.
Key features:
- SSDP device discovery and advertisement monitoring
- HTTP server for receiving control requests
- Device and service lifecycle management
- Event subscription and notification handling
- SOAP action invocation and response processing
- Multi-homed network interface support
- Expired device cleanup and monitoring
This class is used by UPnP control applications to discover, control, and monitor UPnP devices on the network, providing a complete framework for building UPnP control point functionality.

Field Summary
Fields
Modifier and Type Field and Description
(package private) ListenerList deviceChangeListenerList

Fields
Modifier and Type	Field and Description
`(package private) ListenerList`	`deviceChangeListenerList`

Constructor Summary

Constructors
Constructor and Description
`ControlPoint()` Default constructor using default ports
`ControlPoint(int ssdpPort, int httpPort)` Create a control point with specified SSDP and HTTP ports.
`ControlPoint(int ssdpPort, int httpPort, InetAddress[] binds)` Create a control point with specified ports and network bindings.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDeviceChangeListener(DeviceChangeListener listener)`
`void`	`addEventListener(EventListener listener)`
`void`	`addNotifyListener(NotifyListener listener)` Add a notify listener.
`void`	`addSearchResponseListener(SearchResponseListener listener)`
`void`	`finalize()`
`Device`	`getDevice(String name)` Get a device by its name or UDN.
`Disposer`	`getDeviceDisposer()` Get the device disposer.
`DeviceList`	`getDeviceList()` Get the list of discovered devices.
`String`	`getEventSubURI()`
`long`	`getExpiredDeviceMonitoringInterval()` Get the expired device monitoring interval.
`int`	`getHTTPPort()` Get the HTTP port.
`protected HTTPServerList`	`getHTTPServerList()` I2P was private
`RenewSubscriber`	`getRenewSubscriber()`
`int`	`getSearchMx()`
`protected SSDPNotifySocketList`	`getSSDPNotifySocketList()` Get the SSDP notify socket list.
`int`	`getSSDPPort()` Get the SSDP port.
`protected SSDPSearchResponseSocketList`	`getSSDPSearchResponseSocketList()` Get the SSDP search response socket list.
`Service`	`getSubscriberService(String uuid)`
`Object`	`getUserData()`
`boolean`	`hasDevice(String name)` Check if a device with the given name or UDN exists.
`void`	`httpRequestRecieved(HTTPRequest httpReq)` Called when an HTTP request is received.
`boolean`	`isNMPRMode()` Check if NMPR mode is enabled.
`boolean`	`isSubscribed(Service service)`
`void`	`lock()` Lock the mutex
`void`	`notifyReceived(SSDPPacket packet)`
`void`	`performAddDeviceListener(Device dev)`
`void`	`performEventListener(String uuid, long seq, String name, String value)`
`void`	`performNotifyListener(SSDPPacket ssdpPacket)` Notify all registered notify listeners of a received SSDP packet.
`void`	`performRemoveDeviceListener(Device dev)`
`void`	`performSearchResponseListener(SSDPPacket ssdpPacket)`
`void`	`print()`
`protected void`	`removeDevice(Device dev)` Remove a device from the device list.
`protected void`	`removeDevice(String name)` Remove a device by its name or UDN.
`void`	`removeDeviceChangeListener(DeviceChangeListener listener)`
`void`	`removeEventListener(EventListener listener)`
`void`	`removeExpiredDevices()` Remove all expired devices
`void`	`removeNotifyListener(NotifyListener listener)` Remove a notify listener.
`void`	`removeSearchResponseListener(SearchResponseListener listener)`
`void`	`renewSubscriberService()` Renew all subscriber services with infinite timeout
`void`	`renewSubscriberService(Device dev, long timeout)`
`void`	`renewSubscriberService(long timeout)`
`void`	`search()` Search for all root devices
`void`	`search(String target)`
`void`	`search(String target, int mx)`
`void`	`searchResponseReceived(SSDPPacket packet)`
`void`	`setDeviceDisposer(Disposer disposer)` Set the device disposer.
`void`	`setEventSubURI(String url)`
`void`	`setExpiredDeviceMonitoringInterval(long interval)` Set the expired device monitoring interval.
`void`	`setHTTPPort(int port)` Set the HTTP port.
`void`	`setNMPRMode(boolean flag)` Set the NMPR mode flag.
`void`	`setRenewSubscriber(RenewSubscriber sub)`
`void`	`setSearchMx(int mx)`
`void`	`setSSDPPort(int port)` Set the SSDP port.
`void`	`setUserData(Object data)`
`boolean`	`start()` Start with default search target
`boolean`	`start(String target)`
`boolean`	`start(String target, int mx)`
`boolean`	`stop()`
`boolean`	`subscribe(Service service)`
`boolean`	`subscribe(Service service, long timeout)`
`boolean`	`subscribe(Service service, String uuid)`
`boolean`	`subscribe(Service service, String uuid, long timeout)`
`void`	`unlock()` Unlock the mutex
`void`	`unsubscribe()` Unsubscribe from all services
`void`	`unsubscribe(Device device)`
`boolean`	`unsubscribe(Service service)`

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

- Field Detail
  - deviceChangeListenerList
```
ListenerList deviceChangeListenerList
```
- Constructor Detail
  - ControlPoint
```
public ControlPoint()
```
    Default constructor using default ports
  - ControlPoint
```
public ControlPoint(int ssdpPort,
                    int httpPort)
```
    Create a control point with specified SSDP and HTTP ports.
    Parameters:
    ssdpPort - the SSDP port
    httpPort - the HTTP port
  - ControlPoint
```
public ControlPoint(int ssdpPort,
                    int httpPort,
                    InetAddress[] binds)
```
    Create a control point with specified ports and network bindings.
    Parameters:
    ssdpPort - the SSDP port
    httpPort - the HTTP port
    binds - the network interfaces to bind to, or null for all
- Method Detail
  - addDeviceChangeListener
```
public void addDeviceChangeListener(DeviceChangeListener listener)
```
    Parameters:
    listener - the device change listener to add
  - addEventListener
```
public void addEventListener(EventListener listener)
```
    Parameters:
    listener - the event listener to add
  - addNotifyListener
```
public void addNotifyListener(NotifyListener listener)
```
    Add a notify listener. @param listener the notify listener to add
  - addSearchResponseListener
```
public void addSearchResponseListener(SearchResponseListener listener)
```
    Parameters:
    listener - the search response listener to add
  - finalize
```
public void finalize()
```
    Overrides:
    finalize in class Object
  - getDevice
```
public Device getDevice(String name)
```
    Get a device by its name or UDN.
    Parameters:
    name - the device name or UDN
    Returns:
    the device, or null
  - getDeviceDisposer
```
public Disposer getDeviceDisposer()
```
    Get the device disposer. @return the device disposer
  - getDeviceList
```
public DeviceList getDeviceList()
```
    Get the list of discovered devices. @return the list of discovered devices
  - getEventSubURI
```
public String getEventSubURI()
```
    Returns:
    the event subscription URI
  - getExpiredDeviceMonitoringInterval
```
public long getExpiredDeviceMonitoringInterval()
```
    Get the expired device monitoring interval. @return the expired device monitoring interval
  - getHTTPPort
```
public int getHTTPPort()
```
    Get the HTTP port. @return the HTTP port
  - getHTTPServerList
```
protected HTTPServerList getHTTPServerList()
```
    I2P was private
    Returns:
    the HTTP server list
  - getRenewSubscriber
```
public RenewSubscriber getRenewSubscriber()
```
    Returns:
    the renew subscriber
  - getSearchMx
```
public int getSearchMx()
```
    Returns:
    the search MX value
  - getSSDPNotifySocketList
```
protected SSDPNotifySocketList getSSDPNotifySocketList()
```
    Get the SSDP notify socket list.
    Returns:
    the SSDP notify socket list
  - getSSDPPort
```
public int getSSDPPort()
```
    Get the SSDP port. @return the SSDP port
  - getSSDPSearchResponseSocketList
```
protected SSDPSearchResponseSocketList getSSDPSearchResponseSocketList()
```
    Get the SSDP search response socket list.
    Returns:
    the SSDP search response socket list
  - getSubscriberService
```
public Service getSubscriberService(String uuid)
```
    Parameters:
    uuid - the subscription ID
    Returns:
    the service with that subscription, or null
  - getUserData
```
public Object getUserData()
```
    Returns:
    user-defined data
  - hasDevice
```
public boolean hasDevice(String name)
```
    Check if a device with the given name or UDN exists.
    Parameters:
    name - the device name or UDN
    Returns:
    true if a device with that name exists
  - httpRequestRecieved
```
public void httpRequestRecieved(HTTPRequest httpReq)
```
    Description copied from interface: HTTPRequestListener
    Called when an HTTP request is received.
    Specified by:
    httpRequestRecieved in interface HTTPRequestListener
    Parameters:
    httpReq - the received HTTP request
  - isNMPRMode
```
public boolean isNMPRMode()
```
    Check if NMPR mode is enabled. @return true if NMPR mode is enabled
  - isSubscribed
```
public boolean isSubscribed(Service service)
```
    Parameters:
    service - the service
    Returns:
    true if subscribed
  - lock
```
public void lock()
```
    Lock the mutex
  - notifyReceived
```
public void notifyReceived(SSDPPacket packet)
```
    Parameters:
    packet - the received SSDP packet
  - performAddDeviceListener
```
public void performAddDeviceListener(Device dev)
```
    Parameters:
    dev - the device that was added
  - performEventListener
```
public void performEventListener(String uuid,
                                 long seq,
                                 String name,
                                 String value)
```
    Parameters:
    uuid - the subscription ID
    seq - the sequence number
    name - the property name
    value - the property value
  - performNotifyListener
```
public void performNotifyListener(SSDPPacket ssdpPacket)
```
    Notify all registered notify listeners of a received SSDP packet. @param ssdpPacket the received SSDP packet
  - performRemoveDeviceListener
```
public void performRemoveDeviceListener(Device dev)
```
    Parameters:
    dev - the device that was removed
  - performSearchResponseListener
```
public void performSearchResponseListener(SSDPPacket ssdpPacket)
```
    Parameters:
    ssdpPacket - the received SSDP packet
  - print
```
public void print()
```
  - removeDevice
```
protected void removeDevice(Device dev)
```
    Remove a device from the device list. @param dev the device to remove
  - removeDevice
```
protected void removeDevice(String name)
```
    Remove a device by its name or UDN. @param name the device name to remove
  - removeDeviceChangeListener
```
public void removeDeviceChangeListener(DeviceChangeListener listener)
```
    Parameters:
    listener - the device change listener to remove
  - removeEventListener
```
public void removeEventListener(EventListener listener)
```
    Parameters:
    listener - the event listener to remove
  - removeExpiredDevices
```
public void removeExpiredDevices()
```
    Remove all expired devices
  - removeNotifyListener
```
public void removeNotifyListener(NotifyListener listener)
```
    Remove a notify listener. @param listener the notify listener to remove
  - removeSearchResponseListener
```
public void removeSearchResponseListener(SearchResponseListener listener)
```
    Parameters:
    listener - the search response listener to remove
  - renewSubscriberService
```
public void renewSubscriberService()
```
    Renew all subscriber services with infinite timeout
  - renewSubscriberService
```
public void renewSubscriberService(Device dev,
                                   long timeout)
```
    Parameters:
    dev - the device whose subscriptions to renew
    timeout - the subscription timeout
  - renewSubscriberService
```
public void renewSubscriberService(long timeout)
```
    Parameters:
    timeout - the subscription timeout
  - search
```
public void search()
```
    Search for all root devices
  - search
```
public void search(String target)
```
    Parameters:
    target - the search target
  - search
```
public void search(String target,
                   int mx)
```
    Parameters:
    target - the search target
    mx - the maximum wait time
  - searchResponseReceived
```
public void searchResponseReceived(SSDPPacket packet)
```
    Parameters:
    packet - the search response packet
  - setDeviceDisposer
```
public void setDeviceDisposer(Disposer disposer)
```
    Set the device disposer. @param disposer the device disposer
  - setEventSubURI
```
public void setEventSubURI(String url)
```
    Parameters:
    url - the event subscription URI
  - setExpiredDeviceMonitoringInterval
```
public void setExpiredDeviceMonitoringInterval(long interval)
```
    Set the expired device monitoring interval. @param interval the monitoring interval
  - setHTTPPort
```
public void setHTTPPort(int port)
```
    Set the HTTP port. @param port the HTTP port
  - setNMPRMode
```
public void setNMPRMode(boolean flag)
```
    Set the NMPR mode flag. @param flag the NMPR mode flag
  - setRenewSubscriber
```
public void setRenewSubscriber(RenewSubscriber sub)
```
    Parameters:
    sub - the renew subscriber
  - setSearchMx
```
public void setSearchMx(int mx)
```
    Parameters:
    mx - the search MX value
  - setSSDPPort
```
public void setSSDPPort(int port)
```
    Set the SSDP port. @param port the SSDP port
  - setUserData
```
public void setUserData(Object data)
```
    Parameters:
    data - user-defined data
  - start
```
public boolean start()
```
    Start with default search target
  - start
```
public boolean start(String target)
```
    Parameters:
    target - the search target
  - start
```
public boolean start(String target,
                     int mx)
```
    Parameters:
    target - the search target
    mx - the maximum wait time for responses
    Returns:
    true if started successfully
  - stop
```
public boolean stop()
```
    Returns:
    true if stopped successfully
  - subscribe
```
public boolean subscribe(Service service)
```
    Parameters:
    service - the service to subscribe to
  - subscribe
```
public boolean subscribe(Service service,
                         long timeout)
```
    Parameters:
    service - the service to subscribe to
    timeout - the subscription timeout
    Returns:
    true if successful
  - subscribe
```
public boolean subscribe(Service service,
                         String uuid)
```
    Parameters:
    service - the service
    uuid - the subscription ID
    Returns:
    true if successful
  - subscribe
```
public boolean subscribe(Service service,
                         String uuid,
                         long timeout)
```
    Parameters:
    service - the service
    uuid - the subscription ID
    timeout - the timeout
    Returns:
    true if successful
  - unlock
```
public void unlock()
```
    Unlock the mutex
  - unsubscribe
```
public void unsubscribe()
```
    Unsubscribe from all services
  - unsubscribe
```
public void unsubscribe(Device device)
```
    Parameters:
    device - the device to unsubscribe
  - unsubscribe
```
public boolean unsubscribe(Service service)
```
    Parameters:
    service - the service
    Returns:
    true if successful

Class ControlPoint

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

deviceChangeListenerList

Constructor Detail

ControlPoint

ControlPoint

ControlPoint

Method Detail

addDeviceChangeListener

addEventListener

addNotifyListener

addSearchResponseListener

finalize

getDevice

getDeviceDisposer

getDeviceList

getEventSubURI

getExpiredDeviceMonitoringInterval

getHTTPPort

getHTTPServerList

getRenewSubscriber

getSearchMx

getSSDPNotifySocketList

getSSDPPort

getSSDPSearchResponseSocketList

getSubscriberService

getUserData

hasDevice

httpRequestRecieved

isNMPRMode

isSubscribed

lock

notifyReceived

performAddDeviceListener

performEventListener

performNotifyListener

performRemoveDeviceListener

performSearchResponseListener

print

removeDevice

removeDevice

removeDeviceChangeListener

removeEventListener

removeExpiredDevices

removeNotifyListener

removeSearchResponseListener

renewSubscriberService

renewSubscriberService

renewSubscriberService

search

search

search

searchResponseReceived

setDeviceDisposer

setEventSubURI

setExpiredDeviceMonitoringInterval

setHTTPPort

setNMPRMode

setRenewSubscriber

setSearchMx

setSSDPPort

setUserData

start

start

start

stop

subscribe

subscribe

subscribe

subscribe

unlock

unsubscribe

unsubscribe

unsubscribe