com.esri.gpt.sdisuite
Class IntegrationContextFactory

java.lang.Object
  com.esri.gpt.sdisuite.IntegrationContextFactory

public class IntegrationContextFactory
extends Object

A factory for configuring and instantiating the sdi.suite integration context.

Field Summary

static String

CONFIG_FILE The configuration file location.

Constructor Summary

IntegrationContextFactory()
Default constructor

Method Summary

StringAttributeMap	getConfiguration() Gets the configuration.
String	getLicensesUrl() Gets the URL for viewing a user's license list..
String	getSecurityManagerUrl() Gets the URL to the security manager user interface.
String	getServiceMonitorUrl() Gets the URL to the service monitor user interface.
String	getSmartEditorStartWithUrl() Gets the URL to the smart editor user interface (for opening an existing document).
String	getSmartEditorUrl() Gets the URL to the smart editor user interface.
boolean	isIntegrationEnabled() Determines if the integrating is enabled.
static void	main(String[] args) Main unit test method.
IntegrationContext	newIntegrationContext() Instantiates a new integration context.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_FILE

public static final String CONFIG_FILE

The configuration file location.

See Also:

Constant Field Values

Constructor Detail

IntegrationContextFactory

public IntegrationContextFactory()

Default constructor

Method Detail

main

public static void main(String[] args)

Main unit test method.

Parameters:

args - startup arguments

getConfiguration

public StringAttributeMap getConfiguration()

Gets the configuration.

Returns:

the configuration (can be null)

getLicensesUrl

public String getLicensesUrl()

Gets the URL for viewing a user's license list..

Returns:

the URL (can be null if not integrated)

getSecurityManagerUrl

public String getSecurityManagerUrl()

Gets the URL to the security manager user interface.

Returns:

the URL (can be null if not integrated)

getServiceMonitorUrl

public String getServiceMonitorUrl()

Gets the URL to the service monitor user interface.

Returns:

the URL (can be null if not integrated)

getSmartEditorUrl

public String getSmartEditorUrl()

Gets the URL to the smart editor user interface.

Returns:

the URL (can be null if not integrated)

getSmartEditorStartWithUrl

public String getSmartEditorStartWithUrl()

Gets the URL to the smart editor user interface (for opening an existing document).

Returns:

the URL (can be null if not integrated)

isIntegrationEnabled

public boolean isIntegrationEnabled()

Determines if the integrating is enabled.

Returns:

true if enabled

newIntegrationContext

public IntegrationContext newIntegrationContext()
                                         throws ClassNotFoundException,
                                                InstantiationException,
                                                IllegalAccessException

Instantiates a new integration context.

This instantiated class is based upon the configuration parameter:
gpt/config/gpt-tc.xml ... //parameter/@key="sdisuite.integrationContextClass"

The method will return null if:
gpt/config/gpt-tc.xml does not exist
//parameter/@key="sdisuite.enabled" is not set to true
//parameter/@key="sdisuite.integrationContextClass" is empty

Returns:

the integration context (can be null if not integrated)

Throws:

ClassNotFoundException - if the class was not found

InstantiationException - if the class could not be instantiated

IllegalAccessException - if the class could not be accessed