Java Doc for ServletContainerAdapter.java in  » Library » Apache-beehive-1.0.2-src » org » apache » beehive » netui » pageflow » 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 » Library » Apache beehive 1.0.2 src » org.apache.beehive.netui.pageflow 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.beehive.netui.pageflow.ServletContainerAdapter

All known Subclasses:   org.apache.beehive.netui.pageflow.DefaultServletContainerAdapter,
ServletContainerAdapter
public interface ServletContainerAdapter extends Adapter(Code)
Adapter interface for plugging into various Servlet containers. An implementor of this interface is "discovered" at runtime. The discovery process is as follows:
  • A list of META-INF/services/org.apache.beehive.netui.pageflow.ServletContainerAdapter resources is obtained from classpath. This means, for example, that a file called "org.apache.beehive.netui.pageflow.ServletContainerAdapter" under directory META-INF/services would be found inside any JAR file on classpath.
  • Inside each of these resources is the name of a class that implements ServletContainerAdapter. This class is loaded, and its ServletContainerAdapter.accept accept method is called.
  • If ServletContainerAdapter.accept accept returns true, then that implementation class is chosen as the current adapter; otherwise, the next one in the list is tried.
  • If no adapters are discovered, an instance of DefaultServletContainerAdapter is used.




Method Summary
public  voidbeginRequest(HttpServletRequest request, HttpServletResponse response)
     Called at the beginning of each processed request.
public  ObjectcreateControlBeanContext(HttpServletRequest request, HttpServletResponse response)
     Get a context object to support Beehive Controls.
Parameters:
  request - the current HttpServletRequest.
Parameters:
  response - the current HttpServletResponse.
 booleandoSecurityRedirect(String path, HttpServletRequest request, HttpServletResponse response)
     Cause the server to do a security check for the given path.
public  voidendRequest(HttpServletRequest request, HttpServletResponse response)
     Called at the end of each processed request.
public  voidensureFailover(String attrName, Object attrVal, HttpServletRequest request)
     Ensure that the given session attribute is replicated in a cluster for session failover.
public  PageFlowEventReportergetEventReporter()
     Get an event reporter, which will be notified of events like "page flow created", "action raised", etc.
public  FactorygetFactory(Class classType, String id, FactoryConfig config)
     Generic method to get a Factory class that may be container dependent.
public  StringgetFullContextPath(HttpServletRequest request)
     Return the webapp context path for the given request.
public  intgetListenPort(HttpServletRequest request)
     Get the port on which the server is listening for unsecure connections.
Parameters:
  request - the current HttpServletRequest.
public  StringgetPlatformName()
     Get the name of the platform, which may be used to find platform-specific configuration files.
public  intgetSecureListenPort(HttpServletRequest request)
     Get the port on which the server is listening for secure connections.
Parameters:
  request - the current HttpServletRequest.
public  SecurityProtocolgetSecurityProtocol(String path, HttpServletRequest request)
     Tell whether a web application resource requires a secure transport protocol.
public  booleanisInProductionMode()
     Tell whether the server is running in production mode.
public  voidlogin(String username, String password, HttpServletRequest request, HttpServletResponse response)
     Log in the user, using "weak" username/password authentication.
public  voidlogout(boolean invalidateSessions, HttpServletRequest request, HttpServletResponse response)
     Log out the current user.
Parameters:
  invalidateSessions - if true, the session is invalidated (on all single-signon webapps); otherwise the session and its data are left intact.



Method Detail
beginRequest
public void beginRequest(HttpServletRequest request, HttpServletResponse response)(Code)
Called at the beginning of each processed request.
Parameters:
  request - the current HttpServletRequest.
Parameters:
  response - the current HttpServletResponse.



createControlBeanContext
public Object createControlBeanContext(HttpServletRequest request, HttpServletResponse response)(Code)
Get a context object to support Beehive Controls.
Parameters:
  request - the current HttpServletRequest.
Parameters:
  response - the current HttpServletResponse. a new ControlBeanContext.



doSecurityRedirect
boolean doSecurityRedirect(String path, HttpServletRequest request, HttpServletResponse response)(Code)
Cause the server to do a security check for the given path. If required, it does a redirect to change the scheme (http/https).
Parameters:
  path - the webapp-relative path on which to run security checks.
