|
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 |
java.lang.Object com.bea.netuix.servlets.manager.notifications.NotificationContext
public abstract class NotificationContext
The NotificationContext object serves as a cache and accessor for notifications and ties in to the portal framework rendering lifecycle to allow notifications to be marked for consumption after the render lifecycle has completed, thus allowing equal access to notifications across multiple portlets on a page.
INotificationManager for
administrative needs.
Constructor Summary | |
---|---|
NotificationContext()
|
Method Summary | |
---|---|
static NotificationContext |
getNotificationContext(javax.servlet.http.HttpServletRequest request)
A convenience method for returning the NotificationContext object associated
with the specified Request. |
abstract Collection<Notification> |
getNotifications()
Gets all the notifications appropriate for this NotificationContext (sent to the user authenticated in the request object, either globally targeted or targeted to the webapp for this request). |
Collection<Notification> |
getNotifications(Collection<String> namespaces)
Gets all the notifications appropriate for this NotificationContext (sent to the user authenticated in the request object, either globally targeted or targeted to the webapp for this request) that match the specified namespaces. |
Collection<Notification> |
getNotifications(String namespace,
String name)
Gets all the notifications appropriate for this NotificationContext (sent to the user authenticated in the request object, either globally targeted or targeted to the webapp for this request) that match the specified namespace and name. |
abstract boolean |
isMarkedForConsumption(Notification notification)
Determines if the specified notification has been marked for consumption at the end of this render lifecycle. |
abstract boolean |
isNotificationDeliveryActive()
Determines if notification delivery through the inter-portlet eventing mechanisms is turned on for this webapp. |
abstract void |
markForConsumption(Notification notification)
Marks the specified notification for consumption, so that it will be consumed after the current page render cycle has completed. |
void |
markForConsumption(NotificationId notificationId)
Marks the specified notification for consumption, so that it will be consumed after the current page render cycle has completed. |
abstract void |
notifyUser(String username,
NotificationPayloadInfo payload)
Used to send a notification to a single user. |
abstract void |
notifyUsers(INotificationUserEnumerator userEnumerator,
NotificationPayloadInfo payload)
Used to send a notification to multiple users in an asynchronous manner. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public NotificationContext()
Method Detail |
---|
public static NotificationContext getNotificationContext(javax.servlet.http.HttpServletRequest request)
NotificationContext
object associated
with the specified Request. The NotificationContext is always available, even if no user is
logged in.
request
- the HttpServletRequest
.
NotificationContext
object associated with the request.public abstract Collection<Notification> getNotifications()
public Collection<Notification> getNotifications(String namespace, String name)
namespace
- the namespace notifications must match to be included in the results.
If null
, notifcations with any namespace are included.name
- the name notifications must match to be included in the results.
If null
, notifcations with any name are included.public Collection<Notification> getNotifications(Collection<String> namespaces)
namespaces
- A collection of valid namespaces notifications must match to be
included in the results.public void markForConsumption(NotificationId notificationId) throws NotEntitledException
notificationId
- the ID of the notification to mark for later consumption.
NotEntitledException
- if the specified notification does not
belong to the currently authenticated principal.public abstract void markForConsumption(Notification notification) throws NotEntitledException
notification
- the notification to mark for later consumption.
NotEntitledException
- if the specified notification does not
belong to the currently authenticated principal.public abstract boolean isMarkedForConsumption(Notification notification)
notification
- the notification to determine if marked for later consumption.
public abstract void notifyUser(String username, NotificationPayloadInfo payload) throws IllegalArgumentException, RemoteException
username
- the user to send the notification to.payload
- the payload of the notification to send.
IllegalArgumentException
- if any of the fields in the
NotificationPayloadInfo
object are invalid.
RemoteException
public abstract void notifyUsers(INotificationUserEnumerator userEnumerator, NotificationPayloadInfo payload) throws IllegalArgumentException, RemoteException
userEnumerator
- an object which can be used to enumerate the set
of users to send the notification to. It is important that
this method is never called twice with the same instance of a
userEnumerator
object, as there is no
guarantee that the requests will not be processed in parallel
and the enumeration is not thread-safe.payload
- the payload of the notification to send.
IllegalArgumentException
- if any of the fields in the
NotificationPayloadInfo
object are invalid.
RemoteException
public abstract boolean isNotificationDeliveryActive()
|
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 |