Java Doc for GeoServer.java in  » GIS » GeoServer » org » vfny » geoserver » global » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » GIS » GeoServer » org.vfny.geoserver.global 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.vfny.geoserver.global.GlobalLayerSupertype
      org.vfny.geoserver.global.GeoServer

GeoServer
public class GeoServer extends GlobalLayerSupertype implements DisposableBean(Code)
Complete configuration set for the whole server
author:
   Gabriel Roldan
author:
   dzwiers
version:
   $Id: GeoServer.java 8406 2008-02-14 19:49:39Z saul.farber $

Inner Class :public interface Listener

Field Summary
final public static  StringWEB_CONTAINER_KEY
     For finding the instance of this class to use from the web container

ServletContext sc = ...


Constructor Summary
public  GeoServer()
     Default constructor only to facilitate unit testing mock ups; real uses shall create an instance through GeoServer.GeoServer(Config) .
public  GeoServer(Config config)
     Creates a GeoServer instance and loads its configuration.

Method Summary
public  voidaddListener(Listener listener)
     Adds a listener to be notified of state change.
public static  voidconfigureGeoServerLogging(String log4jConfigFileStr, boolean suppressStdOutLogging, String logFileName)
    
public static  voidconfigureGeoServerLogging(InputStream loggingConfigStream, boolean suppressStdOutLogging, boolean suppressFileLogging, String logFileName)
    
public  voiddestroy()
     Implements DisposableBean.destroy to release resources being held by the server at server shutdown, such as JDBC connection pools and ArcSDE connection pools.
public  voidfireChange()
     Notifies all listeners of a change.
public  StringgetAddress()
     getAddress purpose.
public  StringgetAddressCity()
     getAddressCity purpose.
public  StringgetAddressCountry()
     getAddressCountry purpose.
public  StringgetAddressPostalCode()
     getAddressPostalCode purpose.
public  StringgetAddressState()
     getAddressState purpose.
public  StringgetAddressType()
     getAddressType purpose.
public  StringgetAdminPassword()
    
public  StringgetAdminUserName()
    
public  CharsetgetCharSet()
     getCharSet purpose.
public  StringgetContactEmail()
     getContactEmail purpose.
public  StringgetContactFacsimile()
     getContactFacsimile purpose.
public  StringgetContactOrganization()
     getContactOrganization purpose.
public  StringgetContactParty()
     Property representing the contact party (person, position or organization).
public  StringgetContactPerson()
     getContactPerson purpose.
public  StringgetContactPosition()
     getContactPosition purpose.
public  StringgetContactVoice()
     getContactVoice purpose.
public  BooleangetImageIOCache()
    
public  JAIgetJAIDefault()
    
public  BooleangetJPEGNativeAcceleration()
    
public  SunTileCachegetJaiCache()
    
public  StringgetLog4jConfigFile()
     getLoggingLevel purpose.
public static  FilegetLogLocation(String logLocation)
     Convenience method for determining the actual location on the local file system of the log file based an arbirtrary path.
public  StringgetLogLocation()
     Returns the location of where the server ouputs logs.
public  intgetMaxFeatures()
     getMaxFeatures purpose.
public  doublegetMemoryCapacity()
    
public  doublegetMemoryThreshold()
    
public  StringgetMimeType()
     getMimeType purpose.
public  intgetNumDecimals()
     getNumDecimals purpose.
public  StringgetOnlineResource()
     getOnlineResource purpose.
public  BooleangetPNGNativeAcceleration()
    
public  StringgetProxyBaseUrl()
    
public  BooleangetRecycling()
    
public  StringgetSchemaBaseUrl()
     getSchemaBaseUrl purpose.

The Schema Base URL for this instance.

public  booleangetSuppressStdOutLogging()
    
public  StringgetTileCache()
     Used when GeoServer is running beheind tile caching server.
public  intgetTilePriority()
    
public  intgetTileThreads()
    
public  StringgetTitle()
    
public  intgetUpdateSequence()
    
public  voidinitJAI(double memCapacity, double memoryThreshold, Boolean recycling, Boolean ImageIOCache)
    
public  booleanisVerbose()
    
public  booleanisVerboseExceptions()
    
public  voidload(GeoServerDTO dto)
    
final public  voidload(GeoServerDTO dto, ServletContext context)
     load purpose.
public  voidremoveListener(Listener listener)
     Removes a listener.
public  voidsetLogLocation(String logLocation)
    
public  voidsetSuppressStdOutLogging(boolean loggingToFile)
     Toggles server logging to file.
public  voidsetTileCache(String tileCache)
    
public  voidsetTitle(String title)
    
public  voidsetUpdateSequence(int updateSequence)
    
public  voidsetVerboseExceptions(boolean showStackTraces)
     If set to true, response exceptions will throw their stack trace back to the end user.
public static  voidsuppressLoggingConfiguration()
     Call this method if you want GeoServer not to configure the logging subsystem as instructed in the configuration file.
public  ObjecttoDTO()
     toDTO purpose.

This method is package visible only, and returns a reference to the GeoServerDTO.

public  StringtoString()
    

Field Detail
WEB_CONTAINER_KEY
final public static String WEB_CONTAINER_KEY(Code)
For finding the instance of this class to use from the web container

ServletContext sc = ... GeoServer gs = (GeoServer)sc.getAttribute(GeoServer.WEB_CONTAINER_KEY);





Constructor Detail
GeoServer
public GeoServer()(Code)
Default constructor only to facilitate unit testing mock ups; real uses shall create an instance through GeoServer.GeoServer(Config) .



GeoServer
public GeoServer(Config config) throws ConfigurationException(Code)
Creates a GeoServer instance and loads its configuration.
throws:
  ConfigurationException -




Method Detail
addListener
public void addListener(Listener listener)(Code)
Adds a listener to be notified of state change.



configureGeoServerLogging
public static void configureGeoServerLogging(String log4jConfigFileStr, boolean suppressStdOutLogging, String logFileName) throws IOException, ConfigurationException(Code)



configureGeoServerLogging
public static void configureGeoServerLogging(InputStream loggingConfigStream, boolean suppressStdOutLogging, boolean suppressFileLogging, String logFileName) throws FileNotFoundException, IOException, ConfigurationException(Code)



destroy
public void destroy() throws Exception(Code)
Implements DisposableBean.destroy to release resources being held by the server at server shutdown, such as JDBC connection pools and ArcSDE connection pools.

Note this process would greately benefit if DataStoreFactorySpi API had some sort of resource releasing method, so we could just traverse the available datastore factories asking them to release any resource needed.




fireChange
public void fireChange()(Code)
Notifies all listeners of a change.



getAddress
public String getAddress()(Code)
getAddress purpose.

Returns the contact Address.

String the contact Address.



getAddressCity
public String getAddressCity()(Code)
getAddressCity purpose.

Returns the contact City.

String the contact City.



getAddressCountry
public String getAddressCountry()(Code)
getAddressCountry purpose.

Returns the contact Country.

String the contact Country.



getAddressPostalCode
public String getAddressPostalCode()(Code)
getAddressPostalCode purpose.

Returns the contact PostalCode.

String the contact PostalCode.



getAddressState
public String getAddressState()(Code)
getAddressState purpose.

Returns the contact State.

String the contact State.



getAddressType
public String getAddressType()(Code)
getAddressType purpose.

Returns the contact Address Type.

String the contact Address Type.



getAdminPassword
public String getAdminPassword()(Code)



getAdminUserName
public String getAdminUserName()(Code)



getCharSet
public Charset getCharSet()(Code)
getCharSet purpose.

Returns the default charset for this server instance.

Charset the default charset for this server instance.



getContactEmail
public String getContactEmail()(Code)
getContactEmail purpose.

Returns the contact Email.

