|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.wsrp4j.util.StateChangedServiceImpl
org.apache.wsrp4j.consumer.driver.ProducerImpl
public class ProducerImpl
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.
Producer| Constructor Summary | |
|---|---|
ProducerImpl()
Default Constructor should not be used directly. |
|
ProducerImpl(java.lang.String producerID,
java.lang.String markupURL,
java.lang.String serviceDescriptionURL)
This constructor can be used to create a new producer object |
|
ProducerImpl(java.lang.String producerID,
java.lang.String markupURL,
java.lang.String serviceDescriptionURL,
java.lang.String registrationURL,
java.lang.String portletManagementURL,
RegistrationData registrationData)
This constructor can be used to create a new producer object |
|
| 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 from the service description or null if the producer doesn't offer an portlet with this handle in it's service description. |
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. |
void |
initPortletManagementInterface(java.lang.String portletManagementURL)
|
void |
initRegistrationInterface(java.lang.String registrationURL)
Initialize the registration interface of the producer. |
void |
initServiceDescInterface(java.lang.String serviceDescriptionURL)
Initialize the service description interface of the producer. |
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 |
setServiceDescription(ServiceDescription serviceDescription)
Set the consumer environment this producer is used. |
void |
setServiceDescriptionInterfaceEndpoint(java.lang.String url)
Set the URL of the producers service description interface. |
| Methods inherited from class org.apache.wsrp4j.util.StateChangedServiceImpl |
|---|
addListener, stateChanged |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ProducerImpl()
public ProducerImpl(java.lang.String producerID,
java.lang.String markupURL,
java.lang.String serviceDescriptionURL)
throws WSRPException
WSRPException
public ProducerImpl(java.lang.String producerID,
java.lang.String markupURL,
java.lang.String serviceDescriptionURL,
java.lang.String registrationURL,
java.lang.String portletManagementURL,
RegistrationData registrationData)
throws WSRPException
WSRPException| Method Detail |
|---|
public void initServiceDescInterface(java.lang.String serviceDescriptionURL)
throws WSRPException
serviceDescriptionURL - The URL of the producers service description interface
WSRPException
public void initRegistrationInterface(java.lang.String registrationURL)
throws WSRPException
registrationURL - The URL of the producers registration interface
WSRPExceptionpublic java.lang.String getServiceDescriptionInterfaceEndpoint()
getServiceDescriptionInterfaceEndpoint in interface Producerpublic void setServiceDescriptionInterfaceEndpoint(java.lang.String url)
setServiceDescriptionInterfaceEndpoint in interface Producerurl - URL of the service description interface.public java.lang.String getRegistrationInterfaceEndpoint()
getRegistrationInterfaceEndpoint in interface Producerpublic void setRegistrationInterfaceEndpoint(java.lang.String url)
setRegistrationInterfaceEndpoint in interface Producerurl - URL of the registration interface.public java.lang.String getID()
getID in interface Producerpublic void setID(java.lang.String id)
setID in interface Producerid - ID of the producer.public java.lang.String getName()
getName in interface Producerpublic void setName(java.lang.String name)
setName in interface Producername - The name of the producerpublic java.lang.String getDescription()
getDescription in interface Producerpublic void setDescription(java.lang.String description)
setDescription in interface Producerdescription - Some descriptive information about the producerpublic boolean isRegistrationRequired()
isRegistrationRequired in interface Producerpublic void setIsRegistrationRequired(boolean registrationRequired)
setIsRegistrationRequired in interface ProducerregistrationRequired - True if the producer requires in-band registrationpublic RegistrationData getRegistrationData()
getRegistrationData in interface Producerpublic void setRegistrationData(RegistrationData regData)
setRegistrationData in interface ProducerregData - The registration data which is used to register at this producerpublic RegistrationContext getRegistrationContext()
getRegistrationContext in interface Producerpublic void setRegistrationContext(RegistrationContext registrationContext)
setRegistrationContext in interface ProducerregistrationContext - The registration context of a consumer registered at the producer.
public ServiceDescription getServiceDescription()
throws WSRPException
getServiceDescription in interface ProducerWSRPException
public ServiceDescription getServiceDescription(boolean newRequest)
throws WSRPException
getServiceDescription in interface ProducernewRequest - If set to true a new request is send to the producer otherwise a cached service description
is used if available
WSRPException
public PortletDescription getPortletDescription(java.lang.String portletHandle)
throws WSRPException
getPortletDescription in interface ProducerportletHandle - The portlet handle of the portlet
WSRPExceptionpublic void setServiceDescription(ServiceDescription serviceDescription)
consumerEnvironment - The consumer environment of the consumer using
the producer object.public void addPortletDescription(PortletDescription portletDescription)
addPortletDescription in interface ProducerportletDescription - New portlet description
public RegistrationContext register(RegistrationData registrationData)
throws WSRPException
register in interface ProducerregistrationData - Data which is used to register the consumer
WSRPException
public RegistrationState modifyRegistration(RegistrationData registrationData)
throws WSRPException
modifyRegistration in interface ProducerregistrationData - The new registration data
WSRPException
public ReturnAny deregister()
throws WSRPException
deregister in interface ProducerWSRPExceptionpublic java.lang.String getMarkupInterfaceEndpoint()
Producer
getMarkupInterfaceEndpoint in interface ProducerProducer.getMarkupInterfaceEndpoint()public void setMarkupInterfaceEndpoint(java.lang.String url)
Producer
setMarkupInterfaceEndpoint in interface Producerurl - of the markup interface.Producer.setMarkupInterfaceEndpoint(java.lang.String)public java.lang.String getPortletManagementInterfaceEndpoint()
Producer
getPortletManagementInterfaceEndpoint in interface ProducerProducer.getPortletManagementInterfaceEndpoint()public void setPortletManagementInterfaceEndpoint(java.lang.String url)
Producer
setPortletManagementInterfaceEndpoint in interface Producerurl - of the portlet management interface.Producer.setPortletManagementInterfaceEndpoint(java.lang.String)
public void initPortletManagementInterface(java.lang.String portletManagementURL)
throws WSRPException
WSRPExceptionpublic WSRP_v1_PortletManagement_PortType getPortletManagementInterface()
Producer
getPortletManagementInterface in interface Producerpublic WSRP_v1_Registration_PortType getRegistrationInterface()
Producer
getRegistrationInterface in interface Producerpublic WSRP_v1_ServiceDescription_PortType getServiceDescriptionInterface()
Producer
getServiceDescriptionInterface in interface Producerpublic boolean isPortletManagementInferfaceSupported()
Producer
isPortletManagementInferfaceSupported in interface Producerpublic boolean isRegistrationInterfaceSupported()
Producer
isRegistrationInterfaceSupported in interface Producer
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||