Java Doc for ProducerImpl.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.util.StateChangedServiceImpl
      org.apache.wsrp4j.consumer.driver.ProducerImpl

ProducerImpl
public class ProducerImpl extends StateChangedServiceImpl implements Producer(Code)
A consumer representation of a WSRP-producer providing WSRP-portlets. Generally a producer can expose up to four WSRP-Interfaces. These interfaces are Markup-, Service Description-,Registration- and WSRPPortlet Management Interface. Whereas the Registration- and Portlet Management Interface are optional.
See Also:   Producer
author:
   Stephan Laertz
author:
   Richard Jacob



Constructor Summary
public  ProducerImpl()
     Default Constructor should not be used directly.
public  ProducerImpl(String producerID, String markupURL, String serviceDescriptionURL)
    
public  ProducerImpl(String producerID, String markupURL, String serviceDescriptionURL, String registrationURL, String portletManagementURL, RegistrationData registrationData)
    

Method Summary
public  voidaddPortletDescription(PortletDescription portletDescription)
     Add an portlet description to the producer.
public  ReturnAnyderegister()
    
public  StringgetDescription()
     Get a description of the producer.
public  StringgetID()
     Get the ID of the producer.
public  StringgetMarkupInterfaceEndpoint()
    
public  StringgetName()
     Get the name of the producer.
public  PortletDescriptiongetPortletDescription(String portletHandle)
     Get the portlet description of the portlet with the given handle from the service description or null if the producer doesn't offer an portlet with this handle in it's service description.
public  WSRP_v1_PortletManagement_PortTypegetPortletManagementInterface()
    
public  StringgetPortletManagementInterfaceEndpoint()
    
public  RegistrationContextgetRegistrationContext()
     Get the current registration context of the consumer registered at this producer or null if no registration is required or happend so far.
public  RegistrationDatagetRegistrationData()
     Get the registration data the consumer uses to register at this producer.
public  WSRP_v1_Registration_PortTypegetRegistrationInterface()
    
public  StringgetRegistrationInterfaceEndpoint()
     Get the URL of the producers registration interface.
public  ServiceDescriptiongetServiceDescription()
    
public  ServiceDescriptiongetServiceDescription(boolean newRequest)
    
public  WSRP_v1_ServiceDescription_PortTypegetServiceDescriptionInterface()
    
public  StringgetServiceDescriptionInterfaceEndpoint()
     Get the URL of the producers service description interface.
public  voidinitPortletManagementInterface(String portletManagementURL)
    
public  voidinitRegistrationInterface(String registrationURL)
     Initialize the registration interface of the producer.
public  voidinitServiceDescInterface(String serviceDescriptionURL)
     Initialize the service description interface of the producer.
public  booleanisPortletManagementInferfaceSupported()
    
public  booleanisRegistrationInterfaceSupported()
    
public  booleanisRegistrationRequired()
     Indicates wether or not the producer requires consumer registration.
public  RegistrationStatemodifyRegistration(RegistrationData registrationData)
     Can be used to modify the relationship between consumer and producer.
public  RegistrationContextregister(RegistrationData registrationData)
     Method establishes a relationship between consumer and producer.
public  voidsetDescription(String description)
     Set a description of the producer.
public  voidsetID(String id)
     Set the ID of the producer to he given value.
public  voidsetIsRegistrationRequired(boolean registrationRequired)
     Define if the producer requires in-band registration or not.
public  voidsetMarkupInterfaceEndpoint(String url)
    
public  voidsetName(String name)
     Set the name of the producer.
public  voidsetPortletManagementInterfaceEndpoint(String url)
    
public  voidsetRegistrationContext(RegistrationContext registrationContext)
     Set the registration context.
public  voidsetRegistrationData(RegistrationData regData)
     Set the registration the consumer uses the register at this producer.
public  voidsetRegistrationInterfaceEndpoint(String url)
     Set the URL of the producers registration interface.
public  voidsetServiceDescription(ServiceDescription serviceDescription)
     Set the consumer environment this producer is used.
public  voidsetServiceDescriptionInterfaceEndpoint(String url)
     Set the URL of the producers service description interface.


Constructor Detail
ProducerImpl
public ProducerImpl()(Code)
Default Constructor should not be used directly. But is required for persistence support by castor.



ProducerImpl
public ProducerImpl(String producerID, String markupURL, String serviceDescriptionURL) throws WSRPException(Code)
This constructor can be used to create a new producer object



ProducerImpl
public ProducerImpl(String producerID, String markupURL, String serviceDescriptionURL, String registrationURL, String portletManagementURL, RegistrationData registrationData) throws WSRPException(Code)
This constructor can be used to create a new producer object




Method Detail
addPortletDescription
public void addPortletDescription(PortletDescription portletDescription)(Code)
Add an portlet description to the producer. This portlet description is accessable through the portlet handle in the portlet description. If the producer has already an portlet description with this portlet handle than the old description will be overwritten.
Parameters:
  portletDescription - New portlet description



deregister
public ReturnAny deregister() throws WSRPException(Code)
End an existing consumer producer relationship and remove the registration context Can be anything



getDescription
public String getDescription()(Code)
Get a description of the producer. A description of the producer



getID
public String getID()(Code)
Get the ID of the producer. The ID of the producer



getMarkupInterfaceEndpoint
public String getMarkupInterfaceEndpoint()(Code)

See Also:   org.apache.wsrp4j.consumer.Producer.getMarkupInterfaceEndpoint



getName
public String getName()(Code)
Get the name of the producer. The name of the producer



