org.exoplatform.services.wsrp2.consumer.impl
Class ProducerImpl

java.lang.Object
  org.exoplatform.services.wsrp2.consumer.impl.ProducerImpl

All Implemented Interfaces:

Serializable, Producer

public class ProducerImpl
extends Object
implements Producer, Serializable

See Also:

Serialized Form

Constructor Summary

ProducerImpl(org.exoplatform.container.ExoContainer cont)

Method Summary

org.exoplatform.services.wsrp2.type.ReturnAny	deregister(org.exoplatform.services.wsrp2.type.Deregister deregister) End an existing consumer producer relationship and remove the registration context
String	getDescription() Get a description of the producer.
String[]	getDesiredLocales()
String	getID() Get the ID of the producer.
String	getMarkupInterfaceEndpoint() Get the URL of the producers markup interface.
String	getName() Get the name of the producer.
org.exoplatform.services.wsrp2.type.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.
org.exoplatform.services.wsrp2.intf.WSRP_v2_PortletManagement_PortType	getPortletManagementInterface() Get the producers portlet management interface.
String	getPortletManagementInterfaceEndpoint() Get the URL of the producers portlet management interface.
org.exoplatform.services.wsrp2.type.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.
org.exoplatform.services.wsrp2.type.RegistrationData	getRegistrationData() Get the registration data the consumer uses to register at this producer.
org.exoplatform.services.wsrp2.intf.WSRP_v2_Registration_PortType	getRegistrationInterface() Get the producers registration interface.
String	getRegistrationInterfaceEndpoint() Get the URL of the producers registration interface.
org.exoplatform.services.wsrp2.type.ServiceDescription	getServiceDescription() Same as getServiceDescription(false)
org.exoplatform.services.wsrp2.type.ServiceDescription	getServiceDescription(boolean newRequest) Get the service description of the producer
org.exoplatform.services.wsrp2.intf.WSRP_v2_ServiceDescription_PortType	getServiceDescriptionInterface() Get the producers service description interface.
String	getServiceDescriptionInterfaceEndpoint() Get the URL of the producers service description interface.
void	init(org.exoplatform.container.ExoContainer cont)
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.
org.exoplatform.services.wsrp2.type.RegistrationState	modifyRegistration(org.exoplatform.services.wsrp2.type.ModifyRegistration modifyRegistration) Can be used to modify the relationship between consumer and producer.
org.exoplatform.services.wsrp2.type.RegistrationContext	register(org.exoplatform.services.wsrp2.type.Register register) Method establishes a relationship between consumer and producer.
void	setDescription(String description) Set a description of the producer.
void	setDesiredLocales(String[] desiredLocales)
void	setID(String ID) Set the ID of the producer to he given value.
void	setMarkupInterfaceEndpoint(String markupInterfaceEndpoint) Set the URL of the producers markup interface.
void	setName(String name) Set the name of the producer.
void	setPortletManagementInterfaceEndpoint(String portletManagementInterfaceEndpoint) Set the URL of the producers portlet management interface.
void	setRegistrationData(org.exoplatform.services.wsrp2.type.RegistrationData registrationData) Set the registration the consumer uses the register at this producer.
void	setRegistrationInterfaceEndpoint(String registrationInterfaceEndpoint) Set the URL of the producers registration interface.
void	setServiceDescriptionInterfaceEndpoint(String serviceDescriptionInterfaceEndpoint) Set the URL of the producers service description interface.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProducerImpl

public ProducerImpl(org.exoplatform.container.ExoContainer cont)

Method Detail

init

public void init(org.exoplatform.container.ExoContainer cont)

getDesiredLocales

public String[] getDesiredLocales()

Specified by:

getDesiredLocales in interface Producer

setDesiredLocales

public void setDesiredLocales(String[] desiredLocales)

Specified by:

setDesiredLocales in interface Producer

getName

public String getName()

Description copied from interface: Producer

Get the name of the producer.

Specified by:

getName in interface Producer

Returns:

The name of the producer

setName

public void setName(String name)

Description copied from interface: Producer

Set the name of the producer.

Specified by:

setName in interface Producer

