chemaxon.marvin.services

Class ServiceDescriptorTools

java.lang.Object

chemaxon.marvin.services.ServiceDescriptorTools

@PublicAPI
public class ServiceDescriptorTools
extends java.lang.Object

Helper class for accessing ServiceDescriptorReader, ServiceDescriptorWriter and ServiceDialogProvider implementations and various configuration data for services.

Since:

5.6

Version:

5.12

Author:

Istvan Rabel

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SERVICE_CONFIGURATION_PATH Path to default services configuration xml
static java.lang.String	DEFAULT_SERVICE_DESCRIPTOR_EDITOR_PROVIDER_CLASSNAME the Marvin Default service descriptor editor provider class
static java.lang.String	DEFAULT_SERVICE_DESCRIPTOR_READER_CLASSNAME the Marvin Default service descriptor reader class
static java.lang.String	DEFAULT_SERVICE_DESCRIPTOR_WRITER_CLASSNAME the Marvin Default service descriptor writer class
static java.lang.String	DEFAULT_SERVICE_DIALOG_PROVIDER_CLASSNAME the Marvin Default service dialog provider class
static java.lang.String	DEFAULT_USER_SERVICE_CONFIGURATION_FILENAME name of default user service configuration file
static java.lang.String	SERVICE_CONFIGURATION_PATH_PROPERTY_KEY Java System Property key to globally override default configuration path.
static java.lang.String	SERVICE_DIALOG_PROVIDER_CLASS_NAME_PROPERTY_KEY Java System Property key to globally override default Service Dialog Provider class with custom implementation.

Constructor Summary

Constructors

Constructor and Description
ServiceDescriptorTools()

Method Summary

Modifier and Type	Method and Description
static ServiceDescriptorEditorProvider	getDefaultServiceDescriptorEditorProvider() Returns the default ServiceDescriptorEditorProvider instance
static ServiceDescriptorReader	getDefaultServiceDescriptorReader() Returns the default ServiceDescriptorReader instance
static ServiceDescriptorWriter	getDefaultServiceDescriptorWriter() Returns the default ServiceDescriptorWriter instance
static ServiceDialogProvider	getDefaultServiceDialogProvider() Returns the default ServiceDialogProvider instance
static java.io.InputStream	getServiceDescriptorConfigurationAsStream() Returns an InputStream with service configuration.
static java.io.InputStream	getServiceDescriptorConfigurationAsStream(java.lang.String configPath) Returns the service descriptor configuration stream from path, or null.
static java.io.InputStream	getServiceDescriptorConfigurationAsStream(UserSettings settings) Returns an InputStream with service configuration.
static ServiceDescriptorEditorProvider	getServiceDescriptorEditorProvider(java.lang.String serviceDescriptorEditorProviderClassName) Returns the ServiceDescriptorEditorProvider instance if available, or null
static ServiceDescriptorReader	getServiceDescriptorReader(java.lang.String descriptorReaderClassName) Returns the ServiceDescriptorReader instance if available, or null
static ServiceDescriptorWriter	getServiceDescriptorWriter(java.lang.String descriptorWriterClassName) Returns the ServiceDescriptorWriter instance if available, or null
static ServiceDialogProvider	getServiceDialogProvider(java.lang.String serviceDialogProviderClassName) Returns the ServiceDialogProvider instance if available, or null

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_CONFIGURATION_PATH_PROPERTY_KEY

public static final java.lang.String SERVICE_CONFIGURATION_PATH_PROPERTY_KEY

Java System Property key to globally override default configuration path. Accepts absolute file path or URL in String format.

Since:

5.12

See Also:

Constant Field Values

SERVICE_DIALOG_PROVIDER_CLASS_NAME_PROPERTY_KEY

public static final java.lang.String SERVICE_DIALOG_PROVIDER_CLASS_NAME_PROPERTY_KEY

Java System Property key to globally override default Service Dialog Provider class with custom implementation.

Since:

6.0

See Also:

Constant Field Values

DEFAULT_SERVICE_DESCRIPTOR_READER_CLASSNAME

public static final java.lang.String DEFAULT_SERVICE_DESCRIPTOR_READER_CLASSNAME

the Marvin Default service descriptor reader class

See Also:

Constant Field Values

DEFAULT_SERVICE_DESCRIPTOR_WRITER_CLASSNAME

public static final java.lang.String DEFAULT_SERVICE_DESCRIPTOR_WRITER_CLASSNAME

the Marvin Default service descriptor writer class

See Also:

Constant Field Values