String the contact Email.



getContactFacsimile
public String getContactFacsimile()(Code)
getContactFacsimile purpose.

Returns the contact Facsimile.

String the contact Facsimile.



getContactOrganization
public String getContactOrganization()(Code)
getContactOrganization purpose.

Returns the contact Organization.

String the contact Organization.



getContactParty
public String getContactParty()(Code)
Property representing the contact party (person, position or organization).

This is a derived property.

Contact party (person, position or organization), null ifunknown



getContactPerson
public String getContactPerson()(Code)
getContactPerson purpose.

Returns the contact Person.

String the contact Person.



getContactPosition
public String getContactPosition()(Code)
getContactPosition purpose.

Returns the contact Position.

String the contact Position.



getContactVoice
public String getContactVoice()(Code)
getContactVoice purpose.

Returns the contact Phone.

String the contact Phone.



getImageIOCache
public Boolean getImageIOCache()(Code)
Returns the imageIOCache.



getJAIDefault
public JAI getJAIDefault()(Code)



getJPEGNativeAcceleration
public Boolean getJPEGNativeAcceleration()(Code)



getJaiCache
public SunTileCache getJaiCache()(Code)



getLog4jConfigFile
public String getLog4jConfigFile()(Code)
getLoggingLevel purpose.

Returns the Logging Level.

String the Logging Level.



getLogLocation
public static File getLogLocation(String logLocation) throws IOException(Code)
Convenience method for determining the actual location on the local file system of the log file based an arbirtrary path. Relative paths are appended to the geoserver data directory.
Parameters:
  location - The log file path, this can be an absolute or relativepath.
Parameters:
  context - The servlet context The file containing the absolute path to the log file.
throws:
  IOException -



getLogLocation
public String getLogLocation()(Code)
Returns the location of where the server ouputs logs. Note that this may not reference an actual physical location on disk. Call GeoServer.getLogLocation(StringServletContext) to map this string to a file on disk.



getMaxFeatures
public int getMaxFeatures()(Code)
getMaxFeatures purpose.

Returns the max number of features supported.

String the max number of features supported.



getMemoryCapacity
public double getMemoryCapacity()(Code)



getMemoryThreshold
public double getMemoryThreshold()(Code)



getMimeType
public String getMimeType()(Code)
getMimeType purpose.

Returns the server default mimetype.

String the server default mimetype.



getNumDecimals
public int getNumDecimals()(Code)
getNumDecimals purpose.

The default number of decimals allowed in the data.

int the default number of decimals allowed in the data.



getOnlineResource
public String getOnlineResource()(Code)
getOnlineResource purpose.

Returns the online Resource.

String the online Resource.



getPNGNativeAcceleration
public Boolean getPNGNativeAcceleration()(Code)



getProxyBaseUrl
public String getProxyBaseUrl()(Code)
Used when Geoserver is running behind a reverse-proxy so that url in getCapabilities documents are fine



getRecycling
public Boolean getRecycling()(Code)



getSchemaBaseUrl
public String getSchemaBaseUrl()(Code)
getSchemaBaseUrl purpose.

The Schema Base URL for this instance. This should generally be a local reference, as GeoServer by default puts up the schemas that it needs and references them. It could be used to specify an alternate site for the schemas, however, for example if a user didn't want their servlet container hit every time someone did a validation, they could instead store it on another machine. I don't really know if this is useful to anyone...

String the Schema Base URL for this instance.



getSuppressStdOutLogging
public boolean getSuppressStdOutLogging()(Code)
True if the server is logging to file, otherwise false.



getTileCache
public String getTileCache()(Code)
Used when GeoServer is running beheind tile caching server.

This value should be used when writing out a url which is a getmap request to reference the tile caching server and not GeoServer itself.

This value can be:

  1. A fully qualified host name + path (URL)
  2. A partial path which is interpreted as relative to the host running GeoServer
  3. null


