Java Doc for Producer.java in » Portal » liferay-portal-4.4.2 » org » apache » wsrp4j » consumer » 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

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL 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

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.apache.wsrp4j.consumer .Producer

All known Subclasses:   org.apache.wsrp4j.consumer.driver .ProducerImpl,
Producer
public interface 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 Portlet Management Interface. Whereas the Registration- and Portlet Management Interface are optional.
author:
   Stephan Laertz

Method Summary
public void addPortletDescription(PortletDescription portletDescription)
     Add an portlet description to the producer.
public ReturnAny deregister()

public String getDescription()
     Get a description of the producer.
public String getID()
     Get the ID of the producer.
public String getMarkupInterfaceEndpoint()
     Get the URL of the producers markup interface.
public String getName()
     Get the name of the producer.
public PortletDescription getPortletDescription(String portletHandle)
     Get the portlet description of the portlet with the given handle or null if the producer doesn't know an portlet with this handle.
public WSRP_v1_PortletManagement_PortType getPortletManagementInterface()
     Get the producers portlet management interface.
public String getPortletManagementInterfaceEndpoint()
     Get the URL of the producers portlet management interface.
public RegistrationContext getRegistrationContext()
     Get the current registration context of the consumer registered at this producer or null if no registration is required or happend so far.
public RegistrationData getRegistrationData()
     Get the registration data the consumer uses to register at this producer.
public WSRP_v1_Registration_PortType getRegistrationInterface()
     Get the producers registration interface.
public String getRegistrationInterfaceEndpoint()
     Get the URL of the producers registration interface.
public ServiceDescription getServiceDescription(boolean newRequest)

public ServiceDescription getServiceDescription()

public WSRP_v1_ServiceDescription_PortType getServiceDescriptionInterface()
     Get the producers service description interface.
public String getServiceDescriptionInterfaceEndpoint()
     Get the URL of the producers service description interface.
public boolean isPortletManagementInferfaceSupported()

public boolean isRegistrationInterfaceSupported()

public boolean isRegistrationRequired()
     Indicates wether or not the producer requires consumer registration.
public RegistrationState modifyRegistration(RegistrationData registrationData)
     Can be used to modify the relationship between consumer and producer.
public RegistrationContext register(RegistrationData registrationData)
     Method establishes a relationship between consumer and producer.
public void setDescription(String description)
     Set a description of the producer.
public void setID(String id)
     Set the ID of the producer to he given value.
public void setIsRegistrationRequired(boolean registrationRequired)
     Define if the producer requires in-band registration or not.
public void setMarkupInterfaceEndpoint(String url)
     Set the URL of the producers markup interface.
public void setName(String name)
     Set the name of the producer.
public void setPortletManagementInterfaceEndpoint(String url)
     Set the URL of the producers portlet management interface.
public void setRegistrationContext(RegistrationContext registrationContext)
     Set the registration context.
public void setRegistrationData(RegistrationData regData)
     Set the registration the consumer uses the register at this producer.
public void setRegistrationInterfaceEndpoint(String url)
     Set the URL of the producers registration interface.
public void setServiceDescriptionInterfaceEndpoint(String url)
     Set the URL of the producers service description interface.

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)
Get the URL of the producers markup interface. URL of the markup interface.

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 or null if the producer doesn't know an portlet with this handle.
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)
Get the producers portlet management interface. portlet management interface.

getPortletManagementInterfaceEndpoint
public String getPortletManagementInterfaceEndpoint()(Code)
Get the URL of the producers portlet management interface. URL of the portlet management interface.

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)
Get the producers registration interface. registration interface.

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

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

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

getServiceDescriptionInterface
public WSRP_v1_ServiceDescription_PortType getServiceDescriptionInterface()(Code)
Get the producers service description interface. service description interface.

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

isPortletManagementInferfaceSupported
public boolean isPortletManagementInferfaceSupported()(Code)
Check wether the optional portlet management interface is supported true if a portlet management interface endpoint URL is set

isRegistrationInterfaceSupported
public boolean isRegistrationInterfaceSupported()(Code)
Check wether the optional registration interface is supported true if a registration interface endpoint URL is set

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)
Set the URL of the producers markup interface.
Parameters:
  url - of the markup interface.

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)
Set the URL of the producers portlet management interface.
Parameters:
  url - of the portlet management interface.

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 - of the registration interface.

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

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.