JMEDSFramework (JDPWS 0.11.1 API)

java.lang.Object
- org.ws4d.java.JMEDSFramework

```
public final class JMEDSFramework
extends java.lang.Object
```
This is the main framework class for the Java Multiedition DPWS Stack (JMEDS 2.0).

It offers static methods to start and stop the framework.

This class verifies the existence of the following modules:
- Client support
- Device and Service support
- Event support
- Special platform dependent implementation of the communication and file system
- Attachment support
- Security support
Furthermore this class allows access to some special and optional framework components like:
- ThreadPool
- CommunicationManager (at least one is necessary)
- MonitorStreamFactory (optional)
- FileSystem (optional)
Important: It is necessary to start the framework before anything else can be used!

Your code could look something like this:
```
 JMEDSFramework.start(args);

 // Your code here

 JMEDSFramework.stop();
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CLIENT_MODULE` Identifier for the client support (Client module).
`static java.lang.String`	`CLIENT_MODULE_PATH`
`static int`	`SERVICE_MODULE` Identifier for the service and device support.
`static java.lang.String`	`SERVICE_MODULE_PATH`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addClientSubscription(ClientSubscription subscription)` Adds a event subscription to the framework.
`static MonitorStreamFactory`	`getMonitorStreamFactory()` Returns the `MonitorStreamFactory` which allows to wrap streams and redistribute data.
`static ResourceLoader`	`getResourceAsStream(URI location, CredentialInfo credentialInfo, java.lang.String comManId)` Returns an input stream which allows to read a resource from the given location.
`static ThreadPool`	`getThreadPool()` Returns the thread pool used by the framework.
`static boolean`	`hasModule(int module)` Allows to verify whether a module has been loaded and can be used or not.
`static boolean`	`isKillRunning()`
`static boolean`	`isRunning()` Indicates whether the framework was started or not.
`static boolean`	`isStopRunning()`
`static void`	`kill()` Stops the framework immediately!!!!
`static void`	`removeClientSubscription(ClientSubscription subscription)` Removes a event subscription.
`static void`	`setClientModuleClassExists(boolean exists)`
`static void`	`setMonitorStreamFactory(MonitorStreamFactory factory)` Set the factory for stream monitoring.
`static void`	`setPropertiesPath(java.lang.String path)`
`static void`	`setServiceModuleClassExists(boolean exists)`
`static void`	`start(java.lang.String[] args)` Starts the framework.
`static void`	`stop()` Stops the framework as soon as possible.
`static void`	`stopIgnoringInstancesCount()`
`static boolean`	`supportsConfiguration(int config)` Allows to verify whether some modules are loaded or not.

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

- Field Detail
  - CLIENT_MODULE
```
public static final int CLIENT_MODULE
```
    Identifier for the client support (Client module).
    
    This identifier can be used to verify whether the Client module has been loaded or not. To check this module, use the hasModule(int) method.
    
    The Client module includes the classes to create a client and the classes which are necessary if the client wants to use the device and service discovery.
    
    See Also:
    
    Constant Field Values
  - CLIENT_MODULE_PATH
```
public static final java.lang.String CLIENT_MODULE_PATH
```
    See Also:
    
    Constant Field Values
  - SERVICE_MODULE
```
public static final int SERVICE_MODULE
```
    Identifier for the service and device support. (Service module).
    
    This identifier can be used to verify whether the Service module has been loaded or not. To check this module, use the hasModule(int) method.
    
    The Service module includes the classes to create a device and service.
    
    See Also:
    
    Constant Field Values
  - SERVICE_MODULE_PATH
```
public static final java.lang.String SERVICE_MODULE_PATH
```
    See Also:
    
    Constant Field Values
- Method Detail
  - start
```
public static void start(java.lang.String[] args)
```
    Starts the framework.
    
    This method initializes the necessary framework components.
    
    Important: It is necessary to start the framework before anything else can be used!
    
    This method starts the watchdog, loads the properties and initializes the communications modules.
    
    Parameters:
    
    args - Here you can pass-through the command-line arguments. the first element is interpreted as the location of the properties file.
  - stop
```
public static void stop()
```
    Stops the framework as soon as possible.
    
    This method is the counter piece to start(String[]). It stops the framework and the running components. This method will wait until the opened connection are ready to be closed.
    
    If it is necessary to stop the framework immediately the kill() method should be used.
    
    See Also:
    
    start(String[]), kill()
  - stopIgnoringInstancesCount
```
public static void stopIgnoringInstancesCount()
```
  - isRunning
```
public static boolean isRunning()
```
    Indicates whether the framework was started or not.
    
    This method returns true if the framework is running, false otherwise.
    
    Returns:
    
    true if the framework is running, false otherwise.
  - kill
```
public static void kill()
```
    Stops the framework immediately!!!!
    
    This method is the counter piece to start(String[]). It stops the framework and the running components. This method will not wait until the opened connection are ready to be closed, any existing connection will be closed instant.
    
    See Also:
    
    start(String[]), stop()
  - isKillRunning
```
public static boolean isKillRunning()
```
  - isStopRunning
```
public static boolean isStopRunning()
```
  - addClientSubscription
```
public static void addClientSubscription(ClientSubscription subscription)
```
    Adds a event subscription to the framework. This allows the framework to unsubscribe on shutdown.
    
    Parameters:
    
    subscription - the subscription which the framework should take care about.
  - removeClientSubscription
```
public static void removeClientSubscription(ClientSubscription subscription)
```
    Removes a event subscription.
    
    Parameters:
    
    subscription - the subscription which is not important any more.
  - hasModule
```
public static boolean hasModule(int module)
```
    Allows to verify whether a module has been loaded and can be used or not.
    
    You can check the modules listed below.
    
    Parameters:
    
    module - the module identifier.
    
    Returns:
    
    returns true if the module has been loaded, false otherwise.
    
    See Also:
    
    CLIENT_MODULE, SERVICE_MODULE
  - supportsConfiguration
```
public static boolean supportsConfiguration(int config)
```
    Allows to verify whether some modules are loaded or not.
    
    This method allows to check several modules with one method. If you want to check only one module, see the hasModule(int) method.
    
    You can check the modules listed below.
    
    Parameters:
    
    config - the modules to check.
    To check more than one module, sum up their values.
    e.g. CLIENT_MODULE + SERVICE_MODULE
    
    Returns:
    
    returns true if all given modules have been loaded, false otherwise.
    
    See Also:
    
    CLIENT_MODULE, SERVICE_MODULE
  - getThreadPool
```
public static ThreadPool getThreadPool()
```
    Returns the thread pool used by the framework.
    
    This thread pool is necessary for thread handling, because CLDC does not have an own thread pool. All threads created by the framework are created with this thread pool.
    
    Returns:
    
    the thread pool.
  - getResourceAsStream
```
public static ResourceLoader getResourceAsStream(URI location,
                                                 CredentialInfo credentialInfo,
                                                 java.lang.String comManId)
```
    Returns an input stream which allows to read a resource from the given location.
    
    The location is a URL. The loaded communication managers can be registered for different URL schemas. This allows the loading of resources from different locations.
    
    Parameters:
    
    location - the location of the resource (e.g. http://example.org/test.wsdl).
    
    Returns:
    
    an ResourceLoader containing input stream for the given resource and ConnectionInfo for network resources. Returns null if no communication manager could find a resource at the given location.
    
    Throws:
    
    java.io.IOException - throws an exception when the resource could not be loaded properly.
  - getMonitorStreamFactory
```
public static MonitorStreamFactory getMonitorStreamFactory()
```
    Returns the MonitorStreamFactory which allows to wrap streams and redistribute data.
    
    Returns:
    
    the factory to wrap streams and redistribute data.
    
    See Also:
    
    setMonitorStreamFactory(MonitorStreamFactory)
  - setMonitorStreamFactory
```
public static void setMonitorStreamFactory(MonitorStreamFactory factory)
```
    Set the factory for stream monitoring.
    
    This enables the monitoring of streams for debug purposes. A MonitorStreamFactory wraps streams to redistribute data. A communication manager can use the factory to redistribute data to the streams created by the factory.
    
    Parameters:
    
    factory - the factory which wraps streams and redistribute data.
  - setPropertiesPath
```
public static void setPropertiesPath(java.lang.String path)
```
  - setClientModuleClassExists
```
public static void setClientModuleClassExists(boolean exists)
```
  - setServiceModuleClassExists
```
public static void setServiceModuleClassExists(boolean exists)
```

Class JMEDSFramework

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLIENT_MODULE

CLIENT_MODULE_PATH

SERVICE_MODULE

SERVICE_MODULE_PATH

Method Detail

start

stop

stopIgnoringInstancesCount

isRunning

kill

isKillRunning

isStopRunning

addClientSubscription

removeClientSubscription

hasModule

supportsConfiguration

getThreadPool

getResourceAsStream

getMonitorStreamFactory

setMonitorStreamFactory

setPropertiesPath

setClientModuleClassExists

setServiceModuleClassExists