Parameters:
  request - the current HttpServletRequest.
Parameters:
  response - the current HttpServletResponse. true if a redirect occurred.



endRequest
public void endRequest(HttpServletRequest request, HttpServletResponse response)(Code)
Called at the end of each processed request.
Parameters:
  request - the current HttpServletRequest.
Parameters:
  response - the current HttpServletResponse.



ensureFailover
public void ensureFailover(String attrName, Object attrVal, HttpServletRequest request)(Code)
Ensure that the given session attribute is replicated in a cluster for session failover. This method does not need to be implemented for servers that do not support clustering and session failover.
Parameters:
  attrName - the name of the session attribute for which failover should be ensured.
Parameters:
  attrVal - the value of the given session attribute.
Parameters:
  request - the current HttpServletRequest.



getEventReporter
public PageFlowEventReporter getEventReporter()(Code)
Get an event reporter, which will be notified of events like "page flow created", "action raised", etc.



getFactory
public Factory getFactory(Class classType, String id, FactoryConfig config)(Code)
Generic method to get a Factory class that may be container dependent.

This method is called to get the following Factory implementations:


Parameters:
  classType - the class type that the factory should extend or implement.
Parameters:
  id - can be used for the case where there is more than one possible Factorythat extends or implaments the class type.
Parameters:
  config - a configuration object passed to a Factory a Factory class that extends or implemtents the given class type.



getFullContextPath
public String getFullContextPath(HttpServletRequest request)(Code)
Return the webapp context path for the given request. This differs from HttpServletRequest.getContextPath() only in that it will return a valid value even if the request is for the default webapp.
Parameters:
  request - the current HttpServletRequest.



getListenPort
public int getListenPort(HttpServletRequest request)(Code)
Get the port on which the server is listening for unsecure connections.
Parameters:
  request - the current HttpServletRequest. the port on which the server is listening for unsecure connections.



getPlatformName
public String getPlatformName()(Code)
Get the name of the platform, which may be used to find platform-specific configuration files. the name of the platform



getSecureListenPort
public int getSecureListenPort(HttpServletRequest request)(Code)
Get the port on which the server is listening for secure connections.
Parameters:
  request - the current HttpServletRequest. the port on which the server is listening for secure connections.



getSecurityProtocol
public SecurityProtocol getSecurityProtocol(String path, HttpServletRequest request)(Code)
Tell whether a web application resource requires a secure transport protocol. This is determined from web.xml; for example, the following block specifies that all resources under /login require a secure transport protocol.
 <security-constraint>
 <web-resource-collection>
 <web-resource-name>Secure PageFlow - begin</web-resource-name> 
 <url-pattern>/login/*</url-pattern>
 </web-resource-collection>
 <user-data-constraint>
 <transport-guarantee>CONFIDENTIAL</transport-guarantee>
 </user-data-constraint>
 </security-constraint>
 

Parameters:
  path - a webapp-relative path for a resource.
Parameters:
  request - the current HttpServletRequest. Boolean.TRUE if a transport-guarantee of CONFIDENTIAL orINTEGRAL is associated with the given resource; Boolean.FALSE a transport-guarantee of NONE is associated with the given resource; ornull if there is no transport-guarantee associated with the given resource.



isInProductionMode
public boolean isInProductionMode()(Code)
Tell whether the server is running in production mode. true if the server is running in production mode.



login
public void login(String username, String password, HttpServletRequest request, HttpServletResponse response) throws LoginException(Code)
Log in the user, using "weak" username/password authentication.
Parameters:
  username - the user's login name.
Parameters:
  password - the user's password.
Parameters:
  request - the current HttpServletRequest.
Parameters:
  response - the current HttpServletResponse.
exception:
  LoginException - if the authentication failed



logout
public void logout(boolean invalidateSessions, HttpServletRequest request, HttpServletResponse response)(Code)
Log out the current user.
Parameters:
  invalidateSessions - if true, the session is invalidated (on all single-signon webapps); otherwise the session and its data are left intact. To invalidate the session in only thecurrent webapp, set this parameter to false and call invalidate() on the HttpSession.
Parameters:
  request - the current HttpServletRequest.
Parameters:
  response - the current HttpServletResponse.



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