Java Doc for GenericConsumerEnvironment.java in  » Portal » liferay-portal-4.4.2 » org » apache » wsrp4j » consumer » driver » 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 » liferay portal 4.4.2 » org.apache.wsrp4j.consumer.driver 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.wsrp4j.consumer.driver.GenericConsumerEnvironment

All known Subclasses:   com.liferay.portlet.wsrp.ConsumerEnvironmentImpl,
GenericConsumerEnvironment
abstract public class GenericConsumerEnvironment implements ConsumerEnvironment(Code)



Constructor Summary
public  GenericConsumerEnvironment()
    

Method Summary
public  String[]getCharacterEncodingSet()
     Get the character sets the consumer wants the remote portlet to use for encoding the markup.
public  StringgetConsumerAgent()
    
public  String[]getMimeTypes()
     Get an array of mime types which are supported by the consumer.
public  PortletDriverRegistrygetPortletDriverRegistry()
     Get the portlet driver registry of the consumer.
public  PortletRegistrygetPortletRegistry()
     Get the portlet registry of the consumer.
public  StateChangegetPortletStateChange()
     Returns a flag which is used to indicate the producer wether or not the processing of portlets is allowed to modify the portlet state.
public  ProducerRegistrygetProducerRegistry()
     Get the producer registry of the consumer.
public  SessionHandlergetSessionHandler()
     Get the session handler of the consumer.
public  String[]getSupportedLocales()
     Get the locales which are supported by the consumer.
public  String[]getSupportedModes()
     Get the portlet modes the consumer is willing to manage.
public  String[]getSupportedWindowStates()
     Get the window states the consumer is willing to manage.
public  URLTemplateComposergetTemplateComposer()
    
public  URLRewritergetURLRewriter()
    
public  StringgetUserAuthentication()
     Get the method which is used by the consumer to authenticate its users.
public  UserRegistrygetUserRegistry()
     Get the user registry of the consumer.
public  voidsetCharacterEncodingSet(String[] charEncoding)
     Set the character set the consumer wants the remote portlet to use for encoding the markup.
public  voidsetConsumerAgent(String name)
    
public  voidsetMimeTypes(String[] mimeTypes)
     Set the mime types the consumer supports The order in the array defines the order of preference of the consumer.
public  voidsetPortletDriverRegistry(PortletDriverRegistry portletDriverRegistry)
     Set the portlet driver registry of the consumer.
public  voidsetPortletRegistry(PortletRegistry portletRegistry)
     Set the portlet registry of the consumer.
public  voidsetPortletStateChange(StateChange portletStateChange)
     Set a flag which is used to indicate the producer wether or not the processing of portlets is allowed to modify the portlet state.
public  voidsetProducerRegistry(ProducerRegistry producerRegistry)
     Set the producer registry of the consumer.
public  voidsetSessionHandler(SessionHandler sessionHandler)
     Set the session handler of the consumer.
public  voidsetSupportedLocales(String[] locales)
     Set the locales which are supported by the consumer.
public  voidsetSupportedModes(String[] modes)
     Set the portlet modes which are supported by the consumer.
public  voidsetSupportedWindowStates(String[] states)
     Set the window states which are supported by the consumer.
public  voidsetTemplateComposer(URLTemplateComposer templateComposer)
    
public  voidsetURLRewriter(URLRewriter urlRewriter)
    
public  voidsetUserAuthentication(String authMethod)
     Set the method of end user authentication used by the consumer..
public  voidsetUserRegistry(UserRegistry userRegistry)
     Set the user registry of the consumer.


Constructor Detail
GenericConsumerEnvironment
public GenericConsumerEnvironment()(Code)




Method Detail
getCharacterEncodingSet
public String[] getCharacterEncodingSet()(Code)
Get the character sets the consumer wants the remote portlet to use for encoding the markup. Valid character sets are defined here Array of string representations of the character encoding.



getConsumerAgent
public String getConsumerAgent()(Code)
Get the name of the consumer The name of the consumer



getMimeTypes
public String[] getMimeTypes()(Code)
Get an array of mime types which are supported by the consumer. The order in the array defines the order of preference of the consumer. An array of mimes types the consumer supports.



getPortletDriverRegistry
public PortletDriverRegistry getPortletDriverRegistry()(Code)
Get the portlet driver registry of the consumer. Interface to the consumer specific portlet driver registry



getPortletRegistry
public PortletRegistry getPortletRegistry()(Code)
Get the portlet registry of the consumer. Interface to the consumer specific portlet registry



getPortletStateChange
public StateChange getPortletStateChange()(Code)
Returns a flag which is used to indicate the producer wether or not the processing of portlets is allowed to modify the portlet state. A flag



