Klasse DefaultUpnpServiceConfiguration

java.lang.Object

org.jupnp.DefaultUpnpServiceConfiguration

Alle implementierten Schnittstellen:

UpnpServiceConfiguration

public class DefaultUpnpServiceConfiguration
extends Object
implements UpnpServiceConfiguration

Default configuration data of a typical UPnP stack.

This configuration utilizes the default network transport implementation found in org.jupnp.transport.impl.

This configuration utilizes the DOM default descriptor binders found in org.jupnp.binding.xml.

The thread Executor is an Executors.newCachedThreadPool() with a custom DefaultUpnpServiceConfiguration.JUPnPThreadFactory (it only sets a thread name).

Note that this pool is effectively unlimited, so the number of threads will grow (and shrink) as needed - or restricted by your JVM.

The default Namespace is configured without any base path or prefix.

Autor:

Christian Bauer, Kai Kreuzer - introduced bounded thread pool, Jochen Hiller - increased thread pool size to 200, Victor Toni - consolidated transport abstraction into one interface

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	DefaultUpnpServiceConfiguration.JUPnPExecutor
static class	DefaultUpnpServiceConfiguration.JUPnPThreadFactory

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
	DefaultUpnpServiceConfiguration()	Defaults to port '0', ephemeral.
protected	DefaultUpnpServiceConfiguration(boolean checkRuntime)
	DefaultUpnpServiceConfiguration(int streamListenPort)
	DefaultUpnpServiceConfiguration(int streamListenPort, int multicastResponsePort)
protected	DefaultUpnpServiceConfiguration(int streamListenPort, int multicastResponsePort, boolean checkRuntime)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
DatagramIO	createDatagramIO(NetworkAddressFactory networkAddressFactory)
protected DatagramProcessor	createDatagramProcessor()
protected ExecutorService	createDefaultExecutorService()
protected DeviceDescriptorBinder	createDeviceDescriptorBinderUDA10()
protected GENAEventProcessor	createGENAEventProcessor()
MulticastReceiver	createMulticastReceiver(NetworkAddressFactory networkAddressFactory)
protected Namespace	createNamespace()
NetworkAddressFactory	createNetworkAddressFactory()
protected NetworkAddressFactory	createNetworkAddressFactory(int streamListenPort, int multicastResponsePort)
protected ServiceDescriptorBinder	createServiceDescriptorBinderUDA10()
protected SOAPActionProcessor	createSOAPActionProcessor()
StreamClient	createStreamClient()
StreamServer	createStreamServer(NetworkAddressFactory networkAddressFactory)
int	getAliveIntervalMillis()	Optional setting for flooding alive NOTIFY messages for local devices.
ExecutorService	getAsyncProtocolExecutor()
ExecutorService	getDatagramIOExecutor()
DatagramProcessor	getDatagramProcessor()
protected ExecutorService	getDefaultExecutorService()
UpnpHeaders	getDescriptorRetrievalHeaders(RemoteDeviceIdentity identity)	Optional extra headers for device descriptor retrieval HTTP requests.
DeviceDescriptorBinder	getDeviceDescriptorBinderUDA10()
UpnpHeaders	getEventSubscriptionHeaders(RemoteService service)	Optional extra headers for event subscription (almost HTTP) messages.
ServiceType[]	getExclusiveServiceTypes()	Returns service types that can be handled by this UPnP stack, all others will be ignored.
GENAEventProcessor	getGenaEventProcessor()
ExecutorService	getMulticastReceiverExecutor()
Namespace	getNamespace()
Executor	getRegistryListenerExecutor()
Executor	getRegistryMaintainerExecutor()
int	getRegistryMaintenanceIntervalMillis()
Integer	getRemoteDeviceMaxAgeSeconds()	Returns the time in seconds a remote device will be registered until it is expired.
Executor	getRemoteListenerExecutor()
ServiceDescriptorBinder	getServiceDescriptorBinderUDA10()
SOAPActionProcessor	getSoapActionProcessor()
ExecutorService	getStreamServerExecutorService()
ExecutorService	getSyncProtocolExecutorService()
boolean	isReceivedSubscriptionTimeoutIgnored()	Ignore the received event subscription timeout from remote control points.
void	shutdown()	Called by the UpnpService on shutdown, useful to e.g. shutdown thread pools.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

DefaultUpnpServiceConfiguration

public DefaultUpnpServiceConfiguration()

Defaults to port '0', ephemeral.

DefaultUpnpServiceConfiguration

public DefaultUpnpServiceConfiguration(int streamListenPort)

DefaultUpnpServiceConfiguration

public DefaultUpnpServiceConfiguration(int streamListenPort,
 int multicastResponsePort)

DefaultUpnpServiceConfiguration

protected DefaultUpnpServiceConfiguration(boolean checkRuntime)

DefaultUpnpServiceConfiguration

protected DefaultUpnpServiceConfiguration(int streamListenPort,
 int multicastResponsePort,
 boolean checkRuntime)

