org.vfny.geoserver.global.ApplicationState Maven / Gradle / Ivy
/* Copyright (c) 2001 - 2007 TOPP - www.openplans.org. All rights reserved.
* This code is licensed under the GPL 2.0 license, availible at the root
* application directory.
*/
package org.vfny.geoserver.global;
import org.apache.struts.action.ActionServlet;
import org.apache.struts.action.PlugIn;
import org.apache.struts.config.ModuleConfig;
import org.geotools.validation.dto.PlugInDTO;
import org.geotools.validation.dto.TestDTO;
import org.geotools.validation.dto.TestSuiteDTO;
import org.springframework.beans.factory.InitializingBean;
import org.vfny.geoserver.global.xml.XMLConfigWriter.WriterUtils;
import java.io.File;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import javax.servlet.ServletException;
/**
* This class represents the state of the GeoServer appliaction.
*
*
* ApplicationState used by the state.jsp tile as a single view on the state of
* the GeoServer application. This class may be extended in the future to
* provide runtime statistics.
*
*
*
* This class is not a bean - content is updated based on methods. As an
* example consider the following State diagram:
*
*
* @author dzwiers, Refractions Research, Inc.
* @version $Id: ApplicationState.java 7579 2007-10-09 22:30:14Z jdeolive $
*/
public class ApplicationState implements PlugIn, InitializingBean {
/** The key used to store this value in the Web Container */
public static final String WEB_CONTAINER_KEY = "GeoServer.ApplicationState";
/** Non null if configuration has been edited (but not applied) */
private Date configTimestamp;
/** Non null if the geoserver setup has been changed (but not saved) */
private Date appTimestamp;
/** Non null if the modification date of the xml files is known */
private Date xmlTimestamp;
/** magic, be very careful with this array. defined below in loadStatus() */
private int[] geoserverStatus = new int[13];
private Map geoserverNSErrors;
private Map geoserverDSErrors;
private Map geoserverVPErrors;
/**
* Data module
*/
Data data;
/**
* Validation module
*/
GeoValidator validator;
/**
* Configuration module
*/
Config config;
/**
*
* @deprecated use {@link #ApplicationState(Data, GeoValidator, Config)}
*/
public ApplicationState() {
this(null, null, null);
}
/**
* Creates a new appliction state.
*
* @param data The data modle.
* @param validator The validation module
*/
public ApplicationState(Data data, GeoValidator validator, Config config) {
this.data = data;
this.validator = validator;
this.config = config;
}
/**
* Clean up the Configuration State during application exit.
*
*
* Since this class just holds data, no resources need to be released.
*
*
* @see org.apache.struts.action.PlugIn#destroy()
*/
public void destroy() {
}
/**
* Set up the ApplicationState during Application start up.
*
*
* ApplicationState simply registers itself with the WEB_CONTAINER_KEY
* ("GeoServer.ApplicationState") during start up.
*
*
* @param actionServlet ActionServlet representing the Application
* @param moduleConfig Configuration used to set up this plug in
*
* @throws ServletException
*
* @see org.apache.struts.action.PlugIn#init(org.apache.struts.action.ActionServlet,
* org.apache.struts.config.ModuleConfig)
*
* @deprecated This class is no longer loaded with struts,
* use {@link #afterPropertiesSet()}
*/
public void init(ActionServlet actionServlet, ModuleConfig moduleConfig)
throws ServletException {
try {
afterPropertiesSet();
} catch (Exception e) {
throw new ServletException(e);
}
}
public void afterPropertiesSet() throws Exception {
configTimestamp = getXmlTimestamp();
appTimestamp = configTimestamp;
geoserverStatus[0] = -1;
}
/**
* True if the user has changed the Configuration and not yet applied them.
*
* @return true if Configuration needs changing.
*/
public boolean isConfigChanged() {
return (configTimestamp != null)
&& ((appTimestamp == null) || configTimestamp.after(appTimestamp));
}
/** Validation is part of the Configuration Process */
private boolean isValidationChanged() {
return isConfigChanged();
}
/**
* True if the user has changed GeoServer and not yet saved the changes.
*
* @return true if GeoServer has been changed (but not saved)
*/
public boolean isAppChanged() {
return (appTimestamp != null) && appTimestamp.after(getXmlTimestamp());
}
/**
* Notification that Config has been updated from XML config files
*/
public void notifyLoadXML() {
// Correct, this represents a load into config from xml
appTimestamp = xmlTimestamp;
configTimestamp = xmlTimestamp;
}
/**
* Notification that Global has been updated from Configuration
*/
public void notifyToGeoServer() {
appTimestamp = new Date();
}
/**
* Notification that Global has been saved to XML config files.
*/
public void notifiySaveXML() {
xmlTimestamp = new Date();
}
/**
* Notification that the User has changed the Configuration
*/
public void notifyConfigChanged() {
configTimestamp = new Date();
}
/**
* signal to any listeners that config has changed.
*/
public void fireChange() {
data.getGeoServer().fireChange();
}
/** Q: what is this supposed to do? */
public int getWcsGood() {
if (geoserverStatus[0] != ((isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0))) {
loadStatus();
}
return geoserverStatus[4];
}
/** q: What foul manner of magic is this? */
public int getWcsBad() {
if (geoserverStatus[0] != ((isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0))) {
loadStatus();
}
return geoserverStatus[5];
}
/** q: This does not make a lot of sense - did you want to consult both ConfigChanged and GeoServer changed? */
public int getWcsDisabled() {
if (geoserverStatus[0] != ((isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0))) {
loadStatus();
}
return geoserverStatus[6];
}
/** Q: what is this supposed to do? */
public int getWfsGood() {
if (geoserverStatus[0] != ((isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0))) {
loadStatus();
}
return geoserverStatus[1];
}
/** q: What foul manner of magic is this? */
public int getWfsBad() {
if (geoserverStatus[0] != ((isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0))) {
loadStatus();
}
return geoserverStatus[2];
}
/** q: This does not make a lot of sense - did you want to consult both ConfigChanged and GeoServer changed? */
public int getWfsDisabled() {
if (geoserverStatus[0] != ((isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0))) {
loadStatus();
}
return geoserverStatus[3];
}
/** Q: scary magic */
public int getWmsGood() {
if (geoserverStatus[0] != ((isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0))) {
loadStatus();
}
return geoserverStatus[4];
}
/** Q: scary magic */
public int getWmsBad() {
if (geoserverStatus[0] != ((isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0))) {
loadStatus();
}
return geoserverStatus[5];
}
/** Q: scary magic */
public int getWmsDisabled() {
if (geoserverStatus[0] != ((isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0))) {
loadStatus();
}
return geoserverStatus[6];
}
public int getDataGood() {
if (geoserverStatus[0] != ((isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0))) {
loadStatus();
}
return geoserverStatus[7];
}
public int getDataBad() {
if (geoserverStatus[0] != ((isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0))) {
loadStatus();
}
return geoserverStatus[8];
}
public int getDataDisabled() {
if (geoserverStatus[0] != ((isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0))) {
loadStatus();
}
return geoserverStatus[9];
}
public int getGeoserverGood() {
if (geoserverStatus[0] != ((isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0))) {
loadStatus();
}
return (int) ((geoserverStatus[1] + geoserverStatus[4] + geoserverStatus[7]) / 3.0);
}
public int getGeoserverBad() {
if (geoserverStatus[0] != ((isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0))) {
loadStatus();
}
return (int) ((geoserverStatus[2] + geoserverStatus[5] + geoserverStatus[8]) / 3.0);
}
public int getGeoserverDisabled() {
if (geoserverStatus[0] != ((isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0))) {
loadStatus();
}
return (int) ((geoserverStatus[3] + geoserverStatus[6] + geoserverStatus[9]) / 3.0);
}
/**
*
* loadStatus purpose.
*
* Magic occurs here, so be careful. This sets the values in the geoserverStatus array.
*
*
* The array is broken into four blocks, [0],[1-3],[4-6],[7-9].
*
* - [0] - The first block represtents the application state at the time
* of data creation. Use to test whether the array needs to be
* reloaded.
* - [1-3] - wfs (working, broken, disabled) percentages
* - [4-6] - wms (working, broken, disabled) percentages
* - [7-9] - data (working, broken, disabled) percentages
*
*
*/
private void loadStatus() {
// what does isGeoServerChanged() have to do with this
// and why don't you use (isGeoServerChanged() ? 3 : 0)
//
// or are you trying to indicate a bit mask:
// bit 1: isGeoServerChanged
// bit 2: isConfigChanged
//
// And all this madness is a cut and paste mistake?
geoserverStatus[0] = (isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0);
// setup geoserverNSErrors
geoserverNSErrors = data.statusNamespaces();
// setup geoserverDSErrors
geoserverDSErrors = data.statusDataStores();
// setup geoserverVPErrors
Map tmpVP = validator.getErrors();
int g = 0;
int b = 0;
int d = 0;
Iterator i = null;
//featuretypes
i = geoserverNSErrors.keySet().iterator();
while (i.hasNext()) {
Object key = i.next();
Object o = geoserverNSErrors.get(key);
if (o.equals(Boolean.TRUE)) {
g++;
i.remove();
//geoserverNSErrors.remove(key);
} else {
if (o.equals(Boolean.FALSE)) {
d++;
i.remove();
//geoserverNSErrors.remove(key);
} else {
b++;
}
}
}
if ((g + b + d) == 0) {
geoserverStatus[7] = 100;
geoserverStatus[8] = 0;
geoserverStatus[9] = 0;
} else {
geoserverStatus[7] = (int) ((100.0 * g) / (g + b + d));
geoserverStatus[8] = (int) ((100.0 * b) / (g + b + d));
geoserverStatus[9] = (int) ((100.0 * d) / (g + b + d));
}
//datastores
i = geoserverDSErrors.keySet().iterator();
g = 0;
b = 0;
d = 0;
while (i.hasNext()) {
Object key = i.next();
Object o = geoserverDSErrors.get(key);
if (o.equals(Boolean.TRUE)) {
g++;
i.remove();
//geoserverDSErrors.remove(key);
} else {
if (o.equals(Boolean.FALSE)) {
d++;
i.remove();
//geoserverDSErrors.remove(key);
} else {
b++;
}
}
}
if ((g + b + d) == 0) {
geoserverStatus[1] = geoserverStatus[4] = 100;
geoserverStatus[2] = geoserverStatus[5] = 0;
geoserverStatus[3] = geoserverStatus[6] = 0;
} else {
geoserverStatus[1] = geoserverStatus[4] = (int) ((100.0 * g) / (g + b + d));
geoserverStatus[2] = geoserverStatus[5] = (int) ((100.0 * b) / (g + b + d));
geoserverStatus[3] = geoserverStatus[6] = (int) ((100.0 * d) / (g + b + d));
}
//validation
// DJB: noticed that you can have no loaded validation plugins, so this can be null)
g = 0;
b = 0;
d = 0;
if (tmpVP != null) {
i = tmpVP.keySet().iterator();
while (i.hasNext()) {
Object key = i.next();
Object o = tmpVP.get(key);
if (o.equals(Boolean.TRUE)) {
g++;
i.remove();
//geoserverDSErrors.remove(key);
} else {
if (o.equals(Boolean.FALSE)) {
d++;
i.remove();
//geoserverDSErrors.remove(key);
} else {
b++;
}
}
}
}
if ((g + b + d) == 0) {
geoserverStatus[10] = 100;
geoserverStatus[11] = 0;
geoserverStatus[12] = 0;
} else {
geoserverStatus[10] = (int) ((100.0 * g) / (g + b + d));
geoserverStatus[11] = (int) ((100.0 * b) / (g + b + d));
geoserverStatus[12] = (int) ((100.0 * d) / (g + b + d));
}
geoserverVPErrors = new HashMap();
if (tmpVP != null) //DJB: protection for no validation services
{
i = tmpVP.entrySet().iterator();
while (i.hasNext()) {
Map.Entry e = (Map.Entry) i.next();
Object dto = e.getKey();
if (dto instanceof PlugInDTO) {
geoserverVPErrors.put("PlugIn:" + ((PlugInDTO) dto).getName(), e.getValue());
} else {
if (dto instanceof TestDTO) {
geoserverVPErrors.put("Test:" + ((TestDTO) dto).getName(), e.getValue());
} else {
if (dto instanceof TestSuiteDTO) {
geoserverVPErrors.put("TestSuite:" + ((TestSuiteDTO) dto).getName(),
e.getValue());
}
}
}
}
}
}
public Exception getDataStoreError(String key) {
return (Exception) getDataStoreErrors().get(key);
}
public Exception getNameSpaceError(String key) {
return (Exception) getNameSpaceErrors().get(key);
}
public Exception getWFSError(String key) {
return (Exception) getNameSpaceErrors().get(key);
}
public Exception getWMSError(String key) {
return (Exception) getNameSpaceErrors().get(key);
}
public Exception getValidationError(String key) {
return (Exception) getValidationErrors().get(key);
}
/**
* Namespace Exceptions by prefix:typeName.
*
* This only includes problems! If this map is null or isEmpty
* status is "ready".
*
* @return
*/
public Map getNameSpaceErrors() {
if ((geoserverNSErrors == null)
|| (geoserverStatus[0] == ((isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0)))) {
loadStatus();
}
return geoserverNSErrors;
}
/** Flattened for your JSP pleasure */
public List getNameSpaceErrorKeys() {
return new LinkedList(getNameSpaceErrors().keySet());
}
/** Flattened for your JSP pleasure */
public List getNameSpaceErrorValues() {
return new LinkedList(getNameSpaceErrors().values());
}
/**
* DataStore Exceptions by dataStoreId:typeName
*
* This only includes problems! If this map is null or isEmpty
* status is "ready".
*
* @return
*/
public Map getDataStoreErrors() {
if ((geoserverDSErrors == null)
|| (geoserverStatus[0] == ((isConfigChanged() ? 1 : 0) + (isAppChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0)))) {
loadStatus();
}
return geoserverDSErrors;
}
/** Flattened for your JSP pleasure */
public List getDataStoreErrorKeys() {
return new LinkedList(getDataStoreErrors().keySet());
}
/** Flattened for your JSP pleasure */
public List getDataStoreErrorValues() {
return new LinkedList(getDataStoreErrors().values());
}
/**
* Validation Exceptions by obejct type : name where object type is one of TestSuite, Test, PlugIn
*
* This only includes problems! If this map is null or isEmpty
* status is "ready".
*
* @return
*/
public Map getValidationErrors() {
if ((geoserverNSErrors == null)
|| (geoserverStatus[0] == ((isAppChanged() ? 1 : 0) + (isConfigChanged() ? 2 : 0)
+ (isValidationChanged() ? 4 : 0)))) {
loadStatus();
}
return geoserverVPErrors;
}
/** Flattened for your JSP pleasure */
public List getValidationErrorKeys() {
return new LinkedList(getValidationErrors().keySet());
}
/** Flattened for your JSP pleasure */
public List getValidationErrorValues() {
return new LinkedList(getValidationErrors().values());
}
public Map getWCSErrors() {
return getNameSpaceErrors();
}
public List getWCSErrorKeys() {
return getNameSpaceErrorKeys();
}
public Map getWFSErrors() {
return getNameSpaceErrors();
}
public List getWFSErrorKeys() {
return getNameSpaceErrorKeys();
}
public Map getWMSErrors() {
return getNameSpaceErrors();
}
public List getWMSErrorKeys() {
return getNameSpaceErrorKeys();
}
/**
* Access appTimestamp property.
*
* @return Returns the appTimestamp.
*/
public Date getAppTimestamp() {
return appTimestamp;
}
/**
* Access configTimestamp property.
*
* @return Returns the configTimestamp.
*/
public Date getConfigTimestamp() {
return configTimestamp;
}
/**
* Access xmlTimestamp property.
*
* @return Returns the xmlTimestamp.
*/
public Date getXmlTimestamp() {
if (xmlTimestamp == null) {
//DJB: changed for geoserver_data_dir
File dataDir = config.dataDirectory();
boolean inDataDir = GeoserverDataDirectory.isTrueDataDir();
//We're just checking if it's actually a data_dir, not trying to
//to do backwards compatibility. So if an old data_dir is made in
//the old way, on save it'll come to the new way. -ch
File serviceDir = dataDir;
File serviceFile;
try {
serviceFile = WriterUtils.initWriteFile(new File(serviceDir, "services.xml"), false);
} catch (ConfigurationException confE) {
throw new RuntimeException(confE);
}
xmlTimestamp = new Date(serviceFile.lastModified());
}
return xmlTimestamp;
}
private void resetXMLTimestamp() {
xmlTimestamp = null;
}
}