DEFAULT_SERVICE_DIALOG_PROVIDER_CLASSNAME

public static final java.lang.String DEFAULT_SERVICE_DIALOG_PROVIDER_CLASSNAME

the Marvin Default service dialog provider class

See Also:

Constant Field Values

DEFAULT_SERVICE_DESCRIPTOR_EDITOR_PROVIDER_CLASSNAME

public static final java.lang.String DEFAULT_SERVICE_DESCRIPTOR_EDITOR_PROVIDER_CLASSNAME

the Marvin Default service descriptor editor provider class

See Also:

Constant Field Values

DEFAULT_SERVICE_CONFIGURATION_PATH

public static final java.lang.String DEFAULT_SERVICE_CONFIGURATION_PATH

Path to default services configuration xml

See Also:

Constant Field Values

DEFAULT_USER_SERVICE_CONFIGURATION_FILENAME

public static final java.lang.String DEFAULT_USER_SERVICE_CONFIGURATION_FILENAME

name of default user service configuration file

See Also:

Constant Field Values

Constructor Detail

ServiceDescriptorTools

public ServiceDescriptorTools()

Method Detail

getDefaultServiceDescriptorReader

public static ServiceDescriptorReader getDefaultServiceDescriptorReader()

Returns the default ServiceDescriptorReader instance

Returns:

the default ServiceDescriptorReader instance, or null if no service descriptor reader is available

getDefaultServiceDescriptorWriter

public static ServiceDescriptorWriter getDefaultServiceDescriptorWriter()

Returns the default ServiceDescriptorWriter instance

Returns:

the default ServiceDescriptorWriter instance, or null if no service descriptor writer is available

getDefaultServiceDialogProvider

public static ServiceDialogProvider getDefaultServiceDialogProvider()

Returns the default ServiceDialogProvider instance

Returns:

the default ServiceDialogProvider instance, or null if no service dialog provider is available

getDefaultServiceDescriptorEditorProvider

public static ServiceDescriptorEditorProvider getDefaultServiceDescriptorEditorProvider()

Returns the default ServiceDescriptorEditorProvider instance

Returns:

the default ServiceDescriptorEditorProvider instance, or null if no service descriptor editor provider is available

getServiceDescriptorConfigurationAsStream

public static java.io.InputStream getServiceDescriptorConfigurationAsStream()

Returns an InputStream with service configuration.

Returns:

an InputStream with service configuration or null if not possible to get a configuration

getServiceDescriptorConfigurationAsStream

public static java.io.InputStream getServiceDescriptorConfigurationAsStream(UserSettings settings)

Returns an InputStream with service configuration.

Parameters:

settings - the user settings

Returns:

an InputStream with service configuration or null if not possible to get a configuration

getServiceDescriptorConfigurationAsStream

public static java.io.InputStream getServiceDescriptorConfigurationAsStream(java.lang.String configPath)

Returns the service descriptor configuration stream from path, or null.

Parameters:

configPath - the path or URL to service descriptor configuration. Empty String or null falls back to default configuration file.

Returns:

the service descriptor configuration stream from path, or null

Since:

5.10

getServiceDescriptorReader

public static ServiceDescriptorReader getServiceDescriptorReader(java.lang.String descriptorReaderClassName)

Returns the ServiceDescriptorReader instance if available, or null

Parameters:

descriptorReaderClassName - the class name of the service descriptor writer

Returns:

the ServiceDescriptorReader instance if available, or null

getServiceDescriptorWriter

public static ServiceDescriptorWriter getServiceDescriptorWriter(java.lang.String descriptorWriterClassName)

Returns the ServiceDescriptorWriter instance if available, or null

Parameters:

descriptorWriterClassName - the class name of the service descriptor writer

Returns:

the ServiceDescriptorWriter instance if available, or null

getServiceDialogProvider

public static ServiceDialogProvider getServiceDialogProvider(java.lang.String serviceDialogProviderClassName)

Returns the ServiceDialogProvider instance if available, or null

Parameters:

serviceDialogProviderClassName - the class name of the service dialog provider

Returns:

the ServiceDialogProvider instance if available, or null

getServiceDescriptorEditorProvider

public static ServiceDescriptorEditorProvider getServiceDescriptorEditorProvider(java.lang.String serviceDescriptorEditorProviderClassName)

Returns the ServiceDescriptorEditorProvider instance if available, or null

Parameters:

serviceDescriptorEditorProviderClassName - the class name of the service descriptor editor provider

Returns:

the ServiceDescriptorEditorProvider instance if available, or null