|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PropertyBrokerService
The public interface provided by the Property Broker service.
It provides methods to programmatically activate or deactivate actions for a session and
to determine is a registered property is wired.
The portlet needs to register its properties and actions by declaring them in a WSDL file.
See the WebSphere Portal InfoCenter for the format of the WSDL file.
The PropertyBrokerService
interface is implemented by a PortletService
.
A portlet can obtain the service by using JNDI. This is illustrated in the programming
examples section of the InfoCenter and the property broker standard portlet examples shipped
with WebSphere Portal. A boolean guard may be used to guard uses of the PropertyBrokerService
by the portlet; this will enable the portlet to execute correctly in JSR-168 compliant portlet
containers outside of WebSphere Portal.
A snippet of the JNDI lookup code:
boolean pbServiceAvailable = false;
A similar interface,
try {
Context ctx = new InitialContext();
PortletServiceHome serviceHome = (PortletServiceHome) ctx.lookup("portletservice/com.ibm.portal.propertybroker.service.PropertyBrokerService");
brokerService = (PropertyBrokerService)serviceHome.getPortletService(com.ibm.portal.propertybroker.service.PropertyBrokerService.class);
pbServiceAvailable = true;
}
catch(Throwable t) {
}
com.ibm.wps.pb.service.PropertyBrokerService
is available for use by portlets written to IBM's portlet API.
Method Summary | |
---|---|
void |
activateAction(javax.portlet.PortletConfig config,
javax.portlet.ActionRequest request,
java.lang.String actionName)
An Action which has been deactivated is activated explicitly using this call. |
boolean |
areCrossPageWiresActive(javax.portlet.PortletRequest request,
javax.portlet.PortletResponse response,
java.lang.String propertyName)
Test to see if a property is currently wired to active actions on other pages. |
boolean |
areCrossPageWiresActive(javax.portlet.PortletRequest request,
java.lang.String propertyName)
Deprecated. use areCrossPageWiresActive(PortletRequest, PortletResponse, String) instead |
boolean |
areWiresActive(javax.portlet.PortletRequest request,
javax.portlet.PortletResponse response,
java.lang.String propertyName)
Test to see if a property is currently wired to active actions on this page. |
boolean |
areWiresActive(javax.portlet.PortletRequest request,
java.lang.String propertyName)
Deprecated. use areWiresActive(PortletRequest, PortletResponse, String) instead |
void |
deactivateAction(javax.portlet.PortletConfig config,
javax.portlet.ActionRequest request,
java.lang.String actionName)
An Action which is active for the session is deactivated using this call. |
boolean |
isWired(javax.portlet.PortletRequest request,
javax.portlet.PortletResponse response,
java.lang.String propertyName)
Test to see if a property is currently wired on this page. |
boolean |
isWired(javax.portlet.PortletRequest request,
java.lang.String propertyName)
Deprecated. use isWired(PortletRequest, PortletResponse, String) instead |
boolean |
isWiredAcrossPages(javax.portlet.PortletRequest request,
javax.portlet.PortletResponse response,
java.lang.String propertyName)
Test to see if a property is currently wired across pages. |
boolean |
isWiredAcrossPages(javax.portlet.PortletRequest request,
java.lang.String propertyName)
Deprecated. use isWiredAcrossPages(PortletRequest, PortletResponse, String) instead |
Method Detail |
---|
void activateAction(javax.portlet.PortletConfig config, javax.portlet.ActionRequest request, java.lang.String actionName) throws ActivationFailedException
false
for the
activeOnStartup
attribute for the action element in the WSDL file.
Inactive actions may be activated for specific sessions by invoking this method.
Inactive actions which are targets of wires are not invoked even if the wire is triggered
by the source portlet.
This call may only be invoked during the action phase of the portlet.
Refer to the WebSphere Portal InfoCenter for documentation on WSDL syntax and the
activeOnStartup
flag .
config
- the PortletConfig
objectrequest
- the ActionRequest
objectactionName
- the name of the action to be activated
ActivationFailedException
- is thrown if any problem is encountereddeactivateAction(PortletConfig, ActionRequest, String)
void deactivateAction(javax.portlet.PortletConfig config, javax.portlet.ActionRequest request, java.lang.String actionName) throws DeactivationFailedException
activateAction
method.
This call may only be invoked during the action phase of the portlet.
config
- the PortletConfig
objectrequest
- the ActionRequest
objectactionName
- the name of the action to be deactivated
DeactivationFailedException
- is thrown if any problem is encounteredactivateAction(PortletConfig, ActionRequest, String)
boolean isWired(javax.portlet.PortletRequest request, java.lang.String propertyName) throws AccessFailedException
isWired(PortletRequest, PortletResponse, String)
instead
request
- the PortletRequest
object for the current portlet requestpropertyName
- the name of the property to check
AccessFailedException
- is thrown if any problem is encounteredboolean areWiresActive(javax.portlet.PortletRequest request, java.lang.String propertyName) throws AccessFailedException
areWiresActive(PortletRequest, PortletResponse, String)
instead
request
- the PortletRequest
object for the current portlet requestpropertyName
- the name of the property to check
AccessFailedException
- is thrown if any problem is encounteredboolean isWiredAcrossPages(javax.portlet.PortletRequest request, java.lang.String propertyName) throws AccessFailedException
isWiredAcrossPages(PortletRequest, PortletResponse, String)
instead
request
- the PortletRequest
object for the current portlet requestpropertyName
- the name of the property to check
AccessFailedException
- is thrown if any problem is encounteredboolean areCrossPageWiresActive(javax.portlet.PortletRequest request, java.lang.String propertyName) throws AccessFailedException
areCrossPageWiresActive(PortletRequest, PortletResponse, String)
instead
request
- the PortletRequest
object for the current portlet requestpropertyName
- the name of the property to check
AccessFailedException
- is thrown if any problem is encounteredboolean isWired(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, java.lang.String propertyName) throws AccessFailedException
request
- the PortletRequest
object for the current portlet requestresponse
- the PortletResponse
objectpropertyName
- the name of the property to check
AccessFailedException
- is thrown if any problem is encounteredboolean areWiresActive(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, java.lang.String propertyName) throws AccessFailedException
request
- the PortletRequest
object for the current portlet requestresponse
- the PortletResponse
objectpropertyName
- the name of the property to check
AccessFailedException
- is thrown if any problem is encounteredboolean isWiredAcrossPages(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, java.lang.String propertyName) throws AccessFailedException
request
- the PortletRequest
object for the current portlet requestresponse
- the PortletResponse
objectpropertyName
- the name of the property to check
AccessFailedException
- is thrown if any problem is encounteredboolean areCrossPageWiresActive(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, java.lang.String propertyName) throws AccessFailedException
request
- the PortletRequest
object for the current portlet requestresponse
- the PortletResponse
objectpropertyName
- the name of the property to check
AccessFailedException
- is thrown if any problem is encountered
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |