DPWSProperties (JDPWS 0.11.1-SNAPSHOT API)

java.lang.Object
- org.ws4d.java.configuration.DPWSProperties

All Implemented Interfaces:: PropertiesHandler

public class DPWSProperties
extends java.lang.Object
implements PropertiesHandler

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_HTTP_CHUNKED_MODE`
`static int`	`HTTP_CHUNKED_OFF_IF_POSSIBLE` Don't use HTTP chunked encoding.
`static int`	`HTTP_CHUNKED_ON` Use HTTP chunked encoding.
`static int`	`HTTP_CHUNKED_ON_FOR_INVOKE` Don't use HTTP chunked encoding for metadata exchange (wxf:Get), but use chunked encoding for invoke messages.
`static java.lang.String`	`PROP_DPWS_HTTP_CLIENT_KEEPALIVE`
`static java.lang.String`	`PROP_DPWS_HTTP_CLIENT_REQUEST_TIMEOUT` Time to wait for (next) request until client closes http connection.
`static java.lang.String`	`PROP_DPWS_HTTP_REQUEST_CHUNKED_MODE`
`static java.lang.String`	`PROP_DPWS_HTTP_RESPONSE_CHUNKED_MODE`
`static java.lang.String`	`PROP_DPWS_HTTP_SERVER_KEEPALIVE`
`static java.lang.String`	`PROP_DPWS_HTTP_SERVER_REQUEST_TIMEOUT` Time to wait for (next) request until server closes http connection.
`static java.lang.String`	`PROP_DPWS_ROUTER` Using the native udp router default: false
`static java.lang.String`	`PROP_DPWS_ROUTER_ADDR` The routers ip default: 127.0.0.1
`static java.lang.String`	`PROP_DPWS_ROUTER_PORT` The routers port default: 1111
`static java.lang.String`	`PROP_DPWS_SOAPMSG_GENERATOR_FACTORY_CLASS` Property key for class name of the factory for Message2SOAPGenerator and Message2SOAPGenerator implementing classes.
`static java.lang.String`	`PROP_DPWS_SUPPORTED_DPWS_VERSIONS` Property key for supported DPWS Versions
`static java.lang.String`	`PROP_MATCH_WAIT_TIME` Time to wait until a time exception is thrown, after a request was sent and no answer was received.

Fields inherited from interface org.ws4d.java.configuration.PropertiesHandler
FALSE, TRUE

Constructor Summary

Constructors
Constructor and Description

DPWSProperties()

Constructors
Constructor and Description
`DPWSProperties()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSupportedDPWSVersion(DPWSProtocolVersion dpwsProtocolVersion)`
`void`	`finishedSection(int depth)` This method indicates the PropertiesHandler, that the last section with the given depth has been read completely.
`Iterator`	`getAvailableDPWSVersions()`
`static DPWSProtocolVersion`	`getDefaultDpwsVersion()`
`boolean`	`getHTTPClientKeepAlive()`
`long`	`getHTTPClientRequestTimeout()`
`int`	`getHTTPRequestChunkedMode()`
`int`	`getHTTPResponseChunkedMode()`
`boolean`	`getHTTPServerKeepAlive()`
`long`	`getHTTPServerRequestTimeout()`
`static DPWSProperties`	`getInstance()`
`long`	`getMatchWaitTime()` Gets time in millis for which the framework waits for a resolve matches or a probe matches message, before it throws a `CommunicationException`.
`boolean`	`getNativeRouter()`
`java.lang.String`	`getNativeRouterIp()`
`int`	`getNativeRouterPort()`
`java.lang.String`	`getSOAPMessageGeneratorFactoryClass()`
`HashSet`	`getSupportedDPWSVersions()`
`java.lang.String`	`printSupportedDPWSVersions()`
`void`	`removeSupportedDPWSVersion(DPWSProtocolVersion dpwsProtocolVersion)`
`static void`	`setDefaultDpwsVersion(DPWSProtocolVersion defaultDpwsVersion)`
`void`	`setHTTPClientKeepAlive(boolean b)`
`void`	`setHTTPClientRequestTimeout(long timeout)`
`void`	`setHTTPRequestChunkedMode(int i)`
`void`	`setHTTPResponseChunkedMode(int i)`
`void`	`setHTTPServerKeepAlive(boolean b)`
`void`	`setHTTPServerRequestTimeout(long timeout)`
`void`	`setMatchWaitTime(long matchWaitTime)` Sets time in millis for which the framework waits for a resolve matches or a probe matches message, before it throws a `CommunicationException`.
`void`	`setNativeRouter(boolean b)`
`void`	`setNativeRouterIp(java.lang.String ip)`
`void`	`setNativeRouterPort(int port)`
`void`	`setProperties(PropertyHeader header, Property property)`
`void`	`setSOAPMessageGeneratorFactoryClass(java.lang.String className)`

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

- Field Detail
  - PROP_DPWS_ROUTER
```
public static final java.lang.String PROP_DPWS_ROUTER
```
    Using the native udp router default: false
    
    See Also:
    
    Constant Field Values
  - PROP_DPWS_ROUTER_ADDR
```
public static final java.lang.String PROP_DPWS_ROUTER_ADDR
```
    The routers ip default: 127.0.0.1
    
    See Also:
    
    Constant Field Values
  - PROP_DPWS_ROUTER_PORT
```
public static final java.lang.String PROP_DPWS_ROUTER_PORT
```
    The routers port default: 1111
    
    See Also:
    
    Constant Field Values
  - PROP_DPWS_HTTP_SERVER_KEEPALIVE
```
public static final java.lang.String PROP_DPWS_HTTP_SERVER_KEEPALIVE
```
    See Also:
    
    Constant Field Values
  - PROP_DPWS_HTTP_CLIENT_KEEPALIVE
```
public static final java.lang.String PROP_DPWS_HTTP_CLIENT_KEEPALIVE
```
    See Also:
    
    Constant Field Values
  - PROP_DPWS_HTTP_RESPONSE_CHUNKED_MODE
```
public static final java.lang.String PROP_DPWS_HTTP_RESPONSE_CHUNKED_MODE
```
    See Also:
    
    Constant Field Values
  - PROP_DPWS_HTTP_REQUEST_CHUNKED_MODE
```
public static final java.lang.String PROP_DPWS_HTTP_REQUEST_CHUNKED_MODE
```
    See Also:
    
    Constant Field Values
  - PROP_DPWS_HTTP_SERVER_REQUEST_TIMEOUT
```
public static final java.lang.String PROP_DPWS_HTTP_SERVER_REQUEST_TIMEOUT
```
    Time to wait for (next) request until server closes http connection.
    
    See Also:
    
    Constant Field Values
  - PROP_DPWS_HTTP_CLIENT_REQUEST_TIMEOUT
```
public static final java.lang.String PROP_DPWS_HTTP_CLIENT_REQUEST_TIMEOUT
```
    Time to wait for (next) request until client closes http connection.
    
    See Also:
    
    Constant Field Values
  - PROP_DPWS_SUPPORTED_DPWS_VERSIONS
```
public static final java.lang.String PROP_DPWS_SUPPORTED_DPWS_VERSIONS
```
    Property key for supported DPWS Versions
    
    See Also:
    
    Constant Field Values
  - PROP_DPWS_SOAPMSG_GENERATOR_FACTORY_CLASS
```
public static final java.lang.String PROP_DPWS_SOAPMSG_GENERATOR_FACTORY_CLASS
```
    Property key for class name of the factory for Message2SOAPGenerator and Message2SOAPGenerator implementing classes.
    
    See Also:
    
    Constant Field Values
  - PROP_MATCH_WAIT_TIME
```
public static final java.lang.String PROP_MATCH_WAIT_TIME
```
    Time to wait until a time exception is thrown, after a request was sent and no answer was received.
    Type: int
    Default: 10000
    
    See Also:
    
    Constant Field Values
  - HTTP_CHUNKED_OFF_IF_POSSIBLE
```
public static final int HTTP_CHUNKED_OFF_IF_POSSIBLE
```
    Don't use HTTP chunked encoding.
    
    BE AWARE! Invoke messages including an attachment of type InputStreamAttachment or OutgoingOutputStreamAttachment will always be send with chunked encoding.
    
    See Also:
    
    Constant Field Values
  - HTTP_CHUNKED_ON
```
public static final int HTTP_CHUNKED_ON
```
    Use HTTP chunked encoding.
    
    See Also:
    
    Constant Field Values
  - HTTP_CHUNKED_ON_FOR_INVOKE
```
public static final int HTTP_CHUNKED_ON_FOR_INVOKE
```
    Don't use HTTP chunked encoding for metadata exchange (wxf:Get), but use chunked encoding for invoke messages.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_HTTP_CHUNKED_MODE
```
public static final int DEFAULT_HTTP_CHUNKED_MODE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DPWSProperties
```
public DPWSProperties()
```
- Method Detail
  - getInstance
```
public static DPWSProperties getInstance()
```
  - getAvailableDPWSVersions
```
public Iterator getAvailableDPWSVersions()
```
  - getNativeRouter
```
public boolean getNativeRouter()
```
  - setNativeRouter
```
public void setNativeRouter(boolean b)
```
  - getNativeRouterIp
```
public java.lang.String getNativeRouterIp()
```
  - setNativeRouterIp
```
public void setNativeRouterIp(java.lang.String ip)
```
  - getNativeRouterPort
```
public int getNativeRouterPort()
```
  - setNativeRouterPort
```
public void setNativeRouterPort(int port)
```
  - getHTTPServerKeepAlive
```
public boolean getHTTPServerKeepAlive()
```
  - setHTTPServerKeepAlive
```
public void setHTTPServerKeepAlive(boolean b)
```
  - getHTTPClientKeepAlive
```
public boolean getHTTPClientKeepAlive()
```
  - setHTTPClientKeepAlive
```
public void setHTTPClientKeepAlive(boolean b)
```
  - getHTTPResponseChunkedMode
```
public int getHTTPResponseChunkedMode()
```
  - setHTTPResponseChunkedMode
```
public void setHTTPResponseChunkedMode(int i)
```
  - getHTTPRequestChunkedMode
```
public int getHTTPRequestChunkedMode()
```
  - setHTTPRequestChunkedMode
```
public void setHTTPRequestChunkedMode(int i)
```
  - getHTTPServerRequestTimeout
```
public long getHTTPServerRequestTimeout()
```
  - setHTTPServerRequestTimeout
```
public void setHTTPServerRequestTimeout(long timeout)
```
  - getHTTPClientRequestTimeout
```
public long getHTTPClientRequestTimeout()
```
  - setHTTPClientRequestTimeout
```
public void setHTTPClientRequestTimeout(long timeout)
```
  - getSOAPMessageGeneratorFactoryClass
```
public java.lang.String getSOAPMessageGeneratorFactoryClass()
```
  - setSOAPMessageGeneratorFactoryClass
```
public void setSOAPMessageGeneratorFactoryClass(java.lang.String className)
```
  - getMatchWaitTime
```
public long getMatchWaitTime()
```
    Gets time in millis for which the framework waits for a resolve matches or a probe matches message, before it throws a CommunicationException.
    
    Returns:
    
    time in millis.
  - setMatchWaitTime
```
public void setMatchWaitTime(long matchWaitTime)
```
    Sets time in millis for which the framework waits for a resolve matches or a probe matches message, before it throws a CommunicationException.
    
    Parameters:
    
    matchWaitTime - time in millis.
  - addSupportedDPWSVersion
```
public void addSupportedDPWSVersion(DPWSProtocolVersion dpwsProtocolVersion)
```
  - removeSupportedDPWSVersion
```
public void removeSupportedDPWSVersion(DPWSProtocolVersion dpwsProtocolVersion)
```
  - getSupportedDPWSVersions
```
public HashSet getSupportedDPWSVersions()
```
  - finishedSection
```
public void finishedSection(int depth)
```
    Description copied from interface: PropertiesHandler
    
    This method indicates the PropertiesHandler, that the last section with the given depth has been read completely.
    
    Specified by:
    
    finishedSection in interface PropertiesHandler
    
    Parameters:
    
    depth - depth of section.
  - printSupportedDPWSVersions
```
public java.lang.String printSupportedDPWSVersions()
```
  - setProperties
```
public void setProperties(PropertyHeader header,
                          Property property)
```
    Specified by:
    
    setProperties in interface PropertiesHandler
    
    Parameters:
    
    header - header of section
    
    property - property within section
  - getDefaultDpwsVersion
```
public static DPWSProtocolVersion getDefaultDpwsVersion()
```
  - setDefaultDpwsVersion
```
public static void setDefaultDpwsVersion(DPWSProtocolVersion defaultDpwsVersion)
```

Class DPWSProperties

Field Summary

Fields inherited from interface org.ws4d.java.configuration.PropertiesHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_DPWS_ROUTER

PROP_DPWS_ROUTER_ADDR

PROP_DPWS_ROUTER_PORT

PROP_DPWS_HTTP_SERVER_KEEPALIVE

PROP_DPWS_HTTP_CLIENT_KEEPALIVE

PROP_DPWS_HTTP_RESPONSE_CHUNKED_MODE

PROP_DPWS_HTTP_REQUEST_CHUNKED_MODE

PROP_DPWS_HTTP_SERVER_REQUEST_TIMEOUT

PROP_DPWS_HTTP_CLIENT_REQUEST_TIMEOUT

PROP_DPWS_SUPPORTED_DPWS_VERSIONS

PROP_DPWS_SOAPMSG_GENERATOR_FACTORY_CLASS

PROP_MATCH_WAIT_TIME

HTTP_CHUNKED_OFF_IF_POSSIBLE

HTTP_CHUNKED_ON

HTTP_CHUNKED_ON_FOR_INVOKE

DEFAULT_HTTP_CHUNKED_MODE

Constructor Detail

DPWSProperties

Method Detail

getInstance

getAvailableDPWSVersions

getNativeRouter

setNativeRouter

getNativeRouterIp

setNativeRouterIp

getNativeRouterPort

setNativeRouterPort

getHTTPServerKeepAlive

setHTTPServerKeepAlive

getHTTPClientKeepAlive

setHTTPClientKeepAlive

getHTTPResponseChunkedMode

setHTTPResponseChunkedMode

getHTTPRequestChunkedMode

setHTTPRequestChunkedMode

getHTTPServerRequestTimeout

setHTTPServerRequestTimeout

getHTTPClientRequestTimeout

setHTTPClientRequestTimeout

getSOAPMessageGeneratorFactoryClass

setSOAPMessageGeneratorFactoryClass

getMatchWaitTime

setMatchWaitTime

addSupportedDPWSVersion

removeSupportedDPWSVersion

getSupportedDPWSVersions

finishedSection

printSupportedDPWSVersions

setProperties

getDefaultDpwsVersion

setDefaultDpwsVersion