Glossary:
Data Structures
Here are the data structures with brief descriptions:| com.pcbsys.nirvana.client.nAbstractChannel | This is the base class for all nirvana channel types, including queues and normal pub/sub channels and as such has no public methods |
| com.pcbsys.nirvana.client.nAsyncExceptionListener | This interface should be implemented by classes wishing to register to receive asynchronous errors from the nirvana server |
| com.pcbsys.nirvana.client.nBaseClientException | This exception forms the base for all client exceptions |
| com.pcbsys.nirvana.client.nChannel | This class is a Nirvana channel, offering the Nirvana channel related services |
| com.pcbsys.nirvana.client.nChannelAlreadyExistsException | This exception is thrown if a user tries to make a channel that already exists |
| com.pcbsys.nirvana.client.nChannelAlreadySubscribedException | The user has tried to subscribe to the channel more than once |
| com.pcbsys.nirvana.client.nChannelAttributes | This class is a container for the attributes necessary to create or locate a Nirvana channel or queue |
| com.pcbsys.nirvana.client.nChannelConnectionListener | This interface should be implemented by classes wishing to register to receive callbacks when connections are added or removed to a nirvana channel |
| com.pcbsys.nirvana.client.nChannelIterator | This class iterates synchronously over a Nirvana Realm channel |
| com.pcbsys.nirvana.client.nChannelNotFoundException | The specified channel could not be located on the server |
| com.pcbsys.nirvana.client.nChannelPublishKeys | This class contains the information about a single channel key |
| com.pcbsys.nirvana.client.nChannelWatcher | This interface extends the nEventListener interface and also provides the ability to receive callbacks for purged events as well as events published on a specific channel or queue |
| com.pcbsys.nirvana.client.nConflationAttributes | This class represents the conflation attributes that can be used when creating resources which allow conflation |
| com.pcbsys.nirvana.client.nConnectionQueueListener | This interface should be implemented by classes wishing to register to receive asynchronous notifications from the internal connection queue |
| com.pcbsys.nirvana.client.nConstants | This class is a container for the various constants that affect the behaviour of various Nirvana Client API calls |
| com.pcbsys.nirvana.client.nConsumeEvent | This class represents a Nirvana event, which consists of either a tag and some data or an event dictionary and some data |
| com.pcbsys.nirvana.client.nConsumeEventFactory | This class is used to facilitate creation of nConsumeEvent objects |
| com.pcbsys.nirvana.client.nDataGroup | This class represents a individual data group object |
| com.pcbsys.nirvana.client.nDataGroupDeletedException | Class representing an exception generated when an operation is performed on an nDataGroup that has been deleted |
| com.pcbsys.nirvana.client.nDataGroupIsReadOnlyException | Class representing an exception generated when an operation is performed on an nDataGroup that is read only |
| com.pcbsys.nirvana.client.nDataGroupListener | Listener interface used to manage changes to membership of data groups |
| com.pcbsys.nirvana.client.nDataStream | Represents the stream used to deliver data |
| com.pcbsys.nirvana.client.nDataStreamListener | Interface used to receive events asynchronously from a data group |
| com.pcbsys.nirvana.client.nDuplicateJoinException | The user has requested a join be created but the server already has this join configured in the database |
| com.pcbsys.nirvana.client.nEventAttributes | The nEventAttributes class is used by the nConsumeEvent object in order to store standard header values associated with nirvana client, p2p and JMS events |
| com.pcbsys.nirvana.client.nEventListener | This interface should be implemented by any object that wishes to register itself as an asynchronous subscriber to a nirvana channel or queue |
| com.pcbsys.nirvana.client.nEventProperties | This class contains a collection of key-value pairs, defining event meta data which can be used to create filter rules |
| com.pcbsys.nirvana.client.nEventPropertiesIterator | This class enables you to iterate through the event properties keys and values |
| com.pcbsys.nirvana.client.nExceededLimitException | The number of events in the current transaction has exceeded the server configuration |
| com.pcbsys.nirvana.client.nFindResult | This class represents the results of the nSession.find(nChannelAttributes[]) call |
| com.pcbsys.nirvana.client.nIllegalArgumentException | This class defines the error that can be thrown by passing an illegal argument to any method of any class in the nirvana client API |
| com.pcbsys.nirvana.client.nIllegalChannelModeException | This exception is thrown if a user tries calls queue specific functionality on a channel object or channel specific functionality on a queue object |
| com.pcbsys.nirvana.client.nIllegalStateException | This exception is thrown if a Channel or Queue is in an illegal state for specific functionality to be offered |
| com.pcbsys.nirvana.client.nJoinInformation | This class is a container for all the information that defines a channel join |
| com.pcbsys.nirvana.client.nNameAlreadyBoundException | This exception is thrown if a user attempts to create a named client context on a channel or queue that is already in use |
| com.pcbsys.nirvana.client.nNamedObject | This class represents a client context on a RealmServer |
| com.pcbsys.nirvana.client.nNameDoesNotExistException | This exception is thrown if a user attempts to delete a named client context on a channel or queue that does not exist |
| com.pcbsys.nirvana.client.nNamedPriorityListener | This interface should be implemented by any object that requires a callback when the subscription to a channel with a named object and priority enabled reaches the top |
| com.pcbsys.nirvana.client.nNameSpaceConflictException | There is a conflict in the name space and the attempted operation failed |
| com.pcbsys.nirvana.client.nObject | This class is used in conjunction with the nEventPropertiesIterator to determine the type of the values within the nEventProperties object |
| com.pcbsys.nirvana.client.nProtobufEvent | This class represents a Google Protocol Buffer Event |
| com.pcbsys.nirvana.client.nProtobufEventFactory | This class is used to facilitate creation of nConsumeEvent objects |
| com.pcbsys.nirvana.client.nQueue | This class provides a Queue mechanism |
| com.pcbsys.nirvana.client.nQueueAsyncReader | This Reader enables the client to receive all events asynchronously |
| com.pcbsys.nirvana.client.nQueueAsyncTransactionReader | This Reader enables the client to receive all events asynchronously |
| com.pcbsys.nirvana.client.nQueueDetails | Container class, containing statistics on the queue |
| com.pcbsys.nirvana.client.nQueuePeekContext | Provides a context when peeking on the queue |
| com.pcbsys.nirvana.client.nQueueReader | This class is the base class for all Queue Readers and provides a generic reader interface |
| com.pcbsys.nirvana.client.nQueueReaderContext | This class is used to construct a Queue Reader |
| com.pcbsys.nirvana.client.nQueueSyncReader | This class provides the client with a synchronous interface into a Nirvana Queue |
| com.pcbsys.nirvana.client.nQueueSyncTransactionReader | This reader provides a synchronous queue reader model |
| com.pcbsys.nirvana.client.nQueueTransactionReader | Provides the basic interface for transactional queue operations, used by the synchronous and asynchronous transactional queue readers |
| com.pcbsys.nirvana.client.nRealm | This class represents a nirvana Realm |
| com.pcbsys.nirvana.client.nRealmAlreadyBoundException | You have tried to bind a realm that the server already has been bound |
| com.pcbsys.nirvana.client.nRealmInUseException | This exception is thrown when an attempt is made to remove a realm from another realm when the realm is part of a cluster or has channels that are joined in the requesting realm |
| com.pcbsys.nirvana.client.nRealmNotFoundException | The specified realm was not found on the server |
| com.pcbsys.nirvana.client.nRealmUnreachableException | Was unable to reach the specified realm |
| com.pcbsys.nirvana.client.nReconnectHandler | This interface should be implemented by classes wishing to register to receive callbacks when sessions are disconnected or to take control over the reconnect logic |
| com.pcbsys.nirvana.client.nRegisteredEvent | This class enables a client to maintain a copy of an event, make changes to the properties and then when commit is called only the changes are published to the server |
| com.pcbsys.nirvana.client.nRegisteredEventListener | This interface should be implemented by any object that wishes to register itself as an asynchronous subscriber and receive update events and complete merged events from a registered event |
| com.pcbsys.nirvana.client.nRegisteredEventUpdateListener | This interface should be implemented by any object that wishes to register itself as an asynchronous subscriber and only receive update events only from a registered event |
| com.pcbsys.nirvana.client.nRequestResponseContainer | This class is the container for the request responses |
| com.pcbsys.nirvana.client.nRequestTimedOutException | When the maximum time the client API will wait for a response to a specific request from the Nirvana realm is reached, this exception is thrown |
| com.pcbsys.nirvana.client.nSecurityException | This class defines the security errors that can be thrown by using the nirvana client API |
| com.pcbsys.nirvana.client.nSelectorParserException | The supplied message filter string failed to be parsed |
| com.pcbsys.nirvana.client.nSession | This class represents a Nirvana session, the logical connection between the client API and the Nirvana realm |
| com.pcbsys.nirvana.client.nSessionAlreadyInitialisedException | The current nSession has already been initialised |
| com.pcbsys.nirvana.client.nSessionAttributes | This class is a container for the attributes necessary to create a Nirvana session |
| com.pcbsys.nirvana.client.nSessionFactory | This class is used with a nSessionAttributes object to create a Nirvana session |
| com.pcbsys.nirvana.client.nSessionNotConnectedException | The current nSession is not currently connected |
| com.pcbsys.nirvana.client.nSessionPausedException | This exception is thrown when an attempt is made by the client to make a request to the server, while the session is paused |
| com.pcbsys.nirvana.client.nSubject | This class contains information about the user identification used by Nirvana |
| com.pcbsys.nirvana.client.nSubscriptionAttributes | This class represents the attributes used for channel subscriptions |
| com.pcbsys.nirvana.client.nTransaction | This class enables the client to perform transactional publishing, representing a nirvana transaction |
| com.pcbsys.nirvana.client.nTransactionAlreadyAbortedException | The transaction has already been aborted and as such is closed |
| com.pcbsys.nirvana.client.nTransactionAlreadyCommittedException | The transaction has already been committed and as such is closed and completed |
| com.pcbsys.nirvana.client.nTransactionAttributes | This class is a container for the attributes necessary to create a Nirvana transaction |
| com.pcbsys.nirvana.client.nTransactionException | This class defines the errors that can be thrown by using the nirvana transactional publish API |
| com.pcbsys.nirvana.client.nTransactionFactory | This class is used with a nTransactionAttributes object to create a Nirvana transaction |
| com.pcbsys.nirvana.client.nTransactionIncompleteException | This exception will be thrown if abort or commit is called on a transaction that has not sent any events to the server |
| com.pcbsys.nirvana.client.nTransactionNoEventsException | This exception is thrown if Commit is called on a transaction without any events added in its context |
| com.pcbsys.nirvana.client.nTransactionNoSuchTXIDException | The supplied transaction ID could not be located on server |
| com.pcbsys.nirvana.client.nTransactionNotCommittedException | The transaction has not been committed so the status of the event can not be returned, such as getStartEID or getEndEID |
| com.pcbsys.nirvana.client.nTransactionNotStartedException | The transaction has not been started as such the transaction is not yet established |
| com.pcbsys.nirvana.client.nUnexpectedResponseException | The server responded with an event that the client did not expect |
| com.pcbsys.nirvana.client.nUnknownRemoteRealmException | The server does not know of the realm that was supplied |
| com.pcbsys.nirvana.client.nUnknownTransactionIdException | This exception is thrown when an attempt is made to perform an operation on a transaction where the id of the transaction is not known by the server |
| com.pcbsys.nirvana.client.nUserNotSubscribedException | The user is not currently subscribed to the channel |
| com.pcbsys.nirvana.client.p2p.nEventService | This class implements the end point of an Event based P2P connection |
| com.pcbsys.nirvana.client.p2p.nEventServiceListener | This interface enables the implementing class to be calledback when new events are received from the remote service |
| com.pcbsys.nirvana.client.p2p.nOutOfBandService | This class enables services to pass flow information or control information between them |
| com.pcbsys.nirvana.client.p2p.nP2PConstants | Class used to define some useful constants within the P2P API |
| com.pcbsys.nirvana.client.p2p.nServerService | Interface to implement a P2P server |
| com.pcbsys.nirvana.client.p2p.nService | This class provides a base for all P2P Services |
| com.pcbsys.nirvana.client.p2p.nServiceFactory | A ServiceFactory is used to create both client and server services |
| com.pcbsys.nirvana.client.p2p.nServiceInfo | This class contains information regarding the service, such as name, type and description |
| com.pcbsys.nirvana.client.p2p.nServiceStateListener | This interface should be implemented by objects that require notification when nService objects become disconnected and reconnected to the realm server |
| com.pcbsys.nirvana.client.p2p.nStreamService | This class implements the end point of a stream based P2P connection |
| com.pcbsys.nirvana.nAdminAPI.nACL | List of nACLEntry classes used by the Nirvana Realm server to control access to secured objects such as Realms, Channels and Queues |
| com.pcbsys.nirvana.nAdminAPI.nACLEntry | Contains the mapping between a subject User and the privileges they can perform on a secured object such as a Realm, Channel or Queue |
| com.pcbsys.nirvana.nAdminAPI.nACLEntryNotFoundException | Exception class that is thrown when an acl entry is not found when an operation is attempted on it |
| com.pcbsys.nirvana.nAdminAPI.nAdminIllegalArgumentException | Exception class that is thrown when an illegal argument is passed into a method |
| com.pcbsys.nirvana.nAdminAPI.nAdminSecurityException | Exception class that is thrown when attempted operations are not permitted |
| com.pcbsys.nirvana.nAdminAPI.nAPIConnectionListener | Contains callbacks for when new connections are made or deleted |
| com.pcbsys.nirvana.nAdminAPI.nBaseAdminException | Base class for all admin API exceptions |
| com.pcbsys.nirvana.nAdminAPI.nChannelACLEntry | Extends the nACLEntry class to supply Channel/Queue specific security settings |
| com.pcbsys.nirvana.nAdminAPI.nChannelConnectionDetails | This class contains additional information about a channel connection |
| com.pcbsys.nirvana.nAdminAPI.nChannelListener | Receives callback each time a new connection is added to or deleted from the channel |
| com.pcbsys.nirvana.nAdminAPI.nClusterEventListener | Interface allowing client applications to receive cluster specific callbacks |
| com.pcbsys.nirvana.nAdminAPI.nClusterMemberConfiguration | This object is used to create/modify clusters |
| com.pcbsys.nirvana.nAdminAPI.nClusterNode | Contains the status and configuration of a Nirvana cluster |
| com.pcbsys.nirvana.nAdminAPI.nClusterSite | This class defines a collection of realms within a cluster into a physical site / location |
| com.pcbsys.nirvana.nAdminAPI.nClusterStatus | This class contains the status of the of a realm within the cluster, What state it has, which node is the elected master etc |
| com.pcbsys.nirvana.nAdminAPI.nClusterStatusEntry | This class contains the online/offline status for a realm within a cluster |
| com.pcbsys.nirvana.nAdminAPI.nCommandStatus | Any class implementing this interface can be used to find the current status of a request, for example a copy operation of a nLeafNode |
| com.pcbsys.nirvana.nAdminAPI.nConfigEntry | This class contains all the information about a configuration parameter, including the name, the current value, a description of it and a warning or constraint string |
| com.pcbsys.nirvana.nAdminAPI.nConfigGroup | This class manages a group of nConfigEntry objects that are related |
| com.pcbsys.nirvana.nAdminAPI.nConfigurationException | Exception thrown when configuration operations fail |
| com.pcbsys.nirvana.nAdminAPI.nConnectionDetails | This class contains the details about an individual connection |
| com.pcbsys.nirvana.nAdminAPI.nContainer | This represents a node within the Nirvana Realm namespace which contains other nodes, such as a directory or another Realm |
| com.pcbsys.nirvana.nAdminAPI.nCopyable | All classes that can be copied from one part of the namespace to another implement this interface |
| com.pcbsys.nirvana.nAdminAPI.nDuplicateACLEntryException | Exception class that is thrown when a duplicate acl entry is attempted to be added |
| com.pcbsys.nirvana.nAdminAPI.nHTTPInterface | Creates a HTTP interface on the supplied adapter:port |
| com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface | This class contains all the configuration required by the Nirvana Realm server to start and control the HTTPS interface |
| com.pcbsys.nirvana.nAdminAPI.nInsufficientPrivilegesException | Exception class that is thrown when an operation is performed and there are insufficient privileges to complete it |
| com.pcbsys.nirvana.nAdminAPI.nInterface | Abstract Class nInterface |
| com.pcbsys.nirvana.nAdminAPI.nInterfaceManager | This class exposes the Realm Servers interface management API so that the control and management of the interfaces can be performed by an authorised Administrator |
| com.pcbsys.nirvana.nAdminAPI.nInterfacePluginConfiguration | This class contains the plugin static information used by the plugin instances |
| com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus | Contains the status of a Nirvana Realm server interface |
| com.pcbsys.nirvana.nAdminAPI.nInterfaceViaEntry | This contains the user parameters which are bound to an Interface |
| com.pcbsys.nirvana.nAdminAPI.nJoinable | All classes that can be joined from one part of the namespace to another implement this interface |
| com.pcbsys.nirvana.nAdminAPI.nJoinDetails | This class contains information about a join between two channels |
| com.pcbsys.nirvana.nAdminAPI.nLeafNode | This class represents the Nirvana Channel or Queue on the Nirvana Realm |
| com.pcbsys.nirvana.nAdminAPI.nLinkNode | Since the Nirvana namespace can contain multiple links to Nirvana Realm servers at different parts of the namespace, including namespace loops, this node represents a RealmServer which has been mounted elsewhere in the namespace |
| com.pcbsys.nirvana.nAdminAPI.nLogListener | Classes that implement this interface can register with the nRealmNode.addLogListener() to receive the realms log events |
| com.pcbsys.nirvana.nAdminAPI.nNode | All classes that exist in the Nirvana Realm NameSpace extend this object |
| com.pcbsys.nirvana.nAdminAPI.nNodeException | Exception class that is thrown when errors occur constructing the nodes to be administered |
| com.pcbsys.nirvana.nAdminAPI.nPluginConfigEntry | Contains information for a plugin configuration entry |
| com.pcbsys.nirvana.nAdminAPI.nPluginConfiguration | This class contains the configuration context for a single plugin on a single HTTP type interface |
| com.pcbsys.nirvana.nAdminAPI.nRealmACLEntry | Extends the nACLEntry class to expose the Realm specific permissions |
| com.pcbsys.nirvana.nAdminAPI.nRealmNode | This class represents a Realm within the Nirvana namespace |
| com.pcbsys.nirvana.nAdminAPI.nRemovable | All classes that can be removed from the namespace implement this interface |
| com.pcbsys.nirvana.nAdminAPI.nServiceACLEntry | Allows the ability to programmatically allow or deny access to a service |
| com.pcbsys.nirvana.nAdminAPI.nServiceNode | This class provides a mechanism to get information about P2P services on a particular realm |
| com.pcbsys.nirvana.nAdminAPI.nSocketInterface | Socket Interface class |
| com.pcbsys.nirvana.nAdminAPI.nSSLInterface | This class contains all the configuration required by the Nirvana Realm server to start and control the SSL interface |
| com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI | This interface is used to expose the SSL attributes for all interfaces that are SSL enabled |
| com.pcbsys.nirvana.nAdminAPI.nThreadPool | This class is used to represent an instance of a thread pool being used within a Nirvana realm |
| com.pcbsys.nirvana.nAdminAPI.nUnsupportedJoinException | Exception class that is thrown when a join operation is attempted but cannot be completed |
| com.pcbsys.nirvana.nAdminAPI.nUnsupportedRemoveException | Exception class that is thrown when a remove operation is attempted but cannot be completed |