getProducerRegistry
public ProducerRegistry getProducerRegistry()(Code)
Get the producer registry of the consumer. The consumer specific producer registry



getSessionHandler
public SessionHandler getSessionHandler()(Code)
Get the session handler of the consumer. Interface to the consumer specific session handler



getSupportedLocales
public String[] getSupportedLocales()(Code)
Get the locales which are supported by the consumer. (ISO-639 + "_" + ISO-3166) Array with String representations of the locales which aresupported by the consumer



getSupportedModes
public String[] getSupportedModes()(Code)
Get the portlet modes the consumer is willing to manage. Array with string representations of the portlet modes which aresupported by the consumer



getSupportedWindowStates
public String[] getSupportedWindowStates()(Code)
Get the window states the consumer is willing to manage. Array with string representations of the window states which aresupported by the consumer



getTemplateComposer
public URLTemplateComposer getTemplateComposer()(Code)
Get the url template composer for template proccessing Interface to the consumer specific template composer



getURLRewriter
public URLRewriter getURLRewriter()(Code)
Get the url rewriter for consumer url-rewriting The consumer specific url rewriter



getUserAuthentication
public String getUserAuthentication()(Code)
Get the method which is used by the consumer to authenticate its users. String indicating how end-users were authenticated by the consumer.



getUserRegistry
public UserRegistry getUserRegistry()(Code)
Get the user registry of the consumer. The consumer specific user registry



setCharacterEncodingSet
public void setCharacterEncodingSet(String[] charEncoding)(Code)
Set the character set the consumer wants the remote portlet to use for encoding the markup. Valid character sets are defined here
Parameters:
  charEncoding - Array of string representations of the character encoding.



setConsumerAgent
public void setConsumerAgent(String name)(Code)
Set the name of the consumer
Parameters:
  name - The new name of the consumer



setMimeTypes
public void setMimeTypes(String[] mimeTypes)(Code)
Set the mime types the consumer supports The order in the array defines the order of preference of the consumer.
Parameters:
  mimeTypes - An array of mimes types the consumer supports.



setPortletDriverRegistry
public void setPortletDriverRegistry(PortletDriverRegistry portletDriverRegistry)(Code)
Set the portlet driver registry of the consumer.
Parameters:
  portletDriverRegistry - The consumer specific portlet driver registry



setPortletRegistry
public void setPortletRegistry(PortletRegistry portletRegistry)(Code)
Set the portlet registry of the consumer.
Parameters:
  portletRegistry - The consumer specific portlet registry



setPortletStateChange
public void setPortletStateChange(StateChange portletStateChange)(Code)
Set a flag which is used to indicate the producer wether or not the processing of portlets is allowed to modify the portlet state.
Parameters:
  portletStateChange - A flag with one of the following values (OK, Clone, Fault)



setProducerRegistry
public void setProducerRegistry(ProducerRegistry producerRegistry)(Code)
Set the producer registry of the consumer.
Parameters:
  producerRegistry - The consumer specific producer registry



setSessionHandler
public void setSessionHandler(SessionHandler sessionHandler)(Code)
Set the session handler of the consumer.
Parameters:
  sessionHandler - The consumer specific session handler



setSupportedLocales
public void setSupportedLocales(String[] locales)(Code)
Set the locales which are supported by the consumer. Pattern: ISO-639 + "_" + ISO-3166
Parameters:
  locales - Array of String representations of the supported locales



setSupportedModes
public void setSupportedModes(String[] modes)(Code)
Set the portlet modes which are supported by the consumer.
Parameters:
  modes - Array of string representations of portlet modes



setSupportedWindowStates
public void setSupportedWindowStates(String[] states)(Code)
Set the window states which are supported by the consumer.
Parameters:
  states - Array of string representations of window states



setTemplateComposer
public void setTemplateComposer(URLTemplateComposer templateComposer)(Code)
Set the url template composer for template proccessing
Parameters:
  templateComposer - The consumer specific template composer



setURLRewriter
public void setURLRewriter(URLRewriter urlRewriter)(Code)
Set the url rewriter for consumer url-rewriting
Parameters:
  urlRewriter - The consumer specific url rewriter



setUserAuthentication
public void setUserAuthentication(String authMethod)(Code)
Set the method of end user authentication used by the consumer..
Parameters:
  authMethod - String indicating how end-users are authenticated by the consumer.



setUserRegistry
public void setUserRegistry(UserRegistry userRegistry)(Code)
Set the user registry of the consumer.
Parameters:
  userRegistry - The consumer specific user registry



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.