Java Doc for __Provider__.java in  » Portal » Open-Portal » __PACKAGE__ » 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 » Portal » Open Portal » __PACKAGE__ 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   __PACKAGE__.__NAME__

__NAME__
public class __NAME__ implements Provider,ProviderWidths,ProviderEditTypes(Code)




Method Summary
public  StringBuffergetContent(HttpServletRequest request, HttpServletResponse response)
     Gets the provider's objects default view. This method is called by the clients of the provider object to request the provider's default view.

This method may return null if the provider does not implement a default view.

public  StringBuffergetContent(Map m)
    
public  StringgetDescription()
     Gets the description of this provider.
public  StringBuffergetEdit(HttpServletRequest request, HttpServletResponse response)
     Gets the edit view for the provider.

This method is called by the clients of the provider object to request the provider's edit view.

public  StringBuffergetEdit(Map m)
    
public  intgetEditType()
     Gets the edit form type of the provider.
public  URLgetHelp(HttpServletRequest request)
     Gets the help URL for this provider.

The returned help URL can be either fully-qualified URL string (e.g., http://server:port/portal/docs/en_US/desktop/usedesk.htm) or a relative path (e.g., desktop/usedesk.htm)).

public  StringgetName()
     Gets the name of this provider.
public  longgetRefreshTime()
     Gets the refresh time for this provider, in seconds.
public  StringgetTitle()
     Gets the title of this provider.
public  intgetWidth()
     Gets the width of this provider.
public  voidinit(String pName, HttpServletRequest request)
     Initializes the provider.

This method must be called by clients of the provider object when the provider object is created (after it is constructed, or before the object is used).

public  booleanisEditable()
     This method determines if the provider has an edit view.
public  booleanisPresentable()
     Determines if the provider is presentable based on the client device type.
public  URLprocessEdit(HttpServletRequest request, HttpServletResponse response)
     Processes a form for this provider.

This method is called to process form data associated with the provider.

public  URLprocessEdit(Map m)
    



Method Detail
getContent
public StringBuffer getContent(HttpServletRequest request, HttpServletResponse response) throws ProviderException(Code)
Gets the provider's objects default view. This method is called by the clients of the provider object to request the provider's default view.

This method may return null if the provider does not implement a default view. In this case, the provider should return false from its isPresentable() method. StringBuffer holding the content.
Parameters:
  request - An HttpServletRequest that containsinformation related to this request for content.
Parameters:
  response - An HttpServletResponse that allows the providerto influence the overall response for the desktop page (besides generating the content).
exception:
  ProviderException - If there was an error generating thecontent. How this exception is handled is up to the client of theprovider object.
See Also:   com.sun.portal.providers.ProviderException




getContent
public StringBuffer getContent(Map m) throws ProviderException(Code)



getDescription
public String getDescription() throws ProviderException(Code)
Gets the description of this provider. The description of this provider.
See Also:   com.sun.portal.providers.Provider.init



getEdit
public StringBuffer getEdit(HttpServletRequest request, HttpServletResponse response) throws ProviderException(Code)
Gets the edit view for the provider.

This method is called by the clients of the provider object to request the provider's edit view.

This method must generate either a complete document, or a subset, depending on the return value of .getEditType().

A subset document should include all code that goes between the FORM tags. The exception is that the submit and cancel buttons should not be generated. A subset document is always submitted back to the desktop servlet, where control is passed to the provider's processEdit() method for processing the form data.

If a complete document is returned, there are several restrictions:

  • It must be a complete, valid form.
  • The form must have an encoding type of "application/x-www-form-urlencoded".
  • The form action must point back to the desktop servlet. Typically, this is "/portal/dt".
  • The form must specify a valid action to the desktop servlet as defined in the DesktopSerlvet javadocs.

The above restrictions only apply if the form is to be submitted to the desktop servlet. If the form is submitted to a third-party CGI or servlet, the format will depend on what this entity is expecting.

This method may return null if the provider does not implement an edit view. In this case, the provider should return false from its isEditable() method. StringBuffer holding the html edit form.
Parameters:
  request - An HttpServletRequest thatcontains information related to this request for content.
Parameters:
  response - An HttpServletResponse thatallows the provider to influence the overall response for the desktop page (besides generating the content).
exception:
  ProviderException - If there was an error generating theedit form. How this exception is handled is up to the client of theprovider object.
See Also:   com.sun.portal.providers.Provider.getContent
See Also:   com.sun.portal.providers.Provider.isEditable
See Also:   com.sun.portal.providers.Provider.processEdit
See Also:   com.sun.portal.providers.Provider.getEditType
See Also:   com.sun.portal.desktop.DesktopServlet
See Also:   com.sun.portal.providers.ProviderException
See Also:   




getEdit
public StringBuffer getEdit(Map m) throws ProviderException(Code)



getEditType
public int getEditType() throws UnknownEditTypeException(Code)
Gets the edit form type of the provider.

This method returns, and therefore defines, the edit form type for provider. The edit type; either EDIT_SUBSET orEDIT_COMPLETE
exception:
  UnknownEditTypeException - If an unknown or undefinededit type is encountered.
See Also:   com.sun.portal.providers.Provider.getEdit
See Also:   com.sun.portal.providers.ProviderEditTypes




getHelp
public URL getHelp(HttpServletRequest request) throws ProviderException(Code)
Gets the help URL for this provider.

The returned help URL can be either fully-qualified URL string (e.g., http://server:port/portal/docs/en_US/desktop/usedesk.htm) or a relative path (e.g., desktop/usedesk.htm)). When it is relative path, the desktop software will prepend the server request string (e.g., http://server:port/portal, plus the document root (e.g., /docs/), plus the user locale (e.g., en_US/) to it to resolve the full URL. A URL pointing to the help page for the provider. A returnvalue of null should signify that this provider does not have ahelp page.




getName
public String getName()(Code)
Gets the name of this provider.

The name returned from this method must match the name of the provider that it was initialized with. The name of this provider.




getRefreshTime
public long getRefreshTime() throws ProviderException(Code)
Gets the refresh time for this provider, in seconds.

Clients of the provider object should use this value to determine if they should fetch a fresh default view for the provider.

If the return value from this method is X, they may choose to not fetch fresh content (and use a cached copy instead) if less than X seconds has elapsed since the last time content was fetched.

If provider content is expected to change very infrequently, this method can return some value so that the provider's content is not fetched every time the front page is drawn, thereby saving significant processing time.

Clients may choose not to use this value. >0, refresh time in number of seconds that a container shouldwait before expiring a content cache.0, container should never cache channel's content.-1, container may cache channel's content indefinitely.




getTitle
public String getTitle() throws ProviderException(Code)
Gets the title of this provider. The title of this provider.



getWidth
public int getWidth() throws ProviderException(Code)
Gets the width of this provider.

Clients of the provider object may call this method, allowing the channel to suggest how much / what type of screen real estate it requires. The return value of this method is only a suggestion, clients are free to interpret the return value or ignore it all together. The width of this provider, either WIDTH_THICKor WIDTH_THIN or WIDTH_FULL_TOPor WIDTH_FULL_BOTTOM.
See Also:   com.sun.portal.providers.ProviderWidths.WIDTH_THIN
See Also:   com.sun.portal.providers.ProviderWidths.WIDTH_THICK
See Also:   com.sun.portal.providers.ProviderWidths.WIDTH_FULL_TOP
See Also:   com.sun.portal.providers.ProviderWidths.WIDTH_FULL_BOTTOM
exception:
  ProviderException - When there was an exception getting the width




init
public void init(String pName, HttpServletRequest request) throws ProviderException(Code)
Initializes the provider.

This method must be called by clients of the provider object when the provider object is created (after it is constructed, or before the object is used). This method should not be called more than once per object.
Parameters:
  name - Unique name identifying this provider. This valueshould always be returned from getName().
Parameters:
  req - The HTTP request object corresponding to the HTTP requestthat caused this provider object to be created. This request may beused to extract session or user information that could be used togain access to external resources.
exception:
  ProviderException - If there was an error initializing theprovider. How this exception is handled is up to the client of theprovider object.
See Also:   com.sun.portal.providers.Provider.getName
See Also:   




isEditable
public boolean isEditable() throws ProviderException(Code)
This method determines if the provider has an edit view. true or false, indicating if theprovider has an edit view.
See Also:   com.sun.portal.providers.Provider.getEdit
See Also:   com.sun.portal.providers.Provider.processEdit
See Also:   



isPresentable
public boolean isPresentable()(Code)
Determines if the provider is presentable based on the client device type. true or false, indicating if theprovider is presentable to the user's client device.



processEdit
public URL processEdit(HttpServletRequest request, HttpServletResponse response) throws ProviderException(Code)
Processes a form for this provider.

This method is called to process form data associated with the provider. Typically, this method is called to process the edit page generated from the getEdit() method. Usually, the client calling this method on a provider object is the desktop servlet.

Form data, passed into this method in the request, has been decoded into Unicode.

When the desktop servlet receives a request where the action is "process", it looks at the parameters to identify which provider will handle the action, through this method. The request passed in contains the parameters.

After calling this method, the desktop servlet will re-direct to the URL returned from this method. Therefore, the result of a provider post can be any desktop serlvet action, or the content of an arbitrary URL. For more information on constructing desktop serlvet URLs, see DesktopSerlvet. The URL that the iPS desktop will re-direct to. A valueof null should indicate to the client that it should return to itsdefault view.
Parameters:
  request - An HttpServletRequest that containsinformation related to thisrequest for content.
Parameters:
  response - An HttpServletResponse that allows theprovider to influence the overall response for the desktop page (besides generating the content).
exception:
  ProviderException - If there was an error processingthe edit form. How this exception is handled is up to the client of theprovider object. The URL that the iPS desktop will re-direct to. A valueof null should indicate to the client that it should return to itsdefault view.
See Also:   com.sun.portal.providers.Provider.getEdit
See Also:   com.sun.portal.providers.Provider.isEditable
See Also:   com.sun.portal.providers.InvalidEditFormDataException
See Also:   com.sun.portal.desktop.DesktopServlet




processEdit
public URL processEdit(Map m) throws ProviderException(Code)



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.