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

WSRPConsumer - JBOSS Portal 2.6 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
Interface WSRPConsumer

All Superinterfaces:

PortletInvoker, org.jboss.system.Service

All Known Implementing Classes:

WSRPConsumerImpl

---

public interface WSRPConsumer

extends PortletInvoker, org.jboss.system.Service

Since:

2.4

Version:

$Revision: 5440 $

Author:

Boleslaw Dawidowicz, Chris Laprun

---

Method Summary
java.lang.Integer	getExpirationCacheSeconds()           Retrieves the cache expiration duration (in seconds) for cached values.
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.
RegistrationData	getRegistrationData()           Retrieves the registration data used to register this consumer with the associated producer
ServiceFactory	getServiceFactory()           Retrieves the ServiceFactory this Consumer will use to access the associated Producer's services.
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	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.

 

Methods inherited from interface org.jboss.portal.portlet.PortletInvoker

createClone, destroyClones, getPortlet, getPortlets, getProperties, getProperties, invoke, setProperties

 

Methods inherited from interface org.jboss.system.Service

create, destroy, start, stop

 

Method Detail

setProducerId

public void setProducerId(java.lang.String id)

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

Parameters:

id - the identifier of the associated producer

---

getProducerId

public java.lang.String getProducerId()

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

Returns:

the identifier of the associated producer

---

setServiceFactory

public void setServiceFactory(ServiceFactory serviceFactory)

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

Parameters:

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

---

getServiceFactory

public ServiceFactory getServiceFactory()

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

Returns:

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

---

setExpirationCacheSeconds

public void setExpirationCacheSeconds(java.lang.Integer expirationCacheSeconds)

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

Parameters:

expirationCacheSeconds - the cache expiration duration (in seconds)

---

getExpirationCacheSeconds

public java.lang.Integer getExpirationCacheSeconds()

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

Returns:

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

---

setRegistrationData

public void setRegistrationData(RegistrationData registrationData)

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

Parameters:

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

---

getRegistrationData

public RegistrationData getRegistrationData()

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

Returns:

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

---

getProducerSessionInformationFrom

public ProducerSessionInformation getProducerSessionInformationFrom(PortletInvocation invocation)

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

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)

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

Parameters:

session - the session from the information should be extracted.

Returns:

the session information for the producer associated with this consumer.

See Also:

ProducerSessionInformation

---

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

---