World Map
Java Service Wrapper is the easiest way to make your product more reliable.
  • Free Trial
  • Buy Now
wrapper.share.<n>.* Properties

Overview: Share General Properties

The wrapper.share.<n>.* properties enhance the use of Windows shares with the Wrapper.

A common problem:

A common problem when running as Windows Service was that with Windows XP and Microsoft Windows Server 2003, each logon session receives its own set of drive letters, A through Z. Therefore, redirected drives cannot be shared between processes that are running under different user accounts. Additionally, a service (or any process that is running in its own logon session) cannot access the drive letters that are established in a different logon session. However, drive letters that are mapped from a service that is running under the local System account are accessible and visible to all logon sessions.

<n> component:

The "<n>" component of the property name is an integer number counting up from "1". By default, there can be no missing numbers. The wrapper.ignore_sequence_gaps property can optionally be set to allow gaps in the sequence.

wrapper.share.<n>.location

Compatibility :3.5.0
Editions :Professional EditionStandard EditionCommunity Edition (Not Supported)
Platforms :WindowsMac OSX (Not Supported)Linux (Not Supported)IBM AIX (Not Supported)FreeBSD (Not Supported)HP-UX (Not Supported)Solaris (Not Supported)IBM z/OS (Not Supported)IBM z/Linux (Not Supported)

The location property sets the location of resource such as the Windows Share or Network Printer in UNC format.

Example:
wrapper.share.1.location=\\server\share

WARNING

The specified location must NOT have a trailing backslash '\' or the mapping will fail.

NOTE

Please note that this property is mandatory and does not have a default value.

wrapper.share.<n>.target

Compatibility :3.5.0
Editions :Professional EditionStandard EditionCommunity Edition (Not Supported)
Platforms :WindowsMac OSX (Not Supported)Linux (Not Supported)IBM AIX (Not Supported)FreeBSD (Not Supported)HP-UX (Not Supported)Solaris (Not Supported)IBM z/OS (Not Supported)IBM z/Linux (Not Supported)

The target property sets the target on the local machine to which the resource specified in wrapper.share.<n>.location property should get mapped to.

Example: (Map to a Network Drive)
wrapper.share.1.target=Y:

NOTE

Please note that this property is mandatory and does not have a default value.

wrapper.share.<n>.type

Compatibility :3.5.0
Editions :Professional EditionStandard EditionCommunity Edition (Not Supported)
Platforms :WindowsMac OSX (Not Supported)Linux (Not Supported)IBM AIX (Not Supported)FreeBSD (Not Supported)HP-UX (Not Supported)Solaris (Not Supported)IBM z/OS (Not Supported)IBM z/Linux (Not Supported)

The type property specifies the type of network resource to connect to. The following values are possible:

  • DISK --specifies a Network Drive.
  • PRINTER --specifies a network printer.
  • ANY --the Wrapper will try to mount the resource with the specification open.

The default value is "ANY".

Example:
wrapper.share.1.type=ANY

wrapper.share.<n>.account

Compatibility :3.5.0
Editions :Professional EditionStandard EditionCommunity Edition (Not Supported)
Platforms :WindowsMac OSX (Not Supported)Linux (Not Supported)IBM AIX (Not Supported)FreeBSD (Not Supported)HP-UX (Not Supported)Solaris (Not Supported)IBM z/OS (Not Supported)IBM z/Linux (Not Supported)

The account property is specified when users want to connect to a Network Resource for which they have been assigned a user name or account other than the default user name or account. If account is not specified, the Wrapper uses the account under which the Wrapper is running.

This property does not have a default value.

The naming conventions for this property are the same as for the wrapper.ntservice.account property.

Example:
wrapper.share.1.account=domain\user

NOTE

When running as a service under the LOCAL SYSTEM user, it is currently not supported to mount a remote resource under a different account. The property will be ignored (as well as the following password property).

wrapper.share.<n>.password

Compatibility :3.5.0
Editions :Professional EditionStandard EditionCommunity Edition (Not Supported)
Platforms :WindowsMac OSX (Not Supported)Linux (Not Supported)IBM AIX (Not Supported)FreeBSD (Not Supported)HP-UX (Not Supported)Solaris (Not Supported)IBM z/OS (Not Supported)IBM z/Linux (Not Supported)

This property sets the password affiliated to the account property above.

If the account property hasn't been specified, this property will be ignored.

Example:
wrapper.share.1.password=<pass>

NOTE

When running as a service under the LOCAL SYSTEM user, it is currently not supported to mount a remote resource under a different account. The property will be ignored (as well as the above account property ).

Putting it all together

The following example will mount

  • .location: the share location '\\192.168.0.3\wrapper'
  • .target: as Network Drive 'Y:'.
  • .account: It will try to mount the drive with the credentials of the specified 'sample\user' account
  • .password: with the spesified password.
  • .startup.premapped: If the drive 'Y:' has already been assigned, the Wrapper will try to 'CONTINUE'.
  • .startup.max_retries: If an error based on network troubles occurs, then the Wrapper will try to mount the Network Drive 5-times
  • .startup.retry_interval: with a delay between of each retry of 10 seconds.
  • .startup.failure: If a non-network related error occured or the network error persisted after the 5-times-retry, the Wrapper will SHUTDOWN itself.
  • .shutdown.unmap: If the Wrapper could mount the Network Drive, the Wrapper will UNMAP the Network Drive
  • .shutdown.unmap.force: with FORCE when shutting down.
Example:
wrapper.share.1.location=\\192.168.0.3\wrapper
wrapper.share.1.target=Y: 
wrapper.share.1.account=sample\user
wrapper.share.1.password=samplepass
wrapper.share.1.startup.premapped=CONTINUE
wrapper.share.1.startup.max_retries=5
wrapper.share.1.startup.retry_interval=10
wrapper.share.1.startup.failure=SHUTDOWN
wrapper.share.1.shutdown.unmap=TRUE
wrapper.share.1.shutdown.unmap.force=TRUE