JMapApplicationContext (JMap 7.0 Kathmandu API Documentation)

java.lang.Object
- com.kheops.jmap.client.JMapApplicationContext

```
public class JMapApplicationContext
extends java.lang.Object
```
This class contains useful information about a JMap client application. It is used to initialize JMap client extensions. It provides, for example, a reference to the application network connection, to the view manager, etc.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`APPLICATION_TYPE_APPLET` Constant for an applet application
`static int`	`APPLICATION_TYPE_JAVA_WEB_START` Constant for a Java Web Start application
`static int`	`APPLICATION_TYPE_STANDALONE` Constant for a standalone Java application

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addLicenseRestrictions(ClientLicenseRestrictions licenseRestrictions)`
`static void`	`destroy()` Destroys the JMapApplicationContext instance.
`JMapApplication`	`getApplication()` Returns the instance of the current JMap application.
`JMapApplicationActionManager`	`getApplicationActionManager()` Returns the instance of the current application actions manager.
`int`	`getApplicationType()` Returns the current application type.
`ArgumentParser`	`getArgumentParser()`
`JMapAutoZoomService`	`getAutoZoomService()` Returns the JMap AutoZoom service.
`java.net.URL`	`getBaseURL()`
`JMapSrvConnection`	`getConnection()`
`JMapContextManager`	`getContextManager()` Returns the context manager for this application.
`EncryptionCipher`	`getEncrypter()`
`java.awt.Frame`	`getFrame()`
`static JMapApplicationContext`	`getInstance()`
`java.io.File`	`getJMapHome()` The JMap home directory is the root directory where JMap writes its files (parameters,cached, data, etc.).
`ClientLicenseRestrictions`	`getLicenseRestrictions()`
`QueryInterfaceManager`	`getQueryInterfaceManager()`
`QueryManager`	`getQueryManager()` Returns the query manager for this application.
`java.net.URL`	`getReportURL()` Gets the URL to use for information reports.
`javax.swing.RootPaneContainer`	`getRootPaneContainer()`
`URLOpener`	`getURLOpener()`
`java.lang.String`	`getUsername()` Convenient function to safely obtain current connection's username if applicable.
`ViewManager`	`getViewManager()`
`ViewSyncGroup`	`getViewSyncGroup()` Returns the View Synchronize Group service.
`void`	`setApplication(JMapApplication jmapApplication)` Sets the instance of the current JMap application.
`void`	`setApplicationActionManager(JMapApplicationActionManager applicationActionManager)` Sets the instance of the current aplication actions manager.
`void`	`setApplicationType(int applicationType)` Sets the current application type.
`void`	`setArgumentParser(ArgumentParser argumentParser)`
`void`	`setBaseURL(java.net.URL baseURL)`
`void`	`setConnection(JMapSrvConnection connection)`
`void`	`setEncrypter(EncryptionCipher encrypter)`
`void`	`setJMapHome(java.io.File jMapHome)` Deprecated.
`void`	`setReportURL(java.net.URL reportURL)` Sets a URL to use for the information reports.
`void`	`setRootPaneContainer(javax.swing.RootPaneContainer rootPaneContainer)`
`void`	`setURLOpener(URLOpener URLOpener)`

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

- Field Detail
  - APPLICATION_TYPE_STANDALONE
```
public static final int APPLICATION_TYPE_STANDALONE
```
    Constant for a standalone Java application
    
    See Also:
    
    Constant Field Values
  - APPLICATION_TYPE_APPLET
```
public static final int APPLICATION_TYPE_APPLET
```
    Constant for an applet application
    
    See Also:
    
    Constant Field Values
  - APPLICATION_TYPE_JAVA_WEB_START
```
public static final int APPLICATION_TYPE_JAVA_WEB_START
```
    Constant for a Java Web Start application
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getInstance
```
public static JMapApplicationContext getInstance()
```
  - getBaseURL
```
public java.net.URL getBaseURL()
```
    Returns:
    
    the application base URL
  - setBaseURL
```
public void setBaseURL(java.net.URL baseURL)
```
    Parameters:
    
    baseURL - the application base URL
  - getURLOpener
```
public URLOpener getURLOpener()
```
    Returns:
    
    the application URL opener or null if not available
  - setURLOpener
```
public void setURLOpener(URLOpener URLOpener)
```
    Parameters:
    
    URLOpener - the application URL opener
  - getArgumentParser
```
public ArgumentParser getArgumentParser()
```
    Returns:
    
    the application argument parser or null if not available
  - setArgumentParser
```
public void setArgumentParser(ArgumentParser argumentParser)
```
    Parameters:
    
    argumentParser - the application argument parser
  - getConnection
```
public JMapSrvConnection getConnection()
```
    Returns:
    
    the application connection to JMapServer or null if not available
  - setConnection
```
public void setConnection(JMapSrvConnection connection)
```
    Parameters:
    
    connection - the application connection to JMapServer
  - getViewManager
```
public ViewManager getViewManager()
```
    Returns:
    
    the application view manager or null if not available
  - getQueryInterfaceManager
```
public QueryInterfaceManager getQueryInterfaceManager()
```
    Returns:
    
    the application query manager or null if not available
  - getFrame
```
public java.awt.Frame getFrame()
```
    Returns:
    
    the application main frame
  - getRootPaneContainer
```
public javax.swing.RootPaneContainer getRootPaneContainer()
```
    Returns:
    
    the application rootPaneContainer
  - setRootPaneContainer
```
public void setRootPaneContainer(javax.swing.RootPaneContainer rootPaneContainer)
```
    Parameters:
    
    rootPaneContainer - the application rootPaneContainer (JFrame or JApplet)
  - getApplicationType
```
public int getApplicationType()
```
    Returns the current application type.
    
    Returns:
    
    the current application type.
  - setApplicationType
```
public void setApplicationType(int applicationType)
```
    Sets the current application type.
    
    Parameters:
    
    applicationType - the current application type.
  - getLicenseRestrictions
```
public final ClientLicenseRestrictions getLicenseRestrictions()
```
  - addLicenseRestrictions
```
public final void addLicenseRestrictions(ClientLicenseRestrictions licenseRestrictions)
```
  - getApplication
```
public JMapApplication getApplication()
```
    Returns the instance of the current JMap application.
    
    Returns:
    
    the instance of the JMap application.
  - setApplication
```
public void setApplication(JMapApplication jmapApplication)
```
    Sets the instance of the current JMap application.
    
    Parameters:
    
    jmapApplication - the instance of the JMap application.
  - getApplicationActionManager
```
public JMapApplicationActionManager getApplicationActionManager()
```
    Returns the instance of the current application actions manager.
    
    Returns:
    
    the application actions manager
    
    See Also:
    
    JMapApplicationActionManager
  - setApplicationActionManager
```
public void setApplicationActionManager(JMapApplicationActionManager applicationActionManager)
```
    Sets the instance of the current aplication actions manager.
    
    Parameters:
    
    applicationActionManager - the application actions manager
    
    See Also:
    
    JMapApplicationActionManager
  - getQueryManager
```
public QueryManager getQueryManager()
```
    Returns the query manager for this application.
    
    Returns:
    
    a query manager
    
    See Also:
    
    QueryManager
  - getContextManager
```
public JMapContextManager getContextManager()
```
    Returns the context manager for this application.
    
    Returns:
    
    a context manager
    
    See Also:
    
    JMapContextManager
  - getAutoZoomService
```
public JMapAutoZoomService getAutoZoomService()
```
    Returns the JMap AutoZoom service.
    
    Returns:
    
    autoZoom service
    
    See Also:
    
    JMapAutoZoomService
  - getViewSyncGroup
```
public ViewSyncGroup getViewSyncGroup()
```
    Returns the View Synchronize Group service.
    
    Returns:
    
    viewSyncGroup service
    
    See Also:
    
    ViewSyncGroup
  - getEncrypter
```
public EncryptionCipher getEncrypter()
```
  - setEncrypter
```
public void setEncrypter(EncryptionCipher encrypter)
```
  - destroy
```
public static void destroy()
```
    Destroys the JMapApplicationContext instance.
  - getJMapHome
```
public java.io.File getJMapHome()
```
    The JMap home directory is the root directory where JMap writes its files (parameters,cached, data, etc.). This directory is called .jmap and is normally located inside the user's home directory.
    
    Returns:
    
    the JMap home directory where JMap writes its files.
  - setJMapHome
```
@Deprecated
public void setJMapHome(java.io.File jMapHome)
```
    Deprecated.
    
    Sets the JMap home directory.
    
    Parameters:
    
    jMapHome - the new JMap home directory
  - setReportURL
```
public void setReportURL(java.net.URL reportURL)
```
    Sets a URL to use for the information reports. See getReportURL() for details.
    
    Parameters:
    
    reportURL -
  - getReportURL
```
public java.net.URL getReportURL()
```
    Gets the URL to use for information reports. By default, the value is the application base URL plus /reports. It can overriden by using the setReportURL(url) method or can be set in application launch parameters using 'reportpath', for example, absolute path: -reportpath http://www.jmap.com:8090/customDir/ or relative path: -reportpath /customDir/
    
    Returns:
    
    URL for information reports
  - getUsername
```
public java.lang.String getUsername()
```
    Convenient function to safely obtain current connection's username if applicable.
    
    Returns:
    
    current username or default value

Class JMapApplicationContext

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

APPLICATION_TYPE_STANDALONE

APPLICATION_TYPE_APPLET

APPLICATION_TYPE_JAVA_WEB_START

Method Detail

getInstance

getBaseURL

setBaseURL

getURLOpener

setURLOpener

getArgumentParser

setArgumentParser

getConnection

setConnection

getViewManager

getQueryInterfaceManager

getFrame

getRootPaneContainer

setRootPaneContainer

getApplicationType

setApplicationType

getLicenseRestrictions

addLicenseRestrictions

getApplication

setApplication

getApplicationActionManager

setApplicationActionManager

getQueryManager

getContextManager

getAutoZoomService

getViewSyncGroup

getEncrypter

setEncrypter

destroy

getJMapHome

setJMapHome

setReportURL

getReportURL

getUsername