NotificationServer

java.lang.Object
- com.ihr.xbrl.notifications.NotificationServer

```
public class NotificationServer
extends java.lang.Object
```
The notification server provides a mechanism to register notifications from different parts of the API. The notification server provides the following functionality:
1. Receive notifications from the API, a notification is an instance of the Notification class
2. Stores all received notifications. Some notifications will exist only for the session. Some notifications will be stored and remain until the user decides to close it
3. Provides capacity to register listeners to receive notification events
4. Generates events to route notifications to the GUI
Author:

Ignacio

See Also:

Notification

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`atomNS` The Constant atomNS.
`static java.lang.String`	`IGNOREALLREQUESTS` If this property is set to "true" this catalog will be disabled and no requests about the StaticCatalog file will be ever sent.
`static java.lang.String`	`NOTIFICATIONLIST` The constant NotificationsList is used on PropertyChangeEvents.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addNotification(Notification.NotificationType type, java.lang.String message)` Generates a new Notification instance and submit it to the notification server.
`void`	`addNotification(Notification.NotificationType type, java.lang.String message, java.lang.String link)` Generates a new Notification instance and submit it to the notification server.
`void`	`addNotification(Notification notification)` Adds the notification.
`void`	`addNotificationsListener(java.beans.PropertyChangeListener listener)` Register a notification listener instance that will be informed about new notifications added.
`static NotificationServer`	`getInstance()` Obtains access to the NotificationServer.
`Notification`	`getLastNotification()` Gets the last notification.
`Notification`	`getNotification(int notificationIndex)` Gets the notification.
`java.util.Collection<Notification>`	`getNotifications()` Gets the notifications.
`static java.util.List<Notification>`	`readNotificationsServer(net.sf.saxon.s9api.XdmNode docNode)` This method reads notifications from the XML document received in the parameter the document must conform with the Atom format.
`static net.sf.saxon.s9api.XdmNode`	`readNotificationsURL(java.net.URL serverFileName)` Read the file pointed to by the URL parameter and builds up an XdmNode document from it.
`void`	`removeNotification(Notification notification)` Removes a notification from the list.
`void`	`removeNotificationsListener(java.beans.PropertyChangeListener listener)` Removes a notification listener from the queue .
`int`	`size()` Size.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - atomNS
```
public static final java.lang.String atomNS
```
    The Constant atomNS.
    
    See Also:
    
    Constant Field Values
  - IGNOREALLREQUESTS
```
public static final java.lang.String IGNOREALLREQUESTS
```
    If this property is set to "true" this catalog will be disabled and no requests about the StaticCatalog file will be ever sent. The default value for this property is "false"
    
    See Also:
    
    Constant Field Values
  - NOTIFICATIONLIST
```
public static final java.lang.String NOTIFICATIONLIST
```
    The constant NotificationsList is used on PropertyChangeEvents.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getInstance
```
public static NotificationServer getInstance()
```
    Obtains access to the NotificationServer. This is a singleton
    
    Returns:
    
    the NotificationServer instance
  - addNotification
```
public void addNotification(Notification.NotificationType type,
                            java.lang.String message)
```
    Generates a new Notification instance and submit it to the notification server.
    
    Parameters:
    
    type - the type
    
    message - the message
  - addNotification
```
public void addNotification(Notification.NotificationType type,
                            java.lang.String message,
                            java.lang.String link)
```
    Generates a new Notification instance and submit it to the notification server.
    
    Parameters:
    
    type - the type
    
    message - the message
    
    link - optional
  - addNotificationsListener
```
public void addNotificationsListener(java.beans.PropertyChangeListener listener)
```
    Register a notification listener instance that will be informed about new notifications added.
    
    Parameters:
    
    listener - the listener
  - removeNotificationsListener
```
public void removeNotificationsListener(java.beans.PropertyChangeListener listener)
```
    Removes a notification listener from the queue .
    
    Parameters:
    
    listener - the listener
  - addNotification
```
public void addNotification(Notification notification)
```
    Adds the notification.
    
    Parameters:
    
    notification - the notification
  - removeNotification
```
public void removeNotification(Notification notification)
```
    Removes a notification from the list.
    
    Parameters:
    
    notification - the notification
  - readNotificationsURL
```
public static net.sf.saxon.s9api.XdmNode readNotificationsURL(java.net.URL serverFileName)
                                                       throws java.io.IOException,
                                                              net.sf.saxon.s9api.SaxonApiException
```
    Read the file pointed to by the URL parameter and builds up an XdmNode document from it. The document IS NOT schema validated but it is XML validated. The surrounding model is the LINKED_TREE so the document content can be edited.
    
    Parameters:
    
    serverFileName - the server file name
    
    Returns:
    
    the xdm node
    
    Throws:
    
    java.io.IOException - Signals that an I/O exception has occurred.
    
    net.sf.saxon.s9api.SaxonApiException - the saxon api exception
  - readNotificationsServer
```
public static java.util.List<Notification> readNotificationsServer(net.sf.saxon.s9api.XdmNode docNode)
                                                            throws net.sf.saxon.s9api.SaxonApiException
```
    This method reads notifications from the XML document received in the parameter the document must conform with the Atom format. Only atom:entry are processed and only elements atom:id, atom:link, atom:content are used in a Notification
    
    Parameters:
    
    docNode - the doc node
    
    Returns:
    
    the list
    
    Throws:
    
    net.sf.saxon.s9api.SaxonApiException - the saxon api exception
  - getLastNotification
```
public Notification getLastNotification()
```
    Gets the last notification.
    
    Returns:
    
    the last notification in the list or null
  - getNotifications
```
public java.util.Collection<Notification> getNotifications()
```
    Gets the notifications.
    
    Returns:
    
    used by the GUI to create a list with all notifications
  - size
```
public int size()
```
    Size.
    
    Returns:
    
    the int
  - getNotification
```
public Notification getNotification(int notificationIndex)
```
    Gets the notification.
    
    Parameters:
    
    notificationIndex - the notification index
    
    Returns:
    
    the notification

Class NotificationServer

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

atomNS

IGNOREALLREQUESTS

NOTIFICATIONLIST

Method Detail

getInstance

addNotification

addNotification

addNotificationsListener

removeNotificationsListener

addNotification

removeNotification

readNotificationsURL

readNotificationsServer

getLastNotification

getNotifications

size

getNotification