Java Doc for Request.java in  » GIS » GeoServer » org » vfny » geoserver » 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 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.vfny.geoserver.Request

All known Subclasses:   org.vfny.geoserver.wms.requests.WMSRequest,  org.vfny.geoserver.wcs.requests.WCSRequest,  org.vfny.geoserver.util.requests.CapabilitiesRequest,  org.vfny.geoserver.sld.requests.PutStylesRequest,
Request
abstract public class Request (Code)
Defines a general Request type and provides accessor methods for universal request information.

Also provides access to the HttpRequest that spawned this GeoServer Request. This HttpRequest is most often used to lookup information stored in the Web Container (such as the GeoServer Global information).


author:
   Rob Hranac, TOPP
author:
   Chris Holmes, TOPP
author:
   Gabriel Roldan
author:
   $Author: Alessio Fabiani (alessio.fabiani@gmail.com) $ (last modification)
author:
   $Author: Simone Giannecchini (simboss1@gmail.com) $ (last modification)
version:
   $Id: Request.java 7522 2007-09-12 22:00:10Z saul.farber $


Field Summary
protected  StringbaseUrl
     reference to the base Url that this request was called with.
protected  HttpServletRequesthttpServletRequest
     HttpServletRequest responsible for generating this GeoServer Request.
protected  Stringrequest
    
protected  Stringservice
     The service type of the request.
protected  AbstractServiceserviceRef
    
protected  Stringversion
    

Constructor Summary
protected  Request(String serviceType, String requestType, AbstractService serviceRef)
     ServiceType,RequestType,ServiceRef constructor.

Method Summary
public  booleanequals(Object o)
    
public  StringgetBaseUrl()
     Gets the base url that made this request.
public  HttpServletRequestgetHttpServletRequest()
     Retrive the ServletRequest that generated this GeoServer request.
public  StringgetRequest()
     Gets requested request type.

TODO: Could this bre renamed getType() for clarity?

Um, no.

public  StringgetRootDir()
    
public  StringgetSchemaBaseUrl()
     Gets the url that schemas should be referenced from.
public  StringgetService()
     Gets requested service.
public  AbstractServicegetServiceRef()
    
public  StringgetVersion()
     Return version type.
public  inthashCode()
     Generate a hashCode based on this Request Object.
public  booleanisDispatchedRequest()
     Whether this request was sent through one of the dispatchers, or if it went directly through the servlet.
public  booleanisLoggedIn()
     Tests if user is Logged into GeoServer.
public  voidsetBaseUrl(String s)
     Set the baseUrl that this request was called with.
public  voidsetHttpServletRequest(HttpServletRequest servletRequest)
     Sets the servletRequest that generated this GeoServer request.
public  voidsetRequest(String requestType)
     Sets requested request type.
public  voidsetService(String service)
     Gets requested service.
public  voidsetServiceRef(AbstractService serviceRef)
     Sets the reference to the service.
public  voidsetVersion(String version)
     Sets version type.

Field Detail
baseUrl
protected String baseUrl(Code)
reference to the base Url that this request was called with. Note that this is a complete duplicate of info in the above HttpServletRequest object, and is mainly a forward-thinking field that's going to stick around when the above HttpServletRequest goes away.



httpServletRequest
protected HttpServletRequest httpServletRequest(Code)
HttpServletRequest responsible for generating this GeoServer Request.



request
protected String request(Code)
Request type



service
protected String service(Code)
The service type of the request. In other words, is it a WMS or a WFS. This is a standard element of a request. It now has a practical purpose in GeoServer, as a GetCapabilities request can be WMS or WFS, this element tells which it is.



serviceRef
protected AbstractService serviceRef(Code)
service reference



version
protected String version(Code)
Request version




Constructor Detail
Request
protected Request(String serviceType, String requestType, AbstractService serviceRef)(Code)
ServiceType,RequestType,ServiceRef constructor.
Parameters:
  serviceType - Name of hte service (example, WFS)
Parameters:
  requestType - Name of the request (example, GetCapabilties)
Parameters:
  serviceRef - The servlet for the request.




Method Detail
equals
public boolean equals(Object o)(Code)



getBaseUrl
public String getBaseUrl()(Code)
Gets the base url that made this request. This is used to return the referenced schemas and whatnot relative to the request. The base portion of the url that the client used to make the request.



getHttpServletRequest
public HttpServletRequest getHttpServletRequest() throws ClassCastException(Code)
Retrive the ServletRequest that generated this GeoServer request.

The ServletRequest is often used to:

  • Access the Sesssion and WebContainer by execute opperations
  • Of special importance is the use of the ServletRequest to locate the GeoServer Application
  • This method is called by AbstractServlet during the processing of a Request.

    The HttpServletRequest responsible for generating this SerivceRequest



getRequest
public String getRequest()(Code)
Gets requested request type.

TODO: Could this bre renamed getType() for clarity?

Um, no. getType() is less clear. getRequest makes sense because this is directly modeled off of the XML and KVP Requests that a wfs or wms makes, and they all contain an element called Request. The name of the request.




getRootDir
public String getRootDir()(Code)



getSchemaBaseUrl
public String getSchemaBaseUrl()(Code)
Gets the url that schemas should be referenced from. For now this will always be local, if we bring back schemaBaseUrl as a param then that will be possible too. So it is just baseUrl plus data/capabilities, which is where we store the schemas now. the base url of the schemas. Will be getBaseUrl() + data/capabilities.



getService
public String getService()(Code)
Gets requested service. The requested service.



getServiceRef
public AbstractService getServiceRef()(Code)
the reference the service.



getVersion
public String getVersion()(Code)
Return version type. The request type version.



hashCode
public int hashCode()(Code)
Generate a hashCode based on this Request Object.



isDispatchedRequest
public boolean isDispatchedRequest()(Code)
Whether this request was sent through one of the dispatchers, or if it went directly through the servlet. This is used by the capabilities response, since we give back a dispatched capabilities document to clients who request it with a dispatcher. true if the request came through a dispatcher.



isLoggedIn
public boolean isLoggedIn()(Code)
Tests if user is Logged into GeoServer. true if user is logged in



setBaseUrl
public void setBaseUrl(String s)(Code)
Set the baseUrl that this request was called with.



setHttpServletRequest
public void setHttpServletRequest(HttpServletRequest servletRequest)(Code)
Sets the servletRequest that generated this GeoServer request.

The ServletRequest is often used to:

  • Access the Sesssion and WebContainer by execute opperations
  • Of special importance is the use of the ServletRequest to locate the GeoServer Application

  • Parameters:
      servletRequest - The servletRequest to set.



setRequest
public void setRequest(String requestType)(Code)
Sets requested request type.
Parameters:
  reqeust - The type of request.



setService
public void setService(String service)(Code)
Gets requested service.
Parameters:
  service - The requested service.



setServiceRef
public void setServiceRef(AbstractService serviceRef)(Code)
Sets the reference to the service.



setVersion
public void setVersion(String version)(Code)
Sets version type.
Parameters:
  version - The request type version.



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.