Package com.kheops.jmap.server

Class JMapServer

java.lang.Object
com.kheops.jmap.server.JMapServer
All Implemented Interfaces:
JMapServerConstants, JMapServerEventListener, EventListener
@ComponentScan({"com.kheops.jmap.server","com.k2.jmapcloud","com.k2.jmap.hibernate","com.k2.jmap.resources"}) public final class JMapServer extends Object implements JMapServerConstants, JMapServerEventListener

  • Method Details

    • getFullVersion

      public static String getFullVersion()
      Returns the complete version information (eg. JMapServer version 4.0.0000).
      Returns:
      the version information

    • getVersion

      public static String getVersion()
      Returns the version number (eg. 4.0.0000).
      Returns:
      the version information

    • getJMapHome

      public static String getJMapHome()

    • getBuildNumber

      public static String getBuildNumber()
      Returns the build number that is contained in file 'version'.
      Returns:
      build number

    • getMaintenanceNumber

      public static String getMaintenanceNumber()
      Returns the maintenance number that is contained in file 'version'.
      Returns:
      maintenance number

    • getHotFixNumber

      public static String getHotFixNumber()
      Returns the hotfix number that is contained in file 'version'.
      Returns:
      hotfix number

    • getBuildName

      public static String getBuildName()
      Returns the buildName that is contained in file 'version'.
      Returns:
      buildName

    • addListener

      public void addListener(JMapServerEventListener l)

    • removeListener

      public void removeListener(JMapServerEventListener l)

    • fireStateChangeEvent

      protected void fireStateChangeEvent(int oldState, int newState)

    • setServerState

      public void setServerState(int serverState)

    • clientThreadPutToSleepOccurred

      public void clientThreadPutToSleepOccurred(JMapServerClientThreadEvent e)
      Specified by:
      clientThreadPutToSleepOccurred in interface JMapServerEventListener

    • serverStateChangeOccurred

      public void serverStateChangeOccurred(JMapServerStateChangeEvent e)
      Specified by:
      serverStateChangeOccurred in interface JMapServerEventListener

    • getDataManager

      public JMapServerDataManager getDataManager()

    • getPersonalDataManager

      public JMapServerPersonalDataManager getPersonalDataManager()

    • getSystemData

      @Deprecated public JMapServerSystemData getSystemData()
      Deprecated.
      use server controllers to access and modify the system database.
      Returns an instance to the live configuration database.
      Returns:
      an instance to the live configuration database.

    • updateSystemParams

      public boolean updateSystemParams(JMapServerSysParams systemParameters)

    • getWorkerExecutorService

      public ExecutorService getWorkerExecutorService()

    • getCipher

      public JMapCipher getCipher()

    • getDBConnPool

      public DatabaseConnectionPool getDBConnPool(int id)

    • getSdeConnPool

      public SdeConnectionPool getSdeConnPool(int id)

    • getSdeConnPool

      public SdeConnectionPool getSdeConnPool(String name)

    • getDBConnPool

      public DatabaseConnectionPool getDBConnPool(String name)

    • getJMapServerRemoteConnPool

      public JMapServerRemoteConnectionPool getJMapServerRemoteConnPool(String name)

    • getJMapServerRemoteConnPool

      public JMapServerRemoteConnectionPool getJMapServerRemoteConnPool(int id)

    • getSdeConnPools

      public Collection<SdeConnectionPool> getSdeConnPools()

    • getExtension

      public JMapServerExtensionDescriptor getExtension(String reqType)
      Returns the extension corresponding to the specified request type.
      Parameters:
      reqType - the request type

    • getExtensions

      public Hashtable<String,JMapServerExtensionDescriptor> getExtensions()
      Returns the table of registered extensions.

    • getUserManager

      public UserManager getUserManager()
      Returns:
      The user manager currently in use by JMap Server

    • setUserManager

      public void setUserManager(UserManager userManager, boolean synchronizePermissions)
      Sets a new UserManager on JMap Server.
      Parameters:
      userManager - the UserManager that will be used to authenticate logins
      synchronizePermissions - a boolean that indicates whether permissions will be synchronized with the new UserManager.

    • setUserManagerSynchronization

      public void setUserManagerSynchronization(UserManagerSynchronizer.Period period, int interval)

    • synchronizeUserManager

      public void synchronizeUserManager()

    • getSessionManager

      public JMapServerSessionManager getSessionManager()

    • getSpatialReaders

      public String[] getSpatialReaders()

    • getSpatialDataSources

      public String[] getSpatialDataSources()

    • getProjectionManager

      public ProjectionManager getProjectionManager()

    • getSessionLogger

      public SessionLogger getSessionLogger()

    • getDocumentsManager

      public DocumentsManager getDocumentsManager()

    • getContextsManager

      public ContextsManager getContextsManager()

    • getElementFactories

      public String[] getElementFactories()

    • getDatabaseConfigFile

      public File getDatabaseConfigFile(String driverClassName, String url)
      Returns a reference to the XML file that contains the configuration for the specified driver class name.
      Parameters:
      driverClassName - a driver class name.
      Returns:
      a reference to the XML file that contains the configuration for the specified driver class name.

    • getDatabaseConfig

      public DatabaseConfig getDatabaseConfig(String driverClassName, String url)
      Returns a DatabaseConfig object that contains the configuration for the specified driver class name.
      Parameters:
      driverClassName - a driver class name.
      Returns:
      a DatabaseConfig object that contains the configuration for the specified driver class name.

    • getDatabaseConfigs

      public DatabaseConfig[] getDatabaseConfigs()
      Returns all available DatabaseConfig objects which define all databases that can be used with JMap Server.
      Returns:
      all available DatabaseConfig objects which define all databases that can be used with JMap Server.

    • getMonitoringInfo

      public JMapServerMonitoringInfo getMonitoringInfo()

    • reInitSystemDatabase

      public boolean reInitSystemDatabase(JMapServerSysParams newSysParams) throws Exception
      Throws:
      Exception

    • reInitExtensions

      public void reInitExtensions(String[] requestTypes)
      Reinitialize the specified extensions. For each extension, the destroy method will be called followed by a call to the init method.
      Parameters:
      requestTypes - the request types for the extensions to reinitialize

    • enableExtensions

      public void enableExtensions(String[] requestTypes, boolean isEnabled)

    • initCustomSpatialDataSources

      public boolean initCustomSpatialDataSources()

    • reloadClassParameters

      public boolean reloadClassParameters()

    • reloadLicense

      public void reloadLicense() throws Exception
      Throws:
      Exception

    • saveSystemProperties

      public boolean saveSystemProperties()

    • saveSystemProperties

      @Deprecated public boolean saveSystemProperties(Properties properties)
      Deprecated.
      use updateSystemParams(JMapServerSysParams) instead.

    • getWorkSpaceManager

      public WorkSpaceManager getWorkSpaceManager()
      Returns the WorkSpaces manager.
      Returns:
      WorkSpace manager

    • getMessagingController

      public MessagingController getMessagingController()

    • getLicenseManager

      public final LicenseManager getLicenseManager()
      Returns the license manager of this instance of JMap Server.
      See Also:

    • getSerialNumber

      public String getSerialNumber()
      Returns the serial number of this instance of JMap Server.

    • reInitDatabaseConnectionPools

      public void reInitDatabaseConnectionPools(int[] poolIds)

    • addRemoteConnectionPool

      public JMapServerRemoteConnectionPool addRemoteConnectionPool(JMapServerRemoteConnectionPoolInfo poolInfo)

    • deleteRemoteConnectionPool

      public void deleteRemoteConnectionPool(int poolId)

    • addDatabaseConnPool

      public DatabaseConnectionPool addDatabaseConnPool(DatabaseConnectionPoolInfo poolInfo)

    • deleteDatabaseConnectionPool

      public void deleteDatabaseConnectionPool(int poolId)

    • addSdeConnPool

      public SdeConnectionPool addSdeConnPool(SdeConnectionPoolInfo info)
      Adds a new Connection Pool info and creates new SDEConnectionPool using the specified ConnPoolInfo
      Parameters:
      info - the SdeConnectionPoolInfo
      Returns:
      the connection pool

    • addSdeConnPool

      public SdeConnectionPool addSdeConnPool(SdeConnectionPoolInfo info, SdeConnectionPool connPool)
      Adds the new connection pool info and the associated Connection Pool
      Parameters:
      info - the SdeConnectionPoolInfo
      connPool - the specified SdeConnectionPool
      Returns:
      the connection pool

    • deleteSdeConnectionPool

      public void deleteSdeConnectionPool(int id)

    • initRemoteServerConnection

      public boolean initRemoteServerConnection(JMapServerRemoteConnectionPoolInfo poolInfo)

    • setNoHttp

      public void setNoHttp(boolean flag)
      Sets the flag that determines if the embedded http server must be started.
      Parameters:
      flag - if true, http server will not be started.

    • checkAdminPermission

      public boolean checkAdminPermission(User user)

    • getWebAdminAllowedUsers

      public Hashtable<?,?> getWebAdminAllowedUsers()

    • getWebAdminAllowedGroups

      public Hashtable<?,?> getWebAdminAllowedGroups()

    • getWebEngine

      public EmbeddedTomcat getWebEngine()

    • removeImageProducer

      public void removeImageProducer(int projectId)

    • getImageProducer

      public JMSImageProducer getImageProducer(int projectId)

    • getImageProducer

      protected JMSImageProducer getImageProducer(JMapServerProject serverProject)

    • deleteImageProducers

      protected void deleteImageProducers()

    • getMajorVersion

      public static String getMajorVersion()
      Returns the major version string of JMap Server (ex: 2.1)
      Returns:
      the major version

    • getServerInfo

      public JMapServerInfo getServerInfo(long remoteTime)
      Returns a JMapServerInfo instance which contains information about this JMap Server.
      Returns:
      a JMapServerInfo instance.

    • getReflections

      protected org.reflections.Reflections getReflections()

    • getAnnotatedClassNames

      public String[] getAnnotatedClassNames(Class<? extends Annotation> annotatedWith)

    • getAnnotatedClassNames

      public String[] getAnnotatedClassNames(Class<? extends Annotation> annotatedWith, Class assignableFrom)

    • getCodedValuesProviders

      public String[] getCodedValuesProviders()

    • getAddress

      public InetAddress getAddress() throws UnknownHostException
      Throws:
      UnknownHostException

    • getGeoWebCacheManager

      public GWCManager getGeoWebCacheManager()

    • getUpdateDescriptors

      protected List<UpdateDescriptor> getUpdateDescriptors()

    • getNotifications

      protected List<Notification> getNotifications()

    • shutdown

      public static void shutdown(String[] args)

    • main

      public static void main(String[] args)