Methodendetails

getDatagramProcessor

public DatagramProcessor getDatagramProcessor()

Angegeben von:

getDatagramProcessor in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

The shared implementation of DatagramProcessor.

getSoapActionProcessor

public SOAPActionProcessor getSoapActionProcessor()

Angegeben von:

getSoapActionProcessor in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

The shared implementation of SOAPActionProcessor.

getGenaEventProcessor

public GENAEventProcessor getGenaEventProcessor()

Angegeben von:

getGenaEventProcessor in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

The shared implementation of GENAEventProcessor.

createStreamClient

public StreamClient createStreamClient()

Angegeben von:

createStreamClient in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

A new instance of the StreamClient interface.

createStreamServer

public StreamServer createStreamServer(NetworkAddressFactory networkAddressFactory)

Angegeben von:

createStreamServer in Schnittstelle UpnpServiceConfiguration

Parameter:

networkAddressFactory - The configured NetworkAddressFactory.

Gibt zurück:

A new instance of the StreamServer interface.

createMulticastReceiver

public MulticastReceiver createMulticastReceiver(NetworkAddressFactory networkAddressFactory)

Angegeben von:

createMulticastReceiver in Schnittstelle UpnpServiceConfiguration

Parameter:

networkAddressFactory - The configured NetworkAddressFactory.

Gibt zurück:

A new instance of the MulticastReceiver interface.

createDatagramIO

public DatagramIO createDatagramIO(NetworkAddressFactory networkAddressFactory)

Angegeben von:

createDatagramIO in Schnittstelle UpnpServiceConfiguration

Parameter:

networkAddressFactory - The configured NetworkAddressFactory.

Gibt zurück:

A new instance of the DatagramIO interface.

getMulticastReceiverExecutor

public ExecutorService getMulticastReceiverExecutor()

Angegeben von:

getMulticastReceiverExecutor in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

The executor which runs the listening background threads for multicast datagrams.

getDatagramIOExecutor

public ExecutorService getDatagramIOExecutor()

Angegeben von:

getDatagramIOExecutor in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

The executor which runs the listening background threads for unicast datagrams.

getStreamServerExecutorService

public ExecutorService getStreamServerExecutorService()

Angegeben von:

getStreamServerExecutorService in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

The executor which runs the listening background threads for HTTP requests.

getDeviceDescriptorBinderUDA10

public DeviceDescriptorBinder getDeviceDescriptorBinderUDA10()

Angegeben von:

getDeviceDescriptorBinderUDA10 in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

The shared implementation of DeviceDescriptorBinder for the UPnP 1.0 Device Architecture..

getServiceDescriptorBinderUDA10

public ServiceDescriptorBinder getServiceDescriptorBinderUDA10()

Angegeben von:

getServiceDescriptorBinderUDA10 in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

The shared implementation of ServiceDescriptorBinder for the UPnP 1.0 Device Architecture..

getExclusiveServiceTypes

public ServiceType[] getExclusiveServiceTypes()

Beschreibung aus Schnittstelle kopiert: UpnpServiceConfiguration

Returns service types that can be handled by this UPnP stack, all others will be ignored.

Return null to completely disable remote device and service discovery. All incoming notifications and search responses will then be dropped immediately. This is mostly useful in applications that only provide services with no (remote) control point functionality.

Note that a discovered service type with version 2 or 3 will match an exclusive service type with version 1. UPnP services are required to be backwards compatible, version 2 is a superset of version 1, and version 3 is a superset of version 2, etc.

Angegeben von:

getExclusiveServiceTypes in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

An array of service types that are exclusively discovered, no other service will be discovered. A null return value will disable discovery! An empty array means all services will be discovered.

isReceivedSubscriptionTimeoutIgnored

public boolean isReceivedSubscriptionTimeoutIgnored()

Beschreibung aus Schnittstelle kopiert: UpnpServiceConfiguration

Ignore the received event subscription timeout from remote control points.

Some control points have trouble renewing subscriptions properly; enabling this option in conjunction with a high value for UserConstants.DEFAULT_SUBSCRIPTION_DURATION_SECONDS ensures that your devices will not disappear on such control points.

Angegeben von:

isReceivedSubscriptionTimeoutIgnored in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

Defaults to false.

getDescriptorRetrievalHeaders

public UpnpHeaders getDescriptorRetrievalHeaders(RemoteDeviceIdentity identity)

Beschreibung aus Schnittstelle kopiert: UpnpServiceConfiguration

Optional extra headers for device descriptor retrieval HTTP requests.

Some devices might require extra headers to recognize your control point, use this method to set these headers. They will be used for every descriptor (XML) retrieval HTTP request by jUPnP. See ClientInfo for action request messages.

Angegeben von:

getDescriptorRetrievalHeaders in Schnittstelle UpnpServiceConfiguration

Parameter:

identity - The (so far) discovered identity of the remote device.

Gibt zurück:

null or extra HTTP headers.

