Metaswitch Documentation
Rhino
Toggle TOC
Single page view
Download HTML
componentbased
Abstract base class for all sub tasks that accept a component element.
Previous page
Next page
Rhino
Version 3.2
Rhino Administration and Deployment Guide
Notices
SLEE Management
Namespaces
About Namespaces
Creating a Namespace
Removing a Namespace
Listing Namespaces
Setting the Active Namespace
Getting the Active Namespace
Operational State
About SLEE Operational States
Starting the SLEE
Stopping the SLEE
Retrieving the State of Nodes
Basic Operational State of a Node
Detailed Information for Every Node in the Cluster
Terminating Nodes
Shut Down Gracefully
Forcefully Terminate
Activation State
About Activation State Modes
Listing All Desired States
Per-Node Desired State
Listing Nodes with Per-Node Desired State
Copying Per-Node Desired State to Another Node
Removing Per-Node Desired State
Startup and Shutdown Priority
Deployable Units
About Deployable Units
Installing Deployable Units
Uninstalling Deployable Units
Listing Deployable Units
Locking component installation
Services
About Services
Retrieving a Service's State
Listing Services
All Available Services
Services by State
Activating and Deactivating Services
Activating Services
Deactivating Services
Upgrading (Activating & Deactivating) Services
Getting Link Bindings Required by a Service
Configuring service metrics recording status
Configuring service replication
Resource Adaptor Entities
About Resource Adaptor Entities
Creating and Removing Resource Adaptor Entities
Finding RA Configuration Properties
Creating a Resource Adaptor Entity
Removing a Resource Adaptor Entity
Configuring Resource Adaptor Entities
Listing configuration properties for a Resource Adaptor Entity
Updating configuration properties for a Resource Adaptor Entity
Activating and Deactivating Resource Adaptor Entities
Activating a Resource Adaptor Entity
Deactivating a Resource Adaptor Entity
Reassigning a Resource Adaptor Entity's Activities to Other Nodes
Retrieving the State of Resource Adaptor Entities
Retrieving a Resource Adaptor Entity's State
Listing Resource Adaptor Entities by State
Managing Resource Adaptor Entity Link Bindings
Binding a Resource Adaptor Entity to a Link Name
Unbinding Link Names
Listing Link Name Bindings
Profile Tables and Profiles
About Profiles
Creating Profile Tables
Creating Profiles
Listing Profile Tables
Listing Profiles
Listing Profile Attributes
Setting Profile Attributes
Finding Profiles
Finding Profiles by Attribute Value
Finding Profiles Using Static Queries
Finding Profiles Using Dynamic Queries
Export and Import
Exporting Profiles
Importing Profiles
Alarms
About Alarms
Configuring alarm log period
Viewing Active Alarms
Clearing Alarms
Clear Individual Alarms
Clear Alarms Raised by a Particular Notification Source
Threshold Alarms
Creating and Removing Rules
Listing Rules
Configuring Rules
Threshold Rule MBean Operations
Activating and Deactivating Rules
Setting and Getting Rule-Scan Periods
Runtime Alarm List
Rhino Alarm List
Usage
About Usage
Viewing Usage Parameters
Usage Notifications
Enabling and Disabling Usage Notifications
Viewing Usage Notification Status
Named Usage Parameter Sets
Creating Usage Parameter Sets
Listing Usage Parameter Sets
Removing Usage Parameter Sets
User Transactions
About User Transactions
Starting User Transactions
Committing User Transactions
Rolling Back User Transactions
Auditing Management Operations
Linked and Shadowed Components
Component Activation Priorities
Declarative Configuration
Concepts and Terminology
Configuration Bundles
Declarative Configuration Commands
Exporting Configuration
Importing Configuration
Waiting For Convergence
Retrieving a Convergence Status Report
Convergence
Developing With Configuration Bundles
Version Control
Common Use Cases
Common Problems
Rhino Configuration
Logging
About Logging
About SLEE 1.1 Tracers
Creating a File Appender
Create a Socket Appender
Creating a Console Appender
Remove an Appender
Attaching an Appender to a Logger
Configure a Logger
Mananging a Logger's Additivity
Managing a Logger's Log Level
Listing Log Appenders
Listing Log Keys
Managing Logging Properties
Define a Plugin Component
Annotating Log files
Rolling-Over All Rolling File Appenders
Logging Plugins
Known Issues
Staging
Configuring Staging Parameters
Object Pools
Licenses
About Licenses
License Audit Log Format
Listing Current Licenses
Getting Licensed Capacity
Installing a License
Uninstalling a License
Rate Limiting (Overload Control)
About Rate Limiting
Limiter Types
Managing Rate Limiting
Managing Limiters
Creating a Limiter
Removing a Limiter
Setting Limiter Properties
Inspecting a Limiter
Listing Limiters and Limiter Hierarchies
Managing Limiter Endpoints
Connecting a Limiter Endpoint to a Limiter
Disconnecting a Limiter Endpoint from a Limiter
Listing Limiter Endpoints
Finding which Limiter is Connected to a Limiter Endpoint
Managing Rate Limiter Ramp-up
About Rate Limiter Ramp-up
Enabling Rate Limiter Ramp-up
Disabling Rate Limiter Ramp-up
Inspecting Rate Limiter Ramp-up Configuration
Monitoring Limiter Statistics
Using Alarms with Limiters
Security
Configuring Java Security of Rhino
Secure Access for OA&M Staff
Authentication
Encrypted Communication with SSL
Enabling Remote Access
Configuring the SLEE Component Java Sandbox
Default Security Permissions for SLEE Components
Adding Security Permissions to SLEE Components
External Databases
Adding the JDBC Driver
Persistence Instances
About Persistence Instances
Creating Persistence Instances
Displaying Persistence Instances
Updating Persistence Instances
Removing Persistence Instances
Persistence Resources
About Persistence Resources
Creating Persistence Resources
Displaying Persistence Resources
Removing Persistence Resources
Adding Persistence Instances to a Persistence Resource
Displaying a Persistence Resource's Persistence Instances
Removing Persistence Instances from a Persistence Resource
JDBC Resources
How SBBs use JDBC to execute SQL
Creating JDBC Resources
Displaying JDBC Resources
Removing JDBC Resources
Adding A Persistence Instance to a JDBC Resource
Displaying a JDBC Resource's Persistence Instance
Removing the Persistence Instance from a JDBC Resource
Managing Database Connections
Adding a Connection Pool Configuration to a JDBC Resource
Displaying a JDBC Resource's Connection Pool Configuration
Updating a JDBC Resource's Connection Pool Configuration
Removing the Connection Pool Configuration from a JDBC Resource
Persisting Resources
Listing Persisting Resources
Exporting Persisting Resource Data Definitions
Dumping Persisting Resource Tables
Persistence Configuration File Format
XML Format of a Persistence Configuration
Persistence instance configuration
Persistence resource configuration
JDBC resource configuration
Savanna Cluster Membership
About Multicast
About Scattercast
Scattercast Management
Add Scattercast Endpoint(s)
Delete Scattercast Endpoint(s)
Get Scattercast Endpoints
Update Scattercast Endpoint(s)
Pool Clustering Mode
Differences Between Rhino Pools and Savanna Clustering
Configuring Rhino for Pool Mode
Requirements for Databases
Cassandra Pool Maintenance Provider Statistics
Static Replication Domaining
Configuring Static Replication Domaining
Displaying the Current Domaining Configuration
Data Striping
Configuring Data Striping
Displaying the Current Striping Configuration
MemDB and striping statistics
Service Assurance Server (SAS) Tracing
SAS Configuration
Enabling and Disabling SAS Tracing
SAS Bundle Mappings
SAS Bundle Generation
System Properties
Application-State Maintenance
About Application-State Maintenance
Finding Housekeeping MBeans
Activities
Finding Activities
Inspecting Activities
Activity Information Fields
Removing Activities
Removing All Activities
Timers
Finding Timers
Finding Remote Timers
Inspecting Timers
Timer Information Fields
Inspecting Remote Timers
Remote Timer Information Fields
Cancelling Timers
Cancelling Remote Timers
SBB Entities
Finding SBB Entities
Inspecting SBB Entities
SBB Entity Information Fields
Diagnosing SBB Entities
Removing SBB Entities
Removing All SBB Entities
Activity Context Name Bindings
Finding Activity Context Name Bindings
Removing Activity Context Name Bindings
Runtime Component Configuration
Inspecting Environment Entries
Setting Environment Entries
Inspecting Security Permissions
Modifying Security Permissions
Garbage Collection
Activity State Cleanup
Global State Cleanup
State Flushing
Key/Value Store Persistence
Configuration Persistence
Backup and Restore
About Backup and Restore
Rhino SLEE State
About Rhino Exports
Exporting a SLEE
Importing a SLEE
Partial Imports
Profile Snapshots
About SLEE Profile Snapshots
Saving a Profile Snapshot
Inspecting a Profile Snapshot
Preparing a Snapshot for Importing
Importing a Profile Snapshot
External Persistence Database Backups
Monitoring Rhino Using SNMP
Accessing SNMP Statistics and Notifications
Exporting MIB Files
Configuring and Managing the Rhino SNMP Agent
Managing the Status of the SNMP Agent
Configuring Authentication Details
Configuring Port and Interface Bindings
Setting SNMP System Information
Configuring SNMP Notifications
Managing Per-Node State
Configuring OID Registration Model Support
Viewing SNMP Static OIDs
Configuring SNMP Legacy OID Mappings
Configuring SNMP Legacy Counter Mappings
Removing the Log Notification Appender
Static OID Model
Static OID Conflicts
Legacy OID Model
Differences between the static and legacy OID models
Rhino SNMP OID Mappings
Replication Support Services
Key/Value Stores
About Key/Value Stores
Configuring a Key/Value Store
Cassandra Key/Value Store
Cassandra Key/Value Store Statistics
Session Ownership
About Session Ownership
Configuring a Session Ownership Store
Application-Level APIs
Session Ownership Facility
Session Ownership Resource Adaptor Type
Convergence Name Session Ownership Record
Cassandra Session Ownership Store
Cassandra Session Ownership Store Statistics
Management Tools
Tools for General Operations, Administration, and Maintenance
Command-Line Console (rhino-console)
Configuring the Command Console
Logging into the Command Console
Selecting a Management Command from the Command Console
Configuring Failover for the Command Console
Rhino Element Manager (REM)
Scripting with Apache Ant
Sample Rhino Ant Tasks
abstractbase
activateraentity
activateservice
addappenderref
addloggercomponent
addpermissionmapping
addpermissiontorole
addpersistenceinstanceref
addservicebindings
bindralinkname
cascadeuninstall
checkalarms
commandline
componentbased
configureabsolutestatlimiter
configurelogger
configureobjectpools
configureratelimiter
configurerelativestatlimiter
configuresas
configuresaturationlimiter
configurestagingqueues
connectraentitylimiterendpoint
connectservicelimiterendpoint
copycomponent
createappender
createconsoleappender
createdatabaseresource
createfileappender
creategenericappender
creategenericcomponent
createjdbcresourceconnectionpool
createlimiter
createlinkedcomponent
creatememorymappedfileappender
createnamespace
createoutputstreamappender
createpersistenceinstance
createprofile
createprofiletable
createraentity
createrandomaccessfileappender
createrole
createrollingfileappender
createrollingrandomaccessfileappender
createsocketappender
createsyslogappender
createusageparameterset
databaseresource
deactivateraentity
deactivateservice
deploycomponent
deploydeployableunit
disablerampup
disablesymmetricactivationstatemode
disconnectraentitylimiterendpoint
disconnectservicelimiterendpoint
enablerampup
enablesymmetricactivationstatemode
importconfigurationkey
importprofiles
install
notificationsourcebased
profilebased
profilevaluebased
raentitybased
removeappenderref
removecopiedcomponents
removedatabaseresource
removejdbcresourceconnectionpool
removelimiter
removelinkedcomponent
removeloggerconfig
removeloggingproperty
removenamespace
removepermissionfromrole
removepermissionmapping
removepersistenceinstance
removepersistenceinstanceref
removeprofile
removeprofiletable
removeraentity
removerole
removesasbundlemapping
removeservicebindings
removeusageparameterset
setactivenamespace
setadditivity
setjdbcresourceconnectionpoolconfig
setloggingproperties
setloglevel
setprofileattributes
setraentitystartingpriority
setraentitystoppingpriority
setsasbundlemapping
setsastracingenabled
setservicemetricsrecordingenabled
setservicestartingpriority
setservicestoppingpriority
settracelevel
settracerlevel
shadowcomponent
unbindralinkname
undeploycomponent
uninstall
unsetalltracers
unshadowcomponent
unverifycomponent
updatepersistenceinstance
usertransaction
verifycomponent
verifydeployableunit
waittilraentityisinactive
waittilserviceisinactive
Building Custom OA&M Tools with Rhino Remote API
Connecting to Rhino
MBean Proxies
Working with Profiles
SLEE Management Script
Rhino Management Script
Java Management Extension Plugins (JMX M-lets)
JMX Remote Adaptor M-let
Monitoring and System-Reporting Tools
rhino-stats
About Rhino Statistics
Running rhino-stats
Gathering Statistics in Console Mode
Gathering Statistics in Graphical Mode
Details of Available Statistics
generate-system-report
dumpthreads
dependency-graph
Utilities
init-management-db
generate-client-configuration
rhino-passwd
cascade-uninstall
Export-Related Tools
Memory Considerations
Collapse tree
/
Expand tree
Cross Reference:
from another location on this page
Cross Reference:
from another page in this book
Cross Reference:
from another book that is part of the same product
Cross Reference:
from another book in that is part of another product
Section Id:
the id of this heading
Page Id:
the page-id of this page
Absolute URL:
for sharing via email etc
