com.kheops.jmap.server

Class JMapServer

java.lang.Object

com.kheops.jmap.server.JMapServer

All Implemented Interfaces:

JMapServerConstants, JMapServerEventListener, java.util.EventListener

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JMapServer.CheckLicensedProductsTask
class	JMapServer.UpdateCheckerTask
class	JMapServer.ValidateLicenseTask

Field Summary

Fields inherited from interface com.kheops.jmap.server.JMapServerConstants

APPLICATIONS_HOME, CUSTOM_PROJECTIONS_FILENAME, CUSTOM_PROJECTIONS_PATH, CUSTOM_STROKES_FILENAME, CUSTOM_STROKES_PATH, ICONS_HOME, JMAPADMIN_FILEBROWSER_ROOTS, JMAPADMIN_HOME, JMAPSRV_ALLOW_UPLOAD, JMAPSRV_API_KEY_BING, JMAPSRV_API_KEY_GOOGLE, JMAPSRV_API_KEY_MAPBOX, JMAPSRV_CACHEPATH_KEY, JMAPSRV_CONF_HOME, JMAPSRV_CONNECTIONPOOL_INACTIVE_ALL, JMAPSRV_DATABASE_CONNECTIONPOOL_INACTIVE, JMAPSRV_DATABASE_CONNECTIONPOOL_TIMEOUT, JMAPSRV_DBPATH_KEY, JMAPSRV_DISK_CACHE_SIZE_KEY, JMAPSRV_DOCUMENTS_PATH, JMAPSRV_EXTENSIONS_PATH, JMAPSRV_EXTENSIONS_PROPS_FILENAME, JMAPSRV_GEOWEBCACHE_PASSWORD_KEY, JMAPSRV_GEOWEBCACHE_URL_KEY, JMAPSRV_GEOWEBCACHE_USERNAME_KEY, JMAPSRV_HTTPPROXY_HOST_KEY, JMAPSRV_HTTPPROXY_PASSWORD_KEY, JMAPSRV_HTTPPROXY_PORT_KEY, JMAPSRV_HTTPPROXY_USERNAME_KEY, JMAPSRV_HTTPS_CLIENT_AUTH, JMAPSRV_HTTPS_KEYSTORE_FILE, JMAPSRV_HTTPS_KEYSTORE_PASSWORD, JMAPSRV_HTTPS_KEYSTORE_PASSWORD_ENCRYPTED, JMAPSRV_HTTPS_KEYSTORE_TYPE, JMAPSRV_HTTPS_PORT, JMAPSRV_HTTPS_REDIRECT_ENABLED, JMAPSRV_HTTPS_SCHEME, JMAPSRV_HTTPS_SSL_ENABLED_PROTOCOLS, JMAPSRV_HTTPS_SSL_PROTOCOL, JMAPSRV_IMAGE_CACHE_SIZE_KEY, JMAPSRV_JMAPCLOUD_API_KEY, JMAPSRV_JMAPCLOUD_DEFAULT_OWNER, JMAPSRV_JMAPCLOUD_HOST, JMAPSRV_JMAPCLOUD_ORGANIZATION_ID, JMAPSRV_LOCAL_SERVER_POOLID, JMAPSRV_MAINLOGAGELIMIT_KEY, JMAPSRV_MAINLOGCONSOLE_KEY, JMAPSRV_MAINLOGLEVEL_KEY, JMAPSRV_MAINLOGPATH_KEY, JMAPSRV_MAINLOGROLLOVER_KEY, JMAPSRV_MAX_UPLOAD_FILE_SIZE, JMAPSRV_MEM_CACHE_SIZE_KEY, JMAPSRV_PROPS_FILENAME, JMAPSRV_PROPS_NAME, JMAPSRV_REMOTE_CONNECTIONPOOL_INACTIVE, JMAPSRV_REMOTE_CONNECTIONPOOL_TIMEOUT, JMAPSRV_REMOTE_LAYER_CACHE_TIMEOUT, JMAPSRV_REMOTE_SDS_CACHE_TIMEOUT, JMAPSRV_REST_API_URL_KEY, JMAPSRV_RLS_CLIENT_ID_KEY, JMAPSRV_RLS_HOST_KEY, JMAPSRV_SDE_CONNECTIONPOOL_TIMEOUT, JMAPSRV_SERVER_DEFAULT_AVAILABLE_LANGUAGES_KEY, JMAPSRV_SERVER_DEFAULT_LANGUAGE_KEY, JMAPSRV_SERVER_TITLE_KEY, JMAPSRV_SERVER_VIEWPOOL_TIMEOUT, JMAPSRV_SERVERADDRESS_KEY, JMAPSRV_SERVERPORT_KEY, JMAPSRV_SESSIONLOGAGELIMIT_KEY, JMAPSRV_SMTPENCRYPTION_KEY, JMAPSRV_SMTPHOST_KEY, JMAPSRV_SMTPPASSWORD_KEY, JMAPSRV_SMTPPORT_KEY, JMAPSRV_SMTPUSERNAME_KEY, JMAPSRV_SPATIAL_DATA_SOURCE_INIT_TIMEOUT, JMAPSRV_STATE_RUNNING, JMAPSRV_STATE_SHUTDOWN, JMAPSRV_STATE_STARTING, JMAPSRV_STATE_STOPPED, JMAPSRV_SYSDB_MAXUPDATINGTHREADS, JMAPSRV_SYSDBCONFFILE_KEY, JMAPSRV_SYSDBMAXPOOLSIZE_KEY, JMAPSRV_SYSDBPASSWD_KEY, JMAPSRV_SYSDBPOOL_NAME, JMAPSRV_SYSDBPOOLID, JMAPSRV_SYSDBPOOLSIZE_KEY, JMAPSRV_SYSDBRECYCLEPERIOD_KEY, JMAPSRV_SYSDBURL_KEY, JMAPSRV_SYSDBUSER_KEY, JMAPSRV_SYSTEMBACKUP_KEY, JMAPSRV_SYSTEMDATA_NAME, JMAPSRV_THREADPOOLSIZE_KEY, JMAPSRV_TOMCAT_ADDRESS_KEY, JMAPSRV_TOMCAT_AJP13PORT_KEY, JMAPSRV_TOMCAT_MAX_HEADER_SIZE_KEY, JMAPSRV_TOMCAT_MAX_POST_SIZE_KEY, JMAPSRV_TOMCAT_PORT_KEY, JMAPSRV_UPLOAD_ROOT_FOLDER, JMAPSRV_USERDB_NAME, JMAPSRV_USERMANAGER_KEY, JMAPSRV_USERMANAGER_SSO_CALLBACK_URL, JMAPSRV_USERMANAGER_SYNC_INTERVAL, JMAPSRV_USERMANAGER_SYNC_KEY, JMAPSRV_WEB_SERVER_SOCKET_EXTERNAL_URL, JMAPSRV_WEB_SERVER_SOCKET_LOCAL_ENABLED, JMAPSRV_WEB_SERVER_SOCKET_TYPE, JMAPSRV_WORK_PATH, JMAPSRV_WORKERSERVICE_INITIAL_SIZE, JMAPSRV_WORKERSERVICE_KEEP_ALIVE_TIME, JMAPSRV_WORKERSERVICE_MAXIMUM_SIZE, JMAPSRV_WORSPACES_PATH, JMAPSVR_HIBERNATE_SYSTEM_DIALECT, JMAPSVR_PREFERRED_EXTERNAL_ADDRESS, JMAPSVR_PREFERRED_LOCAL_ADDRESS, JMAPSVR_STATISTIC_CONFIG_CRON, LOGOS_HOME, MESSAGING_HOME, NO_CONNECTION_POOL, PATTERNS_HOME, PROJECTIONS_FILENAME, PROJECTIONS_PATH, REPORT_ENGINE_HOME, REPORTS_HOME, STROKES_FILENAME, STROKES_PATH, TOMCAT_APPLICATIONS_HOME, TOMCAT_HOME, TOMCAT_JMAPADMIN_HOME

Method Summary

Modifier and Type	Method and Description
DatabaseConnectionPool	addDatabaseConnPool(DatabaseConnectionPoolInfo poolInfo)
void	addListener(JMapServerEventListener l)
JMapServerRemoteConnectionPool	addRemoteConnectionPool(JMapServerRemoteConnectionPoolInfo poolInfo)
SdeConnectionPool	addSdeConnPool(SdeConnectionPoolInfo info) Adds a new Connection Pool info and creates new SDEConnectionPool using the specified ConnPoolInfo
SdeConnectionPool	addSdeConnPool(SdeConnectionPoolInfo info, SdeConnectionPool connPool) Adds the new connection pool info and the associated Connection Pool
boolean	checkAdminPermission(User user)
void	clientThreadPutToSleepOccurred(JMapServerClientThreadEvent e)
void	deleteDatabaseConnectionPool(int poolId)
protected void	deleteImageProducers()
void	deleteRemoteConnectionPool(int poolId)
void	deleteSdeConnectionPool(int id)
void	enableExtensions(java.lang.String[] requestTypes, boolean isEnabled)
protected void	fireStateChangeEvent(int oldState, int newState)
java.net.InetAddress	getAddress()
java.lang.String[]	getAnnotatedClassNames(java.lang.Class<? extends java.lang.annotation.Annotation> annotatedWith)
java.lang.String[]	getAnnotatedClassNames(java.lang.Class<? extends java.lang.annotation.Annotation> annotatedWith, java.lang.Class assignableFrom)
static java.lang.String	getBuildName() Returns the buildName that is contained in file 'version'.
static java.lang.String	getBuildNumber() Returns the build number that is contained in file 'version'.
JMapCipher	getCipher()
java.lang.String[]	getCodedValuesProviders()
ContextsManager	getContextsManager()
DatabaseConfig	getDatabaseConfig(java.lang.String driverClassName, java.lang.String url) Returns a DatabaseConfig object that contains the configuration for the specified driver class name.
java.io.File	getDatabaseConfigFile(java.lang.String driverClassName, java.lang.String url) Returns a reference to the XML file that contains the configuration for the specified driver class name.
DatabaseConfig[]	getDatabaseConfigs() Returns all available DatabaseConfig objects which define all databases that can be used with JMap Server.
JMapServerDataManager	getDataManager()
DatabaseConnectionPool	getDBConnPool(int id)
DatabaseConnectionPool	getDBConnPool(java.lang.String name)
DocumentsManager	getDocumentsManager()
java.lang.String[]	getElementFactories()
JMapServerExtensionDescriptor	getExtension(java.lang.String reqType) Returns the extension corresponding to the specified request type.
java.util.Hashtable<java.lang.String,JMapServerExtensionDescriptor>	getExtensions() Returns the table of registered extensions.
static java.lang.String	getFullVersion() Returns the complete version information (eg.
GWCManager	getGeoWebCacheManager()
static java.lang.String	getHotFixNumber() Returns the hotfix number that is contained in file 'version'.
JMSImageProducer	getImageProducer(int projectId)
protected JMSImageProducer	getImageProducer(JMapServerProject serverProject)
static JMapServer	getInstance()
static java.lang.String	getJMapHome()
JMapServerRemoteConnectionPool	getJMapServerRemoteConnPool(int id)
JMapServerRemoteConnectionPool	getJMapServerRemoteConnPool(java.lang.String name)
LicenseManager	getLicenseManager() Returns the license manager of this instance of JMap Server.
static java.lang.String	getMaintenanceNumber() Returns the maintenance number that is contained in file 'version'.
static java.lang.String	getMajorVersion() Returns the major version string of JMap Server (ex: 2.1)
MessagingController	getMessagingController()
JMapServerMonitoringInfo	getMonitoringInfo()
JMapServerPersonalDataManager	getPersonalDataManager()
ProjectionManager	getProjectionManager()
protected org.reflections.Reflections	getReflections()
SdeConnectionPool	getSdeConnPool(int id)
SdeConnectionPool	getSdeConnPool(java.lang.String name)
java.util.Collection<SdeConnectionPool>	getSdeConnPools()
java.lang.String	getSerialNumber() Returns the serial number of this instance of JMap Server.
JMapServerInfo	getServerInfo(long remoteTime) Returns a JMapServerInfo instance which contains information about this JMap Server.
SessionLogger	getSessionLogger()
JMapServerSessionManager	getSessionManager()
java.lang.String[]	getSpatialDataSources()
java.lang.String[]	getSpatialReaders()
JMapServerSystemData	getSystemData() Deprecated. use server controllers to access and modify the system database.
protected java.util.List<UpdateDescriptor>	getUpdateDescriptors()
UserManager	getUserManager()
static java.lang.String	getVersion() Returns the version number (eg.
java.util.Hashtable<?,?>	getWebAdminAllowedGroups()
java.util.Hashtable<?,?>	getWebAdminAllowedUsers()
EmbeddedTomcat	getWebEngine()
java.util.concurrent.ExecutorService	getWorkerExecutorService()
WorkSpaceManager	getWorkSpaceManager() Returns the WorkSpaces manager.
boolean	initCustomSpatialDataSources()
boolean	initRemoteServerConnection(JMapServerRemoteConnectionPoolInfo poolInfo)
static void	main(java.lang.String[] args)
void	reInitDatabaseConnectionPools(int[] poolIds)
void	reInitExtensions(java.lang.String[] requestTypes) Reinitialize the specified extensions.
boolean	reInitSystemDatabase(JMapServerSysParams newSysParams)
boolean	reloadClassParameters()
void	reloadLicense()
void	removeImageProducer(int projectId)
void	removeListener(JMapServerEventListener l)
boolean	saveSystemProperties()
boolean	saveSystemProperties(java.util.Properties properties) Deprecated. use updateSystemParams(JMapServerSysParams) instead.
void	serverStateChangeOccurred(JMapServerStateChangeEvent e)
void	setNoHttp(boolean flag) Sets the flag that determines if the embedded http server must be started.
void	setServerState(int serverState)
void	setUserManager(UserManager userManager, boolean synchronizePermissions) Sets a new UserManager on JMap Server.
void	setUserManagerSynchronization(UserManagerSynchronizer.Period period, int interval)
static void	shutdown(java.lang.String[] args)
void	synchronizeUserManager()
boolean	updateSystemParams(JMapServerSysParams systemParameters)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kheops.jmap.server.JMapServerEventListener

afterInitDatabases, beforeInitDatabases

Method Detail

getInstance

public static JMapServer getInstance()

getFullVersion

public static java.lang.String getFullVersion()

Returns the complete version information (eg. JMapServer version 4.0.0000).

Returns:

the version information

getVersion

public static java.lang.String getVersion()

Returns the version number (eg. 4.0.0000).

Returns:

the version information

getJMapHome

public static java.lang.String getJMapHome()

getBuildNumber

public static java.lang.String getBuildNumber()

Returns the build number that is contained in file 'version'.

Returns:

build number

getMaintenanceNumber

public static java.lang.String getMaintenanceNumber()

Returns the maintenance number that is contained in file 'version'.

Returns:

maintenance number

getHotFixNumber

public static java.lang.String getHotFixNumber()

Returns the hotfix number that is contained in file 'version'.

Returns:

hotfix number

getBuildName

public static java.lang.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 java.util.concurrent.ExecutorService getWorkerExecutorService()

getCipher

public JMapCipher getCipher()

getDBConnPool

public DatabaseConnectionPool getDBConnPool(int id)

getSdeConnPool

public SdeConnectionPool getSdeConnPool(int id)

getSdeConnPool

public SdeConnectionPool getSdeConnPool(java.lang.String name)

getDBConnPool

public DatabaseConnectionPool getDBConnPool(java.lang.String name)

getJMapServerRemoteConnPool

public JMapServerRemoteConnectionPool getJMapServerRemoteConnPool(java.lang.String name)

getJMapServerRemoteConnPool

public JMapServerRemoteConnectionPool getJMapServerRemoteConnPool(int id)

getSdeConnPools

public java.util.Collection<SdeConnectionPool> getSdeConnPools()

getExtension

public JMapServerExtensionDescriptor getExtension(java.lang.String reqType)

Returns the extension corresponding to the specified request type.

Parameters:

reqType - the request type

getExtensions

public java.util.Hashtable<java.lang.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 or not 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 java.lang.String[] getSpatialReaders()

getSpatialDataSources

public java.lang.String[] getSpatialDataSources()

Returns:

the list of custom spatial data sources registered in JMap Server

getProjectionManager

public ProjectionManager getProjectionManager()

getSessionLogger

public SessionLogger getSessionLogger()

getDocumentsManager

public DocumentsManager getDocumentsManager()

getContextsManager

public ContextsManager getContextsManager()

getElementFactories

public java.lang.String[] getElementFactories()

getDatabaseConfigFile

public java.io.File getDatabaseConfigFile(java.lang.String driverClassName,
                                          java.lang.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(java.lang.String driverClassName,
                                        java.lang.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 java.lang.Exception

Throws:

java.lang.Exception

reInitExtensions

public void reInitExtensions(java.lang.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(java.lang.String[] requestTypes,
                             boolean isEnabled)

initCustomSpatialDataSources

public boolean initCustomSpatialDataSources()

reloadClassParameters

public boolean reloadClassParameters()

reloadLicense

public void reloadLicense()
                   throws java.lang.Exception

Throws:

java.lang.Exception

saveSystemProperties

public boolean saveSystemProperties()

saveSystemProperties

@Deprecated
public boolean saveSystemProperties(java.util.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:

LicenseManager

getSerialNumber

public java.lang.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 java.util.Hashtable<?,?> getWebAdminAllowedUsers()

getWebAdminAllowedGroups

public java.util.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 java.lang.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 java.lang.String[] getAnnotatedClassNames(java.lang.Class<? extends java.lang.annotation.Annotation> annotatedWith)

getAnnotatedClassNames

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

getCodedValuesProviders

public java.lang.String[] getCodedValuesProviders()

getAddress

public java.net.InetAddress getAddress()
                                throws java.net.UnknownHostException

Throws:

java.net.UnknownHostException

getGeoWebCacheManager

public GWCManager getGeoWebCacheManager()

getUpdateDescriptors

protected java.util.List<UpdateDescriptor> getUpdateDescriptors()

shutdown

public static void shutdown(java.lang.String[] args)

main

public static void main(java.lang.String[] args)