Module com.itemis.jscdlib

Package com.itemis.jscdlib.discovery

Class JScdEnvSocketDiscovery

java.lang.Object

com.itemis.jscdlib.discovery.JScdEnvSocketDiscovery

All Implemented Interfaces:

JScdSocketDiscovery

public final class JScdEnvSocketDiscovery
extends Object
implements JScdSocketDiscovery

Use the environment to discover scdaemon's socket file path.

System properties have priority over environment variables, i. e. if both are available, the system property wins.

Supported values:

• System property "jscdlib.socket.file" - Absolute path to socket file
• Environment variable "GNUPGHOME" - Will be appended with "S.scdaemon" to form a path to a probable socket file.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GNUPGHOME_ENV_KEY	Name of environment variable that holds the path to the GPG installation root.
static final String	JSCDLIB_SOCKET_FILE_PROP_KEY	System property that must hold the absolute path to the socket file.
static final String	SOCKET_FILE_NAME	Expected default name of scdaemon's socket file.

Constructor Summary

Constructors

Constructor	Description
JScdEnvSocketDiscovery()

Method Summary

Modifier and Type	Method	Description
Path	discover()

Methods inherited from class java.lang.Object

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

Field Details

JSCDLIB_SOCKET_FILE_PROP_KEY

public static final String JSCDLIB_SOCKET_FILE_PROP_KEY

System property that must hold the absolute path to the socket file. Supersedes GNUPGHOME_ENV_KEY.

See Also:

• Constant Field Values

GNUPGHOME_ENV_KEY

public static final String GNUPGHOME_ENV_KEY

Name of environment variable that holds the path to the GPG installation root. Is superseded by JSCDLIB_SOCKET_FILE_PROP_KEY

See Also:

• Constant Field Values

SOCKET_FILE_NAME

public static final String SOCKET_FILE_NAME

Expected default name of scdaemon's socket file.

See Also:

• Constant Field Values

Constructor Details

JScdEnvSocketDiscovery

public JScdEnvSocketDiscovery()

Method Details

discover

public Path discover()

Specified by:

discover in interface JScdSocketDiscovery

Returns:

A valid Path to scdaemon's socket file.