getEventSubscriptionHeaders

public UpnpHeaders getEventSubscriptionHeaders(RemoteService service)

Beschreibung aus Schnittstelle kopiert: UpnpServiceConfiguration

Optional extra headers for event subscription (almost HTTP) messages.

Some devices might require extra headers to recognize your control point, use this method to set these headers for GENA subscriptions. Note that the headers will not be applied to actual event messages, only subscribe, unsubscribe, and renewal.

Angegeben von:

getEventSubscriptionHeaders in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

null or extra HTTP headers.

getRegistryMaintenanceIntervalMillis

public int getRegistryMaintenanceIntervalMillis()

Angegeben von:

getRegistryMaintenanceIntervalMillis in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

Defaults to 1000 milliseconds.

getAliveIntervalMillis

public int getAliveIntervalMillis()

Beschreibung aus Schnittstelle kopiert: UpnpServiceConfiguration

Optional setting for flooding alive NOTIFY messages for local devices.

Use this to advertise local devices at the specified interval, independent of its DeviceIdentity.maxAgeSeconds value. Note that this will increase network traffic.

Some control points (XBMC and other Platinum UPnP SDK based devices, OPPO-93) seem to not properly receive SSDP M-SEARCH replies sent by jUPnP, but will handle NOTIFY alive messages just fine.

Angegeben von:

getAliveIntervalMillis in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

Defaults to zero, disabling ALIVE flooding.

getRemoteDeviceMaxAgeSeconds

public Integer getRemoteDeviceMaxAgeSeconds()

Beschreibung aus Schnittstelle kopiert: UpnpServiceConfiguration

Returns the time in seconds a remote device will be registered until it is expired.

This setting is useful on systems which do not support multicast networking (Android on HTC phones, for example). On such a system you will not receive messages when a remote device disappears from the network and you will not receive its periodic heartbeat alive messages. Only an initial search response (UDP unicast) has been received from the remote device, with its proposed maximum age. To avoid (early) expiration of the remote device, you can override its maxium age with this configuration setting, ignoring the initial maximum age sent by the device. You most likely want to return 0 in this case, so that the remote device is never expired unless you manually remove it from the Registry. You typically remove the device when an action or GENA subscription request to the remote device failed.

Angegeben von:

getRemoteDeviceMaxAgeSeconds in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

null (the default) to accept the remote device's proposed maximum age, or 0 for unlimited age, or a value in seconds.

getAsyncProtocolExecutor

public ExecutorService getAsyncProtocolExecutor()

Angegeben von:

getAsyncProtocolExecutor in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

The executor which runs the processing of asynchronous aspects of the UPnP stack (discovery).

getSyncProtocolExecutorService

public ExecutorService getSyncProtocolExecutorService()

Angegeben von:

getSyncProtocolExecutorService in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

The executor service which runs the processing of synchronous aspects of the UPnP stack (description, control, GENA).

getNamespace

public Namespace getNamespace()

Angegeben von:

getNamespace in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

An instance of Namespace for this UPnP stack.

getRegistryMaintainerExecutor

public Executor getRegistryMaintainerExecutor()

Angegeben von:

getRegistryMaintainerExecutor in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

The executor which runs the background thread for maintaining the registry.

getRegistryListenerExecutor

public Executor getRegistryListenerExecutor()

Angegeben von:

getRegistryListenerExecutor in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

The executor which runs the notification threads of registry listeners.

getRemoteListenerExecutor

public Executor getRemoteListenerExecutor()

Angegeben von:

getRemoteListenerExecutor in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

The executor which runs the remote listener threads.

createNetworkAddressFactory

public NetworkAddressFactory createNetworkAddressFactory()

Angegeben von:

createNetworkAddressFactory in Schnittstelle UpnpServiceConfiguration

Gibt zurück:

A new instance of the NetworkAddressFactory interface.

shutdown

public void shutdown()

Beschreibung aus Schnittstelle kopiert: UpnpServiceConfiguration

Called by the UpnpService on shutdown, useful to e.g. shutdown thread pools.

Angegeben von:

shutdown in Schnittstelle UpnpServiceConfiguration

createNetworkAddressFactory

protected NetworkAddressFactory createNetworkAddressFactory(int streamListenPort,
 int multicastResponsePort)

createDatagramProcessor

protected DatagramProcessor createDatagramProcessor()

createSOAPActionProcessor

protected SOAPActionProcessor createSOAPActionProcessor()

createGENAEventProcessor

protected GENAEventProcessor createGENAEventProcessor()

createDeviceDescriptorBinderUDA10

protected DeviceDescriptorBinder createDeviceDescriptorBinderUDA10()

createServiceDescriptorBinderUDA10

protected ServiceDescriptorBinder createServiceDescriptorBinderUDA10()

createNamespace

protected Namespace createNamespace()

getDefaultExecutorService

protected ExecutorService getDefaultExecutorService()

createDefaultExecutorService

protected ExecutorService createDefaultExecutorService()