Parameters:

name - The name of the producer

getID

public String getID()

Description copied from interface: Producer

Get the ID of the producer.

Specified by:

getID in interface Producer

Returns:

The ID of the producer

setID

public void setID(String ID)

Description copied from interface: Producer

Set the ID of the producer to he given value.

Specified by:

setID in interface Producer

Parameters:

ID - ID of the producer.

getDescription

public String getDescription()

Description copied from interface: Producer

Get a description of the producer.

Specified by:

getDescription in interface Producer

Returns:

A description of the producer

setDescription

public void setDescription(String description)

Description copied from interface: Producer

Set a description of the producer.

Specified by:

setDescription in interface Producer

Parameters:

description - Some descriptive information about the producer

getServiceDescriptionInterfaceEndpoint

public String getServiceDescriptionInterfaceEndpoint()

Description copied from interface: Producer

Get the URL of the producers service description interface.

Specified by:

getServiceDescriptionInterfaceEndpoint in interface Producer

Returns:

URL of the service description interface.

setServiceDescriptionInterfaceEndpoint

public void setServiceDescriptionInterfaceEndpoint(String serviceDescriptionInterfaceEndpoint)

Description copied from interface: Producer

Set the URL of the producers service description interface.

Specified by:

setServiceDescriptionInterfaceEndpoint in interface Producer

Parameters:

serviceDescriptionInterfaceEndpoint - of the service description interface.

getServiceDescriptionInterface

public org.exoplatform.services.wsrp2.intf.WSRP_v2_ServiceDescription_PortType getServiceDescriptionInterface()

Description copied from interface: Producer

Get the producers service description interface.

Specified by:

getServiceDescriptionInterface in interface Producer

Returns:

service description interface.

getServiceDescription

public org.exoplatform.services.wsrp2.type.ServiceDescription getServiceDescription(boolean newRequest)
                                                                             throws WSRPException

Description copied from interface: Producer

Get the service description of the producer

Specified by:

getServiceDescription in interface Producer

Parameters:

newRequest - If set to true a new request is send to the producer otherwise a cached service description is used if available

Returns:

Service description of the producer

Throws:

WSRPException

getServiceDescription

public org.exoplatform.services.wsrp2.type.ServiceDescription getServiceDescription()
                                                                             throws WSRPException

Description copied from interface: Producer

Same as getServiceDescription(false)

Specified by:

getServiceDescription in interface Producer

Throws:

WSRPException

getPortletDescription

public org.exoplatform.services.wsrp2.type.PortletDescription getPortletDescription(String portletHandle)
                                                                             throws WSRPException

Description copied from interface: Producer

Get the portlet description of the portlet with the given handle or null if the producer doesn't know an portlet with this handle.

Specified by:

getPortletDescription in interface Producer

Parameters:

portletHandle - The portlet handle of the portlet

Returns:

The portlet description of the portlet with the given handle

Throws:

WSRPException

getMarkupInterfaceEndpoint

public String getMarkupInterfaceEndpoint()

Description copied from interface: Producer

Get the URL of the producers markup interface.

Specified by:

getMarkupInterfaceEndpoint in interface Producer

Returns:

URL of the markup interface.

setMarkupInterfaceEndpoint

public void setMarkupInterfaceEndpoint(String markupInterfaceEndpoint)

Description copied from interface: Producer

Set the URL of the producers markup interface.

Specified by:

setMarkupInterfaceEndpoint in interface Producer

Parameters:

markupInterfaceEndpoint - of the markup interface.

getPortletManagementInterfaceEndpoint

public String getPortletManagementInterfaceEndpoint()

Description copied from interface: Producer

Get the URL of the producers portlet management interface.

Specified by:

getPortletManagementInterfaceEndpoint in interface Producer

Returns:

URL of the portlet management interface.

setPortletManagementInterfaceEndpoint

public void setPortletManagementInterfaceEndpoint(String portletManagementInterfaceEndpoint)

Description copied from interface: Producer

Set the URL of the producers portlet management interface.

Specified by:

setPortletManagementInterfaceEndpoint in interface Producer

Parameters:

portletManagementInterfaceEndpoint - of the portlet management interface.

getPortletManagementInterface

public org.exoplatform.services.wsrp2.intf.WSRP_v2_PortletManagement_PortType getPortletManagementInterface()

Description copied from interface: Producer

Get the producers portlet management interface.

Specified by:

getPortletManagementInterface in interface Producer

Returns:

portlet management interface.

isPortletManagementInferfaceSupported

public boolean isPortletManagementInferfaceSupported()

Description copied from interface: Producer

Check wether the optional portlet management interface is supported

Specified by:

isPortletManagementInferfaceSupported in interface Producer

Returns:

true if a portlet management interface endpoint URL is set

getRegistrationInterfaceEndpoint

public String getRegistrationInterfaceEndpoint()

Description copied from interface: Producer

Get the URL of the producers registration interface.

Specified by:

getRegistrationInterfaceEndpoint in interface Producer

Returns:

URL of the registration interface.

setRegistrationInterfaceEndpoint

public void setRegistrationInterfaceEndpoint(String registrationInterfaceEndpoint)

Description copied from interface: Producer

Set the URL of the producers registration interface.

Specified by:

setRegistrationInterfaceEndpoint in interface Producer

getRegistrationInterface

public org.exoplatform.services.wsrp2.intf.WSRP_v2_Registration_PortType getRegistrationInterface()

Description copied from interface: Producer

Get the producers registration interface.

Specified by:

getRegistrationInterface in interface Producer

Returns:

registration interface.

isRegistrationRequired

public boolean isRegistrationRequired()

Description copied from interface: Producer

Indicates wether or not the producer requires consumer registration.

Specified by:

isRegistrationRequired in interface Producer

Returns:

True if consumer registration is required.

getRegistrationData

public org.exoplatform.services.wsrp2.type.RegistrationData getRegistrationData()

Description copied from interface: Producer

Get the registration data the consumer uses to register at this producer.

Specified by:

getRegistrationData in interface Producer

Returns:

The consumer registration data

setRegistrationData

public void setRegistrationData(org.exoplatform.services.wsrp2.type.RegistrationData registrationData)

Description copied from interface: Producer

Set the registration the consumer uses the register at this producer.

Specified by:

setRegistrationData in interface Producer

Parameters:

registrationData - The registration data which is used to register at this producer

getRegistrationContext

public org.exoplatform.services.wsrp2.type.RegistrationContext getRegistrationContext()
                                                                               throws WSRPException

Description copied from interface: Producer

Get the current registration context of the consumer registered at this producer or null if no registration is required or happend so far.

Specified by:

getRegistrationContext in interface Producer

Returns:

The current registration context of the consumer at this producer or null.

Throws:

WSRPException

register

public org.exoplatform.services.wsrp2.type.RegistrationContext register(org.exoplatform.services.wsrp2.type.Register register)
                                                                 throws WSRPException

Description copied from interface: Producer

Method establishes a relationship between consumer and producer.

Specified by:

register in interface Producer

Returns:

The registration context received by the producer

Throws:

WSRPException

modifyRegistration

public org.exoplatform.services.wsrp2.type.RegistrationState modifyRegistration(org.exoplatform.services.wsrp2.type.ModifyRegistration modifyRegistration)
                                                                         throws WSRPException

Description copied from interface: Producer

Can be used to modify the relationship between consumer and producer.

Specified by:

modifyRegistration in interface Producer

Returns:

New registration context

Throws:

WSRPException

deregister

public org.exoplatform.services.wsrp2.type.ReturnAny deregister(org.exoplatform.services.wsrp2.type.Deregister deregister)
                                                         throws WSRPException

Description copied from interface: Producer

End an existing consumer producer relationship and remove the registration context

Specified by:

deregister in interface Producer

Returns:

Can be anything

Throws:

WSRPException

isRegistrationInterfaceSupported

public boolean isRegistrationInterfaceSupported()

Description copied from interface: Producer

Check wether the optional registration interface is supported

Specified by:

isRegistrationInterfaceSupported in interface Producer

Returns:

true if a registration interface endpoint URL is set