See Also:   Requests.getTileCacheBaseUrl(javax.servlet.http.HttpServletRequestGeoServer)



getTilePriority
public int getTilePriority()(Code)



getTileThreads
public int getTileThreads()(Code)



getTitle
public String getTitle()(Code)
DOCUMENT ME! Returns the title.



getUpdateSequence
public int getUpdateSequence()(Code)
the updateSequence



initJAI
public void initJAI(double memCapacity, double memoryThreshold, Boolean recycling, Boolean ImageIOCache)(Code)



isVerbose
public boolean isVerbose()(Code)
whether xml documents should be pretty formatted true when verbose



isVerboseExceptions
public boolean isVerboseExceptions()(Code)
Should we display stackTraces or not? (And give them a nice little message instead?) Returns the showStackTraces.



load
public void load(GeoServerDTO dto) throws ConfigurationException(Code)

Loads the GeoServerDTO into the current instance as a GeoServer object


Parameters:
  dto -
throws:
  ConfigurationException -



load
final public void load(GeoServerDTO dto, ServletContext context) throws ConfigurationException(Code)
load purpose.

Loads the GeoServerDTO into the current instance as a GeoServer object. As GeoServer moves to Spring, we want to move away from storing state in the servlet context, so this method is deprecated.


Parameters:
  dto - GeoServerDTO
throws:
  ConfigurationException - If an error occursGeoServer.load(GeoServerDTO)



removeListener
public void removeListener(Listener listener)(Code)
Removes a listener.



setLogLocation
public void setLogLocation(String logLocation)(Code)

Parameters:
  logLocation - The string representation of the path on disk in whichthe server logs to.



setSuppressStdOutLogging
public void setSuppressStdOutLogging(boolean loggingToFile)(Code)
Toggles server logging to file.



setTileCache
public void setTileCache(String tileCache)(Code)



setTitle
public void setTitle(String title)(Code)
DOCUMENT ME!
Parameters:
  title - The title to set.



setUpdateSequence
public void setUpdateSequence(int updateSequence)(Code)

Parameters:
  updateSequence - the updateSequence to set



setVerboseExceptions
public void setVerboseExceptions(boolean showStackTraces)(Code)
If set to true, response exceptions will throw their stack trace back to the end user.
Parameters:
  showStackTraces - The showStackTraces to set.



suppressLoggingConfiguration
public static void suppressLoggingConfiguration()(Code)
Call this method if you want GeoServer not to configure the logging subsystem as instructed in the configuration file. To be used mainly in unit testing where we want to control logging programmatically.



toDTO
public Object toDTO()(Code)
toDTO purpose.

This method is package visible only, and returns a reference to the GeoServerDTO. This method is unsafe, and should only be used with extreme caution.

DTO the generated object



toString
public String toString()(Code)



Fields inherited from org.vfny.geoserver.global.GlobalLayerSupertype
final protected static Logger LOGGER(Code)(Java Doc)

Methods inherited from org.vfny.geoserver.global.GlobalLayerSupertype
public static String get(Map map, String key)(Code)(Java Doc)
public static File get(Map map, String key, File defaultFile)(Code)(Java Doc)
public static String get(Map map, String key, String defaultValue)(Code)(Java Doc)
public static List get(Map map, String key, List defaultList)(Code)(Java Doc)
public static Map get(Map map, String key, Map defaultMap)(Code)(Java Doc)
public static int get(Map map, String key, int defaultValue)(Code)(Java Doc)
public static boolean get(Map map, String key, boolean defaultValue)(Code)(Java Doc)
public static Charset get(Map map, String key, Charset defaultCharSet)(Code)(Java Doc)
public static Level get(Map map, String key, Level defaultLevel)(Code)(Java Doc)
public static URL get(Map map, String key, URL defaultUrl)(Code)(Java Doc)
public static Class get(Map map, String key, Class defaultType)(Code)(Java Doc)
protected String notNull(String s)(Code)(Java Doc)
abstract Object toDTO()(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.