当前页面: 在线文档首页 > JBOSS Portal 2.4 API 英文版文档

WSRPConsumerImpl - JBOSS Portal 2.4 API 英文版文档

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.jboss.portal.wsrp.consumer
Class WSRPConsumerImpl

java.lang.Object
  org.jboss.mx.util.JBossNotificationBroadcasterSupport
      org.jboss.system.ServiceMBeanSupport
          org.jboss.portal.common.system.AbstractJBossService
              org.jboss.portal.wsrp.consumer.WSRPConsumerImpl

All Implemented Interfaces:

javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, PortletInvoker, org.jboss.system.Service, org.jboss.system.ServiceMBean, WSRPConsumer

---

public class WSRPConsumerImpl

extends AbstractJBossService

implements WSRPConsumer

Since:

2.4

---

Field Summary

 

Fields inherited from class org.jboss.system.ServiceMBeanSupport

log, server, SERVICE_CONTROLLER_SIG, serviceName

 

Fields inherited from interface org.jboss.system.ServiceMBean

CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED

 

Constructor Summary

WSRPConsumerImpl()

 

Method Summary
java.lang.String	createClone(java.lang.String portletId)           Clone a portlet.
void	destroyClone(java.lang.String portletId)           Destroy a cloned portlet.
java.lang.Integer	getExpirationCacheSeconds()           Retrieves the cache expiration duration (in seconds) for cached values.
WSRP_v1_Markup_PortType	getMarkupService()
Portlet	getPortlet(java.lang.String portletId)           Get information about a specific portlet.
java.util.Map	getPortletGroupMap()
WSRP_v1_PortletManagement_PortType	getPortletManagementService()
java.util.Set	getPortlets()           Return the set of portlet exposed.
java.lang.String	getProducerId()           Retrieves the identifier for the producer this consumer is associated with.
ProducerSessionInformation	getProducerSessionInformationFrom(javax.servlet.http.HttpSession session)           Retrieves the session information for the producer associated with this consumer.
ProducerSessionInformation	getProducerSessionInformationFrom(PortletInvocation invocation)           Retrieves the session information for the producer associated with this consumer.
ValueMap	getProperties(java.lang.String portletId)           Return the properties of the specified portlet.
RegistrationData	getRegistrationData()           Retrieves the registration data used to register this consumer with the associated producer
WSRP_v1_Registration_PortType	getRegistrationService()
ServiceDescription	getServiceDescriptionAndRegisterIfNeeded()
WSRP_v1_ServiceDescription_PortType	getServiceDescriptionService()
ServiceFactory	getServiceFactory()           Retrieves the ServiceFactory this Consumer will use to access the associated Producer's services.
SessionHandler	getSessionHandler()
java.util.Set	getSupportedUserScopes()
void	invoke(PortletInvocation invocation)           Invoke an operation on a specific portlet.
void	setExpirationCacheSeconds(java.lang.Integer expirationCacheSeconds)           Sets the cache expiration duration (in seconds) for cached values.
void	setProducerId(java.lang.String id)           Sets the identifier for the producer this consumer is associated with.
void	setProperties(java.lang.String portletId, ValueMap properties)           Set the properties on the specified portlet.
void	setRegistrationData(RegistrationData registrationData)           Sets the registration data used to register this consumer with the associated producer
void	setServiceFactory(ServiceFactory serviceFactory)           Sets the ServiceFactory this Consumer will use to access the associated Producer's services.
protected  void	startService()
boolean	supportsUserScope(java.lang.String userScope)           Determines whether the specified user scope (for markup caching) is supported.

 

Methods inherited from class org.jboss.portal.common.system.AbstractJBossService

create, destroy, getState, getStateString, start, stop

 

Methods inherited from class org.jboss.system.ServiceMBeanSupport

createService, destroyService, getDeploymentInfo, getLog, getName, getNextNotificationSequenceNumber, getObjectName, getServer, getServiceName, jbossInternalCreate, jbossInternalDescription, jbossInternalDestroy, jbossInternalLifecycle, jbossInternalStart, jbossInternalStop, postDeregister, postRegister, preDeregister, preRegister, stopService

 

Methods inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport

addNotificationListener, getNotificationInfo, handleNotification, nextNotificationSequenceNumber, removeNotificationListener, removeNotificationListener, sendNotification

 

Methods inherited from class java.lang.Object

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

 

Methods inherited from interface org.jboss.system.Service

create, destroy, start, stop

 

Constructor Detail

WSRPConsumerImpl

public WSRPConsumerImpl()

Method Detail

getPortlets

public java.util.Set getPortlets()
                          throws InvokerUnavailableException

Description copied from interface: PortletInvoker

Return the set of portlet exposed.

Specified by:

getPortlets in interface PortletInvoker

Returns:

the set of exposed portlets

Throws:

InvokerUnavailableException

---

getPortlet

public Portlet getPortlet(java.lang.String portletId)
                   throws PortletInvokerException

Description copied from interface: PortletInvoker

Get information about a specific portlet.

Specified by:

getPortlet in interface PortletInvoker

Parameters:

portletId - the portlet identifier in the context of this invoker

Returns:

the PortletInfo for the specified portlet

Throws:

PortletInvokerException

---

invoke

public void invoke(PortletInvocation invocation)
            throws PortletInvokerException

Description copied from interface: PortletInvoker

Invoke an operation on a specific portlet.

Specified by:

invoke in interface PortletInvoker

Parameters:

invocation - the portlet invocation

Throws:

PortletInvokerException

---

createClone

public java.lang.String createClone(java.lang.String portletId)

Description copied from interface: PortletInvoker

Clone a portlet.

Specified by:

createClone in interface PortletInvoker

Returns:

the clone id

---

destroyClone

public void destroyClone(java.lang.String portletId)

Description copied from interface: PortletInvoker

Destroy a cloned portlet.

Specified by:

destroyClone in interface PortletInvoker

Parameters:

portletId - the clone id

---

getProperties

public ValueMap getProperties(java.lang.String portletId)

Description copied from interface: PortletInvoker

Return the properties of the specified portlet.

Specified by:

getProperties in interface PortletInvoker

Parameters:

portletId - the portlet id

Returns:

the properties

---

setProperties

public void setProperties(java.lang.String portletId,
                          ValueMap properties)

Description copied from interface: PortletInvoker

Set the properties on the specified portlet.

Specified by:

setProperties in interface PortletInvoker

Parameters:

portletId - the portlet id

properties - the new properties

---

setProducerId

public void setProducerId(java.lang.String id)

Description copied from interface: WSRPConsumer

Sets the identifier for the producer this consumer is associated with.

Specified by:

setProducerId in interface WSRPConsumer

Parameters:

id - the identifier of the associated producer

---

getProducerId

public java.lang.String getProducerId()

Description copied from interface: WSRPConsumer

Retrieves the identifier for the producer this consumer is associated with.

Specified by:

getProducerId in interface WSRPConsumer

Returns:

the identifier of the associated producer

---

getSessionHandler

public SessionHandler getSessionHandler()

---

getPortletGroupMap

public java.util.Map getPortletGroupMap()
                                 throws ServiceDescriptionUnavailableException

Throws:

ServiceDescriptionUnavailableException

---

getExpirationCacheSeconds

public java.lang.Integer getExpirationCacheSeconds()

Description copied from interface: WSRPConsumer

Retrieves the cache expiration duration (in seconds) for cached values.

Specified by:

getExpirationCacheSeconds in interface WSRPConsumer

Returns:

Sets the cache expiration duration (in seconds) for cached values.

---

setExpirationCacheSeconds

public void setExpirationCacheSeconds(java.lang.Integer expirationCacheSeconds)

Description copied from interface: WSRPConsumer

Sets the cache expiration duration (in seconds) for cached values.

Specified by:

setExpirationCacheSeconds in interface WSRPConsumer

Parameters:

expirationCacheSeconds - the cache expiration duration (in seconds)

---

getSupportedUserScopes

public java.util.Set getSupportedUserScopes()

---

supportsUserScope

public boolean supportsUserScope(java.lang.String userScope)

Determines whether the specified user scope (for markup caching) is supported.

Parameters:

userScope - the user scope which support is to be determined

Returns:

true if the given user scope is supported, false otherwise

---

setRegistrationData

public void setRegistrationData(RegistrationData registrationData)

Description copied from interface: WSRPConsumer

Sets the registration data used to register this consumer with the associated producer

Specified by:

setRegistrationData in interface WSRPConsumer

Parameters:

registrationData - the registration data used to register this consumer with the associated producer

---

getRegistrationData

public RegistrationData getRegistrationData()

Description copied from interface: WSRPConsumer

Retrieves the registration data used to register this consumer with the associated producer

Specified by:

getRegistrationData in interface WSRPConsumer

Returns:

the registration data used to register this consumer with the associated producer

---

getProducerSessionInformationFrom

public ProducerSessionInformation getProducerSessionInformationFrom(PortletInvocation invocation)

Description copied from interface: WSRPConsumer

Retrieves the session information for the producer associated with this consumer.

Specified by:

getProducerSessionInformationFrom in interface WSRPConsumer

Parameters:

invocation - a portlet invocation from which the session information should be extracted.

Returns:

the session information for the producer associated with this consumer.

See Also:

ProducerSessionInformation

---

getProducerSessionInformationFrom

public ProducerSessionInformation getProducerSessionInformationFrom(javax.servlet.http.HttpSession session)

Description copied from interface: WSRPConsumer

Retrieves the session information for the producer associated with this consumer.

Specified by:

getProducerSessionInformationFrom in interface WSRPConsumer

Parameters:

session - the session from the information should be extracted.

Returns:

the session information for the producer associated with this consumer.

See Also:

ProducerSessionInformation

---

startService

protected void startService()
                     throws java.lang.Exception

Throws:

java.lang.Exception

---

getServiceFactory

public ServiceFactory getServiceFactory()

Description copied from interface: WSRPConsumer

Retrieves the ServiceFactory this Consumer will use to access the associated Producer's services.

Specified by:

getServiceFactory in interface WSRPConsumer

Returns:

the ServiceFactory this Consumer will use to access the associated Producer's services.

---

setServiceFactory

public void setServiceFactory(ServiceFactory serviceFactory)

Description copied from interface: WSRPConsumer

Sets the ServiceFactory this Consumer will use to access the associated Producer's services.

Specified by:

setServiceFactory in interface WSRPConsumer

Parameters:

serviceFactory - the ServiceFactory this Consumer will use to access the associated Producer's services.

---

getServiceDescriptionService

public WSRP_v1_ServiceDescription_PortType getServiceDescriptionService()
                                                                 throws InvokerUnavailableException

Throws:

InvokerUnavailableException

---

getMarkupService

public WSRP_v1_Markup_PortType getMarkupService()
                                         throws InvokerUnavailableException

Throws:

InvokerUnavailableException

---

getPortletManagementService

public WSRP_v1_PortletManagement_PortType getPortletManagementService()
                                                               throws InvokerUnavailableException

Throws:

InvokerUnavailableException

---

getRegistrationService

public WSRP_v1_Registration_PortType getRegistrationService()
                                                     throws InvokerUnavailableException

Throws:

InvokerUnavailableException

---

getServiceDescriptionAndRegisterIfNeeded

public ServiceDescription getServiceDescriptionAndRegisterIfNeeded()
                                                            throws ServiceDescriptionUnavailableException

Throws:

ServiceDescriptionUnavailableException

---

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---