|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Producer
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.
Method Summary | |
---|---|
void |
addPortletDescription(PortletDescription portletDescription)
Add an portlet description to the producer. |
ReturnAny |
deregister()
End an existing consumer producer relationship and remove the registration context |
java.lang.String |
getDescription()
Get a description of the producer. |
java.lang.String |
getID()
Get the ID of the producer. |
java.lang.String |
getMarkupInterfaceEndpoint()
Get the URL of the producers markup interface. |
java.lang.String |
getName()
Get the name of the producer. |
PortletDescription |
getPortletDescription(java.lang.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. |
WSRP_v1_PortletManagement_PortType |
getPortletManagementInterface()
Get the producers portlet management interface. |
java.lang.String |
getPortletManagementInterfaceEndpoint()
Get the URL of the producers portlet management interface. |
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. |
RegistrationData |
getRegistrationData()
Get the registration data the consumer uses to register at this producer. |
WSRP_v1_Registration_PortType |
getRegistrationInterface()
Get the producers registration interface. |
java.lang.String |
getRegistrationInterfaceEndpoint()
Get the URL of the producers registration interface. |
ServiceDescription |
getServiceDescription()
Same as getServiceDescription(false) |
ServiceDescription |
getServiceDescription(boolean newRequest)
Get the service description of the producer |
WSRP_v1_ServiceDescription_PortType |
getServiceDescriptionInterface()
Get the producers service description interface. |
java.lang.String |
getServiceDescriptionInterfaceEndpoint()
Get the URL of the producers service description interface. |
boolean |
isPortletManagementInferfaceSupported()
Check wether the optional portlet management interface is supported |
boolean |
isRegistrationInterfaceSupported()
Check wether the optional registration interface is supported |
boolean |
isRegistrationRequired()
Indicates wether or not the producer requires consumer registration. |
RegistrationState |
modifyRegistration(RegistrationData registrationData)
Can be used to modify the relationship between consumer and producer. |
RegistrationContext |
register(RegistrationData registrationData)
Method establishes a relationship between consumer and producer. |
void |
setDescription(java.lang.String description)
Set a description of the producer. |
void |
setID(java.lang.String id)
Set the ID of the producer to he given value. |
void |
setIsRegistrationRequired(boolean registrationRequired)
Define if the producer requires in-band registration or not. |
void |
setMarkupInterfaceEndpoint(java.lang.String url)
Set the URL of the producers markup interface. |
void |
setName(java.lang.String name)
Set the name of the producer. |
void |
setPortletManagementInterfaceEndpoint(java.lang.String url)
Set the URL of the producers portlet management interface. |
void |
setRegistrationContext(RegistrationContext registrationContext)
Set the registration context. |
void |
setRegistrationData(RegistrationData regData)
Set the registration the consumer uses the register at this producer. |
void |
setRegistrationInterfaceEndpoint(java.lang.String url)
Set the URL of the producers registration interface. |
void |
setServiceDescriptionInterfaceEndpoint(java.lang.String url)
Set the URL of the producers service description interface. |
Method Detail |
---|
java.lang.String getName()
void setName(java.lang.String name)
name
- The name of the producerjava.lang.String getID()
void setID(java.lang.String id)
id
- ID of the producer.java.lang.String getDescription()
void setDescription(java.lang.String description)
description
- Some descriptive information about the producerjava.lang.String getServiceDescriptionInterfaceEndpoint()
void setServiceDescriptionInterfaceEndpoint(java.lang.String url)
url
- of the service description interface.WSRP_v1_ServiceDescription_PortType getServiceDescriptionInterface()
java.lang.String getMarkupInterfaceEndpoint()
void setMarkupInterfaceEndpoint(java.lang.String url)
url
- of the markup interface.java.lang.String getPortletManagementInterfaceEndpoint()
void setPortletManagementInterfaceEndpoint(java.lang.String url)
url
- of the portlet management interface.WSRP_v1_PortletManagement_PortType getPortletManagementInterface()
java.lang.String getRegistrationInterfaceEndpoint()
void setRegistrationInterfaceEndpoint(java.lang.String url)
url
- of the registration interface.WSRP_v1_Registration_PortType getRegistrationInterface()
boolean isRegistrationRequired()
void setIsRegistrationRequired(boolean registrationRequired)
registrationRequired
- True if the producer requires in-band registrationRegistrationData getRegistrationData()
void setRegistrationData(RegistrationData regData)
regData
- The registration data which is used to register at this producerServiceDescription getServiceDescription(boolean newRequest) throws WSRPException
newRequest
- If set to true a new request is send to the producer otherwise a cached service description
is used if available
WSRPException
ServiceDescription getServiceDescription() throws WSRPException
WSRPException
PortletDescription getPortletDescription(java.lang.String portletHandle) throws WSRPException
portletHandle
- The portlet handle of the portlet
WSRPException
void addPortletDescription(PortletDescription portletDescription)
portletDescription
- New portlet descriptionRegistrationContext getRegistrationContext()
void setRegistrationContext(RegistrationContext registrationContext)
registrationContext
- The registration context of a consumer registered at the producer.RegistrationContext register(RegistrationData registrationData) throws WSRPException
registrationData
- Data which is used to register the consumer
WSRPException
RegistrationState modifyRegistration(RegistrationData registrationData) throws WSRPException
registrationData
- The new registration data
WSRPException
ReturnAny deregister() throws WSRPException
WSRPException
boolean isRegistrationInterfaceSupported()
boolean isPortletManagementInferfaceSupported()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |