* This interface offers methods for retrieval of configuration data by the * {@link org.fourthline.cling.transport.Router} and the {@link org.fourthline.cling.registry.Registry}, * as well as other parts of the UPnP stack. *
** You can re-use this interface if you implement a subclass of {@link UpnpServiceImpl} or * if you create a new implementation of {@link UpnpService}. *
* * @author Christian Bauer */ public interface UpnpServiceConfiguration { /** * @return A new instance of the {@link org.fourthline.cling.transport.spi.NetworkAddressFactory} interface. */ public NetworkAddressFactory createNetworkAddressFactory(); /** * @return The shared implementation of {@link org.fourthline.cling.transport.spi.DatagramProcessor}. */ public DatagramProcessor getDatagramProcessor(); /** * @return The shared implementation of {@link org.fourthline.cling.transport.spi.SOAPActionProcessor}. */ public SOAPActionProcessor getSoapActionProcessor(); /** * @return The shared implementation of {@link org.fourthline.cling.transport.spi.GENAEventProcessor}. */ public GENAEventProcessor getGenaEventProcessor(); /** * @return A new instance of the {@link org.fourthline.cling.transport.spi.StreamClient} interface. */ public StreamClient createStreamClient(); /** * @param networkAddressFactory The configured {@link org.fourthline.cling.transport.spi.NetworkAddressFactory}. * @return A new instance of the {@link org.fourthline.cling.transport.spi.MulticastReceiver} interface. */ public MulticastReceiver createMulticastReceiver(NetworkAddressFactory networkAddressFactory); /** * @param networkAddressFactory The configured {@link org.fourthline.cling.transport.spi.NetworkAddressFactory}. * @return A new instance of the {@link org.fourthline.cling.transport.spi.DatagramIO} interface. */ public DatagramIO createDatagramIO(NetworkAddressFactory networkAddressFactory); /** * @param networkAddressFactory The configured {@link org.fourthline.cling.transport.spi.NetworkAddressFactory}. * @return A new instance of the {@link org.fourthline.cling.transport.spi.StreamServer} interface. */ public StreamServer createStreamServer(NetworkAddressFactory networkAddressFactory); /** * @return The executor which runs the listening background threads for multicast datagrams. */ public Executor getMulticastReceiverExecutor(); /** * @return The executor which runs the listening background threads for unicast datagrams. */ public Executor getDatagramIOExecutor(); /** * @return The executor which runs the listening background threads for HTTP requests. */ public ExecutorService getStreamServerExecutorService(); /** * @return The shared implementation of {@link org.fourthline.cling.binding.xml.DeviceDescriptorBinder} for the UPnP 1.0 Device Architecture.. */ public DeviceDescriptorBinder getDeviceDescriptorBinderUDA10(); /** * @return The shared implementation of {@link org.fourthline.cling.binding.xml.ServiceDescriptorBinder} for the UPnP 1.0 Device Architecture.. */ public ServiceDescriptorBinder getServiceDescriptorBinderUDA10(); /** * 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. *
* * @return An array of service types that are exclusively discovered, no other service will * be discovered. Anull return value will disable discovery!
* An empty array means all services will be discovered.
*/
public ServiceType[] getExclusiveServiceTypes();
/**
* @return The time in milliseconds to wait between each registry maintenance operation.
*/
public int getRegistryMaintenanceIntervalMillis();
/**
* Optional setting for flooding alive NOTIFY messages for local devices.
* * Use this to advertise local devices at the specified interval, independent of its * {@link org.fourthline.cling.model.meta.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 Cling, but will handle NOTIFY * alive messages just fine. *
* * @return The time in milliseconds for ALIVE message intervals, set to0 to disable
*/
public int getAliveIntervalMillis();
/**
* 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 * {@link org.fourthline.cling.model.UserConstants#DEFAULT_SUBSCRIPTION_DURATION_SECONDS} * ensures that your devices will not disappear on such control points. *
* * @returntrue if the timeout in incoming event subscriptions should be ignored
* and the default value ({@link org.fourthline.cling.model.UserConstants#DEFAULT_SUBSCRIPTION_DURATION_SECONDS})
* should be used instead.
*
*/
public boolean isReceivedSubscriptionTimeoutIgnored();
/**
* 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 {@link org.fourthline.cling.registry.Registry}. You typically remove
* the device when an action or GENA subscription request to the remote device failed.
*
null (the default) to accept the remote device's proposed maximum age, or
* 0 for unlimited age, or a value in seconds.
*/
public Integer getRemoteDeviceMaxAgeSeconds();
/**
* 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 Cling. See {@link org.fourthline.cling.model.profile.ClientInfo} for * action request messages. *
* * @param identity The (so far) discovered identity of the remote device. * @returnnull or extra HTTP headers.
*/
public UpnpHeaders getDescriptorRetrievalHeaders(RemoteDeviceIdentity identity);
/**
* 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. *
* * @returnnull or extra HTTP headers.
*/
public UpnpHeaders getEventSubscriptionHeaders(RemoteService service);
/**
* @return The executor which runs the processing of asynchronous aspects of the UPnP stack (discovery).
*/
public Executor getAsyncProtocolExecutor();
/**
* @return The executor service which runs the processing of synchronous aspects of the UPnP stack (description, control, GENA).
*/
public ExecutorService getSyncProtocolExecutorService();
/**
* @return An instance of {@link org.fourthline.cling.model.Namespace} for this UPnP stack.
*/
public Namespace getNamespace();
/**
* @return The executor which runs the background thread for maintaining the registry.
*/
public Executor getRegistryMaintainerExecutor();
/**
* @return The executor which runs the notification threads of registry listeners.
*/
public Executor getRegistryListenerExecutor();
/**
* Called by the {@link org.fourthline.cling.UpnpService} on shutdown, useful to e.g. shutdown thread pools.
*/
public void shutdown();
}