|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IProducerDataStore
Interface for a consumer registration and portlet instance store. The portal framework does not synchronize calls to the SPI. Depending on the datastore used to manage instances and preferences, the SPI must synchronize the implementation.
Implementations MUST have a no-argument constructor. Only a single instance will be created per producer (per webapp). Implementations are responsible ONLY for consumer-cloned portlet (CCP) instances; producer-offered portlet (POP) instances are handled by the producer.
Method Summary | |
---|---|
IPortletDataContext |
createPortletInstance(String popHandle,
IConfigurationContext configContext,
IRequestContext requestContext)
Creates a child instance of a POP portlet. |
void |
deletePortletInstance(IPortletDataContext portletDataContext,
IConfigurationContext configContext,
IRequestContext requestContext)
Deletes a portlet instance, and all descendent portlet instances if applicable. |
void |
deregister(IRegistrationDataContext registrationContext,
IConfigurationContext configContext,
IRequestContext requestContext)
De-registers the consumer from this producer. |
void |
destroy()
Destroys this IProducerDataStore instance. |
IPortletDataContext |
getPortletInstance(String handle,
byte[] state,
IPortletDataContext.StateChangeFlag stateChange,
IConfigurationContext configContext,
IRequestContext requestContext)
Gets the portlet instance referred to by the specified portlet handle and portlet state. |
IRegistrationDataContext |
getRegistrationDataContext(String registrationHandle,
byte[] registrationState,
IConfigurationContext configContext,
IRequestContext requestContext)
Gets the IRegistrationDataContext object for the specified consumer registration, or throws an exception if the consumer registration is invalid. |
Set<IPropertyDescription> |
getRegistrationPropertyDescriptions(IRequestContext requestContext)
Gets the set of registration property descriptions for all supported registration properties. |
void |
init(Map<String,String[]> initParams,
IConfigurationContext configContext)
Initializes this IProducerDataStore instance with the specified initialization parameters. |
IRegistrationDataContext |
register(IRegistrationData registrationData,
IConfigurationContext configContext,
IRequestContext requestContext)
Registers a consumer with the producer. |
Method Detail |
---|
void init(Map<String,String[]> initParams, IConfigurationContext configContext) throws Exception
Exception
void destroy()
IRegistrationDataContext register(IRegistrationData registrationData, IConfigurationContext configContext, IRequestContext requestContext) throws WSRPFaultException
null
when this method is called.
WSRPFaultException
- if the operation failed for any reason. The exception
can be created using the IConfigurationContext.createWsrpFaultException() method.IRegistrationDataContext getRegistrationDataContext(String registrationHandle, byte[] registrationState, IConfigurationContext configContext, IRequestContext requestContext) throws WSRPFaultException
null
when this method is called.
WSRPFaultException
- if the operation failed for any reason. The exception
can be created using the IConfigurationContext.createWsrpFaultException() method.void deregister(IRegistrationDataContext registrationContext, IConfigurationContext configContext, IRequestContext requestContext) throws WSRPFaultException
WSRPFaultException
- if the operation failed for any reason. The exception
can be created using the IConfigurationContext.createWsrpFaultException() method.Set<IPropertyDescription> getRegistrationPropertyDescriptions(IRequestContext requestContext) throws WSRPFaultException
null
but may be empty if no
registration properties are supported.
WSRPFaultException
- if the operation failed for any reason. The exception
can be created using the IConfigurationContext.createWsrpFaultException() method.IPortletDataContext createPortletInstance(String popHandle, IConfigurationContext configContext, IRequestContext requestContext) throws WSRPFaultException
popHandle
- the portlet POP handle to make a new portlet instance from.configContext
- requestContext
-
WSRPFaultException
- if the operation failed for any reason. The exception
can be created using the IConfigurationContext.createWsrpFaultException() method.IPortletDataContext getPortletInstance(String handle, byte[] state, IPortletDataContext.StateChangeFlag stateChange, IConfigurationContext configContext, IRequestContext requestContext) throws WSRPFaultException
handle
- the portlet instance handle.state
- the portlet instance binary state buffer, if any.stateChange
- the state change flag the consumer sent to indicate
whether the portlet is clonable and whether or not an implicit
clone should occur when setting preferences.
WSRPFaultException
- if the operation failed for any reason. The exception
can be created using the IConfigurationContext.createWsrpFaultException() method.void deletePortletInstance(IPortletDataContext portletDataContext, IConfigurationContext configContext, IRequestContext requestContext) throws WSRPFaultException
portletDataContext
- configContext
- requestContext
-
WSRPFaultException
- if the operation failed for any reason. The exception
can be created using the IConfigurationContext.createWsrpFaultException() method.
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |