org.apache.cocoon.portal.wsrp.consumer
Class ProducerDescription

java.lang.Object
  extended byorg.apache.cocoon.portal.wsrp.consumer.ProducerDescription

public class ProducerDescription
extends Object

Describes and creates producers.
If the registration interface url is set (not null) this implies that the producer requires a registration. If the producer does not require a registration, set the registration interface url to null

Version:
$Id: ProducerDescription.java 322475 2005-10-16 14:26:44Z cziegeler $

Field Summary
protected  String description
          description of the producer
protected  String id
          Unique string of the producer
protected  String markupInterfaceUrl
          The wsrp makup-interface-url (required)
protected  String name
          name of the producer
protected  String portletManagementInterfaceUrl
          The wsrp portlet-management-interface-url (optional)
protected  oasis.names.tc.wsrp.v1.types.RegistrationData registrationData
          The registration data.
protected  String registrationInterfaceUrl
          The wsrp registration-interface-url (optional)
protected  String serviceDescriptionInterfaceUrl
          The wsrp service-description-interface-url (required)
 
Constructor Summary
ProducerDescription()
          Default constructor
ProducerDescription(String id)
          Constructor
ProducerDescription(String id, String markupUrl, String sdUrl)
          Constructor
ProducerDescription(String id, String markupUrl, String sdUrl, String regUrl, String pmUrl)
          Constructor
 
Method Summary
static oasis.names.tc.wsrp.v1.types.RegistrationData createRegistrationData(Configuration config, org.apache.wsrp4j.consumer.ConsumerEnvironment env)
           
static ProducerDescription fromConfiguration(Configuration config, org.apache.wsrp4j.consumer.ConsumerEnvironment env)
          Create a producer description from a configuration
 String getDescription()
           
 String getId()
           
 String getMarkupInterfaceUrl()
           
 String getName()
           
 String getPortletManagementInterfaceUrl()
           
 oasis.names.tc.wsrp.v1.types.RegistrationData getRegistrationData()
           
 String getRegistrationInterfaceUrl()
           
 String getServiceDescriptionInterfaceUrl()
           
 void setDescription(String description)
          Set the producer-description
 void setId(String id)
          set the producer-id
 void setMarkupInterfaceUrl(String markupInterfaceUrl)
          set the markup-interface-url
 void setName(String name)
          Set the producer-name
 void setPortletManagementInterfaceUrl(String portletManagementInterfaceUrl)
          Set the portlet-management-interface-url
 void setRegistrationData(oasis.names.tc.wsrp.v1.types.RegistrationData registrationData)
           
 void setRegistrationInterfaceUrl(String registrationInterfaceUrl)
          Set the registration-interface-url
 void setServiceDescriptionInterfaceUrl(String serviceDescriptionInterfaceUrl)
          Set the service-description-interface-url
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

id

protected String id
Unique string of the producer


markupInterfaceUrl

protected String markupInterfaceUrl
The wsrp makup-interface-url (required)


serviceDescriptionInterfaceUrl

protected String serviceDescriptionInterfaceUrl
The wsrp service-description-interface-url (required)


registrationInterfaceUrl

protected String registrationInterfaceUrl
The wsrp registration-interface-url (optional)


portletManagementInterfaceUrl

protected String portletManagementInterfaceUrl
The wsrp portlet-management-interface-url (optional)


name

protected String name
name of the producer


description

protected String description
description of the producer


registrationData

protected oasis.names.tc.wsrp.v1.types.RegistrationData registrationData
The registration data.

Constructor Detail

ProducerDescription

public ProducerDescription()
Default constructor


ProducerDescription

public ProducerDescription(String id)
Constructor

Parameters:
id - of the producer

ProducerDescription

public ProducerDescription(String id,
                           String markupUrl,
                           String sdUrl)
Constructor

Parameters:
id - of the producer
markupUrl - markup-interface-url
sdUrl - service-description-interface-url

ProducerDescription

public ProducerDescription(String id,
                           String markupUrl,
                           String sdUrl,
                           String regUrl,
                           String pmUrl)
Constructor

Parameters:
id - of the producer
markupUrl - markup-interface-url
sdUrl - service-description-interface-url
regUrl - registration-interface-url
pmUrl - portlet-management-interface-url
Method Detail

getId

public String getId()
Returns:
producer-id

setId

public void setId(String id)
set the producer-id

Parameters:
id -

getMarkupInterfaceUrl

public String getMarkupInterfaceUrl()
Returns:
markup-interface-url

setMarkupInterfaceUrl

public void setMarkupInterfaceUrl(String markupInterfaceUrl)
set the markup-interface-url

Parameters:
markupInterfaceUrl -

getPortletManagementInterfaceUrl

public String getPortletManagementInterfaceUrl()
Returns:
portlet-management-interface-url

setPortletManagementInterfaceUrl

public void setPortletManagementInterfaceUrl(String portletManagementInterfaceUrl)
Set the portlet-management-interface-url

Parameters:
portletManagementInterfaceUrl -

getRegistrationInterfaceUrl

public String getRegistrationInterfaceUrl()
Returns:
registration-interface-url

setRegistrationInterfaceUrl

public void setRegistrationInterfaceUrl(String registrationInterfaceUrl)
Set the registration-interface-url

Parameters:
registrationInterfaceUrl -

getServiceDescriptionInterfaceUrl

public String getServiceDescriptionInterfaceUrl()
Returns:
service-description-interface-url

setServiceDescriptionInterfaceUrl

public void setServiceDescriptionInterfaceUrl(String serviceDescriptionInterfaceUrl)
Set the service-description-interface-url

Parameters:
serviceDescriptionInterfaceUrl -

fromConfiguration

public static ProducerDescription fromConfiguration(Configuration config,
                                                    org.apache.wsrp4j.consumer.ConsumerEnvironment env)
                                             throws ConfigurationException
Create a producer description from a configuration

Parameters:
config -
Returns:
the producer-description
Throws:
ConfigurationException

createRegistrationData

public static oasis.names.tc.wsrp.v1.types.RegistrationData createRegistrationData(Configuration config,
                                                                                   org.apache.wsrp4j.consumer.ConsumerEnvironment env)

getDescription

public String getDescription()
Returns:
the producer-description as string

setDescription

public void setDescription(String description)
Set the producer-description

Parameters:
description -

getName

public String getName()
Returns:
name of the producer

setName

public void setName(String name)
Set the producer-name

Parameters:
name -

getRegistrationData

public oasis.names.tc.wsrp.v1.types.RegistrationData getRegistrationData()

setRegistrationData

public void setRegistrationData(oasis.names.tc.wsrp.v1.types.RegistrationData registrationData)


Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.