getPortletDescription
public PortletDescription getPortletDescription(String portletHandle) throws WSRPException(Code)
Get the portlet description of the portlet with the given handle from the service description or null if the producer doesn't offer an portlet with this handle in it's service description.
Parameters:
  portletHandle - The portlet handle of the portlet The portlet description of the portlet with the given handle



getPortletManagementInterface
public WSRP_v1_PortletManagement_PortType getPortletManagementInterface()(Code)



getPortletManagementInterfaceEndpoint
public String getPortletManagementInterfaceEndpoint()(Code)

See Also:   org.apache.wsrp4j.consumer.Producer.getPortletManagementInterfaceEndpoint



getRegistrationContext
public RegistrationContext getRegistrationContext()(Code)
Get the current registration context of the consumer registered at this producer or null if no registration is required or happend so far. The current registration context of the consumer at this producer or null.



getRegistrationData
public RegistrationData getRegistrationData()(Code)
Get the registration data the consumer uses to register at this producer. The consumer registration data



getRegistrationInterface
public WSRP_v1_Registration_PortType getRegistrationInterface()(Code)



getRegistrationInterfaceEndpoint
public String getRegistrationInterfaceEndpoint()(Code)
Get the URL of the producers registration interface. URL of the registration interface.



getServiceDescription
public ServiceDescription getServiceDescription() throws WSRPException(Code)
Same as getServiceDescription(false)



getServiceDescription
public ServiceDescription getServiceDescription(boolean newRequest) throws WSRPException(Code)
Get the service description of the producer
Parameters:
  newRequest - If set to true a new request is send to the producer otherwise a cached service descriptionis used if available Service description of the producer



getServiceDescriptionInterface
public WSRP_v1_ServiceDescription_PortType getServiceDescriptionInterface()(Code)



getServiceDescriptionInterfaceEndpoint
public String getServiceDescriptionInterfaceEndpoint()(Code)
Get the URL of the producers service description interface. URL of the service description interface.



initPortletManagementInterface
public void initPortletManagementInterface(String portletManagementURL) throws WSRPException(Code)



initRegistrationInterface
public void initRegistrationInterface(String registrationURL) throws WSRPException(Code)
Initialize the registration interface of the producer.
Parameters:
  registrationURL - The URL of the producers registration interface



initServiceDescInterface
public void initServiceDescInterface(String serviceDescriptionURL) throws WSRPException(Code)
Initialize the service description interface of the producer.
Parameters:
  serviceDescriptionURL - The URL of the producers service description interface



isPortletManagementInferfaceSupported
public boolean isPortletManagementInferfaceSupported()(Code)



isRegistrationInterfaceSupported
public boolean isRegistrationInterfaceSupported()(Code)



isRegistrationRequired
public boolean isRegistrationRequired()(Code)
Indicates wether or not the producer requires consumer registration. True if consumer registration is required.



modifyRegistration
public RegistrationState modifyRegistration(RegistrationData registrationData) throws WSRPException(Code)
Can be used to modify the relationship between consumer and producer. Note: A additional call of setRegistrationContext() is not neccesary
Parameters:
  registrationData - The new registration data New registration context



register
public RegistrationContext register(RegistrationData registrationData) throws WSRPException(Code)
Method establishes a relationship between consumer and producer. Note: A additional call of setRegistrationContext() is not neccesary
Parameters:
  registrationData - Data which is used to register the consumer The registration context received by the producer



setDescription
public void setDescription(String description)(Code)
Set a description of the producer.
Parameters:
  description - Some descriptive information about the producer



setID
public void setID(String id)(Code)
Set the ID of the producer to he given value.
Parameters:
  id - ID of the producer.



setIsRegistrationRequired
public void setIsRegistrationRequired(boolean registrationRequired)(Code)
Define if the producer requires in-band registration or not.
Parameters:
  registrationRequired - True if the producer requires in-band registration



setMarkupInterfaceEndpoint
public void setMarkupInterfaceEndpoint(String url)(Code)

See Also:   org.apache.wsrp4j.consumer.Producer.setMarkupInterfaceEndpoint(java.lang.String)



setName
public void setName(String name)(Code)
Set the name of the producer.
Parameters:
  name - The name of the producer



setPortletManagementInterfaceEndpoint
public void setPortletManagementInterfaceEndpoint(String url)(Code)

See Also:   org.apache.wsrp4j.consumer.Producer.setPortletManagementInterfaceEndpoint(java.lang.String)



setRegistrationContext
public void setRegistrationContext(RegistrationContext registrationContext)(Code)
Set the registration context.
Parameters:
  registrationContext - The registration context of a consumer registered at the producer.



setRegistrationData
public void setRegistrationData(RegistrationData regData)(Code)
Set the registration the consumer uses the register at this producer.
Parameters:
  regData - The registration data which is used to register at this producer



setRegistrationInterfaceEndpoint
public void setRegistrationInterfaceEndpoint(String url)(Code)
Set the URL of the producers registration interface.
Parameters:
  url - URL of the registration interface.



setServiceDescription
public void setServiceDescription(ServiceDescription serviceDescription)(Code)
Set the consumer environment this producer is used.
Parameters:
  consumerEnvironment - The consumer environment of the consumer usingthe producer object.



setServiceDescriptionInterfaceEndpoint
public void setServiceDescriptionInterfaceEndpoint(String url)(Code)
Set the URL of the producers service description interface.
Parameters:
  url - URL of the service description interface.



Methods inherited from org.apache.wsrp4j.util.StateChangedServiceImpl
public void addListener(StateChangedListener changeListener)(Code)(Java Doc)
public void stateChanged()(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.