JMapServerSystemData (JMap 7.0 Kathmandu API Documentation)

java.lang.Object
- com.kheops.jmap.server.JMapServerSystemData

All Implemented Interfaces:

java.io.Serializable
```
public final class JMapServerSystemData
extends java.lang.Object
implements java.io.Serializable
```
The JMapServerSystemData class is used as a data structure to hold the whole JMap Server system configuration. All objects stored in the system data must implement the interface Serializable.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

JMapServerSystemData(User administrator)
Creates a new JMapServerSystemData using the specified User as the new JMap Server Acl administrator.

Constructors
Constructor and Description
`JMapServerSystemData(User administrator)` Creates a new JMapServerSystemData using the specified User as the new JMap Server Acl administrator.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConnectionPoolInfo`	`getConnectionPool(int poolId)` Verifies if the poolInfo exists in the DatabaseConnectionPool, if it does it returns the DatabaseConnectionPoolInfo.
`ConnectionPoolInfo`	`getConnectionPool(java.lang.String name)` Verifies if the poolInfo exists in the DatabaseConnectionPool, if it does it returns the DatabaseConnectionPoolInfo.
`DatabaseConnectionPoolInfo`	`getDatabaseConnectionPool(int poolId)`
`DatabaseConnectionPoolInfo`	`getDatabaseConnectionPool(java.lang.String name)`
`java.lang.String`	`getDatabaseConnectionPoolLastStackTrace(int poolId)`
`java.util.Collection<DatabaseConnectionPoolInfo>`	`getDatabaseConnectionPools()` Returns an unmodifiable collection that contains all database connection pools configured in the system database.
`java.lang.String`	`getLayerLastStackTrace(int projectId, int layerId)`
`int`	`getLayerStatus(int projectId, int layerId)`
`MetadataTemplate`	`getMetadataTemplate(int templateId)`
`MetadataTemplate`	`getMetadataTemplate(java.lang.String name)`
`java.util.Collection<MetadataTemplate>`	`getMetadataTemplates()` Returns an unmodifiable collection that contains all metadata templates configured in the system database.
`JMapServerProject`	`getProject(int projectId)` Returns the JMapServerProject object whose id is equals to the specified id.
`JMapServerProject`	`getProject(java.lang.String name)` Returns the JMapServerProject object whose name equals to the specified name.
`java.util.Map<java.lang.Integer,java.util.List<java.lang.Integer>>`	`getProjectLayers(int dsId)`
`java.util.Collection<JMapServerProject>`	`getProjects()` Returns an unmodifiable collection that contains all projects configured in the system database.
`java.util.Collection<java.lang.Integer>`	`getProjectsIds()`
`java.lang.String`	`getRemoteConnectionLastStackTrace(int poolId)`
`JMapServerRemoteConnectionPoolInfo`	`getRemoteConnectionPool(int poolId)`
`JMapServerRemoteConnectionPoolInfo`	`getRemoteConnectionPool(java.lang.String name)`
`java.util.Collection<JMapServerRemoteConnectionPoolInfo>`	`getRemoteConnectionPools()` Returns an unmodifiable collection that contains all database connection pools configured in the system database.
`int`	`getRemoteConnectionStatus(int poolId)`
`java.util.Collection<ReservedSessionsInfo>`	`getReservedSessions(SessionType sessionType)` Returns an unmodifiable collection that contains all reserved users configured for a specific session type in the system database.
`ReservedSessionsInfo`	`getReservedSessions(SessionType sessionType, java.lang.String username)`
`SdeConnectionPoolInfo`	`getSdeConnectionPool(int poolId)`
`SdeConnectionPoolInfo`	`getSdeConnectionPool(java.lang.String name)`
`java.util.Collection<SdeConnectionPoolInfo>`	`getSdeConnectionPools()` Returns an unmodifiable collection that contains all SDE database connection pools configured in the system database.
`SpatialDataSourceInfo`	`getSpatialDataSource(IdentifierType identifierType, java.lang.Object identifier)`
`SpatialDataSourceInfo`	`getSpatialDataSource(int dsId)` Returns the SpatialDataSourceInfo object whose id is equals to the specified dataSourceId.
`SpatialDataSourceInfo`	`getSpatialDataSource(java.lang.String name)` Returns the SpatialDataSourceInfo object whose name is equals to the specified name.
`java.lang.String`	`getSpatialDataSourceLastStackTrace(int dsId)`
`java.util.Collection<SpatialDataSourceInfo>`	`getSpatialDataSources()` Returns an unmodifiable collection that contains all spatial data sources configured in the system database.
`java.util.Collection<java.lang.Integer>`	`getSpatialDataSourcesIds()`
`int`	`getSpatialDataSourceStatus(int dsId)`
`StyleTemplate`	`getStyleTemplate(int styleId)`
`StyleTemplate`	`getStyleTemplate(java.lang.String name)`
`java.util.Collection<StyleTemplate>`	`getStyleTemplates()` Returns an unmodifiable collection that contains all style templates configured in the system database.
`boolean`	`isProjectExists(int projectId)`
`boolean`	`isSpatialDataSourceExists(int dsId)`
`boolean`	`savePartialDatabaseConnectionPool(PersistenceDelegate<DatabaseConnectionPoolInfo> persistenceDelegate)`
`boolean`	`savePartialMetadataTemplate(PersistenceDelegate<MetadataTemplate> persistenceDelegate)`
`boolean`	`savePartialProject(PersistenceDelegate<JMapServerProject> persistenceDelegate)`
`boolean`	`savePartialRemoteConnectionPool(PersistenceDelegate<JMapServerRemoteConnectionPoolInfo> persistenceDelegate)`
`boolean`	`savePartialStyleTemplate(PersistenceDelegate<StyleTemplate> persistenceDelegate)`
`java.lang.String`	`toString()`
`protected static void`	`updateInfoRequests(JMapServerInfoReport[] infoRequests)` Updates all AttributeQuery objects that are configured to use the spatial data source having the specified id.

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

- Constructor Detail
  - JMapServerSystemData
```
public JMapServerSystemData(User administrator)
```
    Creates a new JMapServerSystemData using the specified User as the new JMap Server Acl administrator.
    
    Parameters:
    
    administrator - the administrator of the new JMap Server Acl object.
- Method Detail
  - getSpatialDataSource
```
public SpatialDataSourceInfo getSpatialDataSource(int dsId)
```
    Returns the SpatialDataSourceInfo object whose id is equals to the specified dataSourceId.
    
    Parameters:
    
    dsId - the id of the SpatialDataSourceInfo object to return.
    
    Returns:
    
    the SpatialDataSourceInfo object whose id is equals to the specified dataSourceId, or null if none was found.
  - getDatabaseConnectionPoolLastStackTrace
```
public java.lang.String getDatabaseConnectionPoolLastStackTrace(int poolId)
```
  - getRemoteConnectionLastStackTrace
```
public java.lang.String getRemoteConnectionLastStackTrace(int poolId)
```
  - getRemoteConnectionStatus
```
public int getRemoteConnectionStatus(int poolId)
```
  - getSpatialDataSourceStatus
```
public int getSpatialDataSourceStatus(int dsId)
```
  - getSpatialDataSourceLastStackTrace
```
public java.lang.String getSpatialDataSourceLastStackTrace(int dsId)
```
  - getLayerStatus
```
public int getLayerStatus(int projectId,
                          int layerId)
```
  - getLayerLastStackTrace
```
public java.lang.String getLayerLastStackTrace(int projectId,
                                               int layerId)
```
  - isSpatialDataSourceExists
```
public boolean isSpatialDataSourceExists(int dsId)
```
  - isProjectExists
```
public boolean isProjectExists(int projectId)
```
  - getProjectLayers
```
public java.util.Map<java.lang.Integer,java.util.List<java.lang.Integer>> getProjectLayers(int dsId)
```
  - getSpatialDataSource
```
public SpatialDataSourceInfo getSpatialDataSource(java.lang.String name)
```
    Returns the SpatialDataSourceInfo object whose name is equals to the specified name.
    
    Parameters:
    
    name - the name of the SpatialDataSourceInfo object to return.
    
    Returns:
    
    the SpatialDataSourceInfo object whose name is equals to the specified name, or null if none was found.
  - getSpatialDataSource
```
public SpatialDataSourceInfo getSpatialDataSource(IdentifierType identifierType,
                                                  java.lang.Object identifier)
```
  - getStyleTemplate
```
public StyleTemplate getStyleTemplate(int styleId)
```
  - getStyleTemplate
```
public StyleTemplate getStyleTemplate(java.lang.String name)
```
  - getMetadataTemplate
```
public MetadataTemplate getMetadataTemplate(int templateId)
```
  - getMetadataTemplate
```
public MetadataTemplate getMetadataTemplate(java.lang.String name)
```
  - getDatabaseConnectionPool
```
public DatabaseConnectionPoolInfo getDatabaseConnectionPool(int poolId)
```
  - getDatabaseConnectionPool
```
public DatabaseConnectionPoolInfo getDatabaseConnectionPool(java.lang.String name)
```
  - getSdeConnectionPool
```
public SdeConnectionPoolInfo getSdeConnectionPool(int poolId)
```
  - getSdeConnectionPool
```
public SdeConnectionPoolInfo getSdeConnectionPool(java.lang.String name)
```
  - getConnectionPool
```
public ConnectionPoolInfo getConnectionPool(int poolId)
```
    Verifies if the poolInfo exists in the DatabaseConnectionPool, if it does it returns the DatabaseConnectionPoolInfo. If not, it returns the SdeConnectionPoolInfo from the SdeConnectionPoolInfo. This method uses both getDatabaseConnectionPool(poolId) and getSdeConnectionPool(poolId) methods
    
    Parameters:
    
    poolId - id of the ConnectionPoolInfo
    
    Returns:
    
    DatabaseConnectionPoolInfo, SdeConnectionPoolInfo or null
  - getConnectionPool
```
public ConnectionPoolInfo getConnectionPool(java.lang.String name)
```
    Verifies if the poolInfo exists in the DatabaseConnectionPool, if it does it returns the DatabaseConnectionPoolInfo. If not, it returns the SdeConnectionPoolInfo from the SdeConnectionPoolInfo. This method uses both getDatabaseConnectionPool(name) and getSdeConnectionPool(name) methods
    
    Parameters:
    
    name - name of the ConnectionPoolInfo
    
    Returns:
    
    DatabaseConnectionPoolInfo, SdeConnectionPoolInfo or null
  - getProject
```
public JMapServerProject getProject(int projectId)
```
    Returns the JMapServerProject object whose id is equals to the specified id.
    
    Parameters:
    
    projectId - the id of the JMapServerProject object to return.
    
    Returns:
    
    the JMapServerProject object whose id equals to the specified id, or null if none was found.
  - getProject
```
public JMapServerProject getProject(java.lang.String name)
```
    Returns the JMapServerProject object whose name equals to the specified name.
    
    Parameters:
    
    name - the name of the JMapServerProject object to return.
    
    Returns:
    
    the JMapServerProject object whose name equals to the specified name, or null if none was found.
  - getSpatialDataSources
```
public java.util.Collection<SpatialDataSourceInfo> getSpatialDataSources()
```
    Returns an unmodifiable collection that contains all spatial data sources configured in the system database.
    
    Returns:
    
    an unmodifiable collection that contains all spatial data sources configured in the system database.
  - getSpatialDataSourcesIds
```
public java.util.Collection<java.lang.Integer> getSpatialDataSourcesIds()
```
  - getProjects
```
public java.util.Collection<JMapServerProject> getProjects()
```
    Returns an unmodifiable collection that contains all projects configured in the system database.
    
    Returns:
    
    an unmodifiable collection that contains all projects configured in the system database.
  - getProjectsIds
```
public java.util.Collection<java.lang.Integer> getProjectsIds()
```
  - getStyleTemplates
```
public java.util.Collection<StyleTemplate> getStyleTemplates()
```
    Returns an unmodifiable collection that contains all style templates configured in the system database.
    
    Returns:
    
    an unmodifiable collection that contains all style templates configured in the system database.
  - getMetadataTemplates
```
public java.util.Collection<MetadataTemplate> getMetadataTemplates()
```
    Returns an unmodifiable collection that contains all metadata templates configured in the system database.
    
    Returns:
    
    an unmodifiable collection that contains all metadata templates configured in the system database.
  - getDatabaseConnectionPools
```
public java.util.Collection<DatabaseConnectionPoolInfo> getDatabaseConnectionPools()
```
    Returns an unmodifiable collection that contains all database connection pools configured in the system database.
    
    Returns:
    
    an unmodifiable collection that contains all database connection pools configured in the system database.
  - getSdeConnectionPools
```
public java.util.Collection<SdeConnectionPoolInfo> getSdeConnectionPools()
```
    Returns an unmodifiable collection that contains all SDE database connection pools configured in the system database.
    
    Returns:
    
    an unmodifiable collection that contains all SDE database connection pools configured in the system database.
  - getRemoteConnectionPools
```
public java.util.Collection<JMapServerRemoteConnectionPoolInfo> getRemoteConnectionPools()
```
    Returns an unmodifiable collection that contains all database connection pools configured in the system database.
    
    Returns:
    
    an unmodifiable collection that contains all database connection pools configured in the system database.
  - getReservedSessions
```
public ReservedSessionsInfo getReservedSessions(SessionType sessionType,
                                                java.lang.String username)
```
  - getReservedSessions
```
public java.util.Collection<ReservedSessionsInfo> getReservedSessions(SessionType sessionType)
```
    Returns an unmodifiable collection that contains all reserved users configured for a specific session type in the system database.
    
    Returns:
    
    an unmodifiable collection that contains all reserved users configured for a specific session type in the system database.
  - getRemoteConnectionPool
```
public JMapServerRemoteConnectionPoolInfo getRemoteConnectionPool(int poolId)
```
  - getRemoteConnectionPool
```
public JMapServerRemoteConnectionPoolInfo getRemoteConnectionPool(java.lang.String name)
```
  - savePartialDatabaseConnectionPool
```
public boolean savePartialDatabaseConnectionPool(PersistenceDelegate<DatabaseConnectionPoolInfo> persistenceDelegate)
```
  - savePartialProject
```
public boolean savePartialProject(PersistenceDelegate<JMapServerProject> persistenceDelegate)
```
  - savePartialStyleTemplate
```
public boolean savePartialStyleTemplate(PersistenceDelegate<StyleTemplate> persistenceDelegate)
```
  - savePartialMetadataTemplate
```
public boolean savePartialMetadataTemplate(PersistenceDelegate<MetadataTemplate> persistenceDelegate)
```
  - savePartialRemoteConnectionPool
```
public boolean savePartialRemoteConnectionPool(PersistenceDelegate<JMapServerRemoteConnectionPoolInfo> persistenceDelegate)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - updateInfoRequests
```
protected static void updateInfoRequests(JMapServerInfoReport[] infoRequests)
```
    Updates all AttributeQuery objects that are configured to use the spatial data source having the specified id.

Class JMapServerSystemData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JMapServerSystemData

Method Detail

getSpatialDataSource

getDatabaseConnectionPoolLastStackTrace

getRemoteConnectionLastStackTrace

getRemoteConnectionStatus

getSpatialDataSourceStatus

getSpatialDataSourceLastStackTrace

getLayerStatus

getLayerLastStackTrace

isSpatialDataSourceExists

isProjectExists

getProjectLayers

getSpatialDataSource

getSpatialDataSource

getStyleTemplate

getStyleTemplate

getMetadataTemplate

getMetadataTemplate

getDatabaseConnectionPool

getDatabaseConnectionPool

getSdeConnectionPool

getSdeConnectionPool

getConnectionPool

getConnectionPool

getProject

getProject

getSpatialDataSources

getSpatialDataSourcesIds

getProjects

getProjectsIds

getStyleTemplates

getMetadataTemplates

getDatabaseConnectionPools

getSdeConnectionPools

getRemoteConnectionPools

getReservedSessions

getReservedSessions

getRemoteConnectionPool

getRemoteConnectionPool

savePartialDatabaseConnectionPool

savePartialProject

savePartialStyleTemplate

savePartialMetadataTemplate

savePartialRemoteConnectionPool

toString

updateInfoRequests