IBM WebSphere DataPower XC10 Appliance Version 2.5 documentation
IBM WebSphere DataPower XC10 Appliance overview
What’s new
Release notes
Appliance topology
Topologies for linking collectives to implement multi-master replication
Enterprise data grid overview
Transaction processing overview
Transactions
Locking strategies
Lock types
Deadlocks
Data access and transactions
Transaction isolation
Two-phase commit and error recovery
Notices
Privacy policy considerations
Scenarios
Configuring an enterprise data grid
Enterprise data grid overview
Configuring IBM eXtremeIO (XIO)
Developing enterprise data grid applications
Class evolution
Defining ClassAlias and FieldAlias annotations to correlate Java and .NET classes
ClassAlias and FieldAlias annotations
Mapping keys to partitions with PartitionKey annotations
Java and C# data type equivalents
Securing WebSphere DataPower XC10 Appliance
Configuring secure access to the data grid
Enabling security for data grids
Configuring client security
Migrating a WebSphere Application Server memory-to-memory replication or database session to use WebSphere eXtreme Scale session management
Taking note of previous configuration settings in WebSphere Application Server administrative console
Creating the catalog service domain for session management in the data grid
Configuring WebSphere DataPower XC10 Appliance to use your previous configuration settings
Tutorial: Getting started with simple data grid applications
Lesson 1.1: Configuring data grids
Module 2: Create a client application
Lesson 2.1: Creating a Java client application
Lesson 2.2: Creating a .NET client application
Lesson 2.3: Creating an enterprise data grid application
Module 3: Running the sample application in the data grid
Lesson 3.1: Running the getting started sample client application
Lesson 3.2: Running the .NET sample client application
Lesson 4: Monitor your environment
Planning a DataPower XC10 Appliance environment
System requirements
Directory conventions
Network ports
IBM WebSphere DataPower XC10 Appliance installation prerequisites
Appliance specifications and features
Type 7199-92x
Type 7199-92x front view
Type 7199-92x rear view
Ethernet network configuration
Product interoperability
Microsoft .NET considerations
Installing WebSphere DataPower XC10 Appliance
Quick start: Installing the appliance hardware
Initializing and configuring IBM WebSphere DataPower XC10 Appliance
xcadmin password
Installing WebSphere eXtreme Scale Client
Installing IBM Installation Manager and WebSphere eXtreme Scale Client product offerings
Offering IDs for WebSphere eXtreme Scale Client products
Installing within WebSphere Application Server
Installing IBM Installation Manager using the GUI
Installing WebSphere eXtreme Scale Client using the GUI
Installing IBM Installation Manager using the command line
Installing WebSphere eXtreme Scale Client using the command line
Installing IBM Installation Manager using response files
Installing WebSphere eXtreme Scale Client using a response file
Creating a keyring
Uninstalling WebSphere eXtreme Scale Client using IBM Installation Manager
Uninstalling WebSphere eXtreme Scale Client using the GUI
Uninstalling WebSphere eXtreme Scale Client using the command line
Uninstalling WebSphere eXtreme Scale Client using response files
Installing WebSphere eXtreme Scale Client for .NET overview
Installing WebSphere eXtreme Scale Client for .NET
Installing WebSphere eXtreme Scale Client for .NET with silent mode
Uninstalling WebSphere eXtreme Scale Client for .NET
Installing WebSphere eXtreme Scale Client for .NET without the installation program
Installing the Liberty profile
Data caching and the Liberty profile
Installing the Liberty profile application-serving environment by running a JAR file
Troubleshooting the product installation
Updating WebSphere DataPower XC10 Appliance
Updating the firmware
Updating WebSphere eXtreme Scale Client on WebSphere Application Server
Installing fix packs using IBM Installation Manager
Installing fix packs using the GUI
Installing fix packs using the command line
Installing fix packs using a response file
Uninstalling fix packs using IBM Installation Manager
Uninstalling fix packs using the GUI
Uninstalling fix packs using the command line
Uninstalling fix packs using response files
Upgrading WebSphere eXtreme Scale Client for .NET
Creating a side-by-side installation of fix packs for WebSphere eXtreme Scale Client for .NET
Configuring your appliance
Security
IBM WebSphere DataPower XC10 Appliance security overview
Configuring Transport Layer Security (TLS) for WebSphere Application Server
Configuring IBM WebSphere DataPower XC10 Appliance user interface security
Configuring your appliance to authenticate users with an LDAP directory
Managing users and groups
Creating a user
Managing users
Removing a user
Registering a new user account
Creating a user group
Managing user groups
Removing a user group
User permissions
Managing the IBM WebSphere DataPower XC10 Appliance Ethernet interfaces
Adding an aggregate interface
Editing an aggregate interface
Deleting an aggregate interface
Importing and exporting configurations
Managing imported and exporting configurations
Managing the Domain Name System (DNS) Server
Mapping IP addresses to host names
Managing date and time settings
Managing IBM WebSphere DataPower XC10 Appliance email delivery
Shutting down or restarting the appliance from the user interface
Configuring collectives and zones
Creating a collective
Creating and modifying zones
Configuring multi-master replication between collectives
Configuring IBM eXtremeIO (XIO)
Displaying the transport type of your catalog service domain
Configuring data grids
Creating simple data grids
Configuring dynamic maps
Configuring a locking strategy
Configuring a time to live (TTL) evictor
Evictors
Configuring the near cache
Configuring near-cache invalidation
Managing host names for communication between clients and servers
Creating session data grids
Configuring WebSphere Application Server HTTP session persistence to a data grid
Configuring the HTTP session manager with WebSphere Application Server
Configuring HTTP session manager with WebSphere Portal
Configuring the HTTP session manager for various application servers
Migrating a WebSphere Application Server memory-to-memory replication or database session to use WebSphere eXtreme Scale session management
Taking note of previous configuration settings in WebSphere Application Server administrative console
Creating the catalog service domain for session management in the data grid
Configuring WebSphere DataPower XC10 Appliance to use your previous configuration settings
Configuring the ASP.NET session state store provider
Creating a data grid to use with the ASP.NET session state store provider
Configuring the ASP.NET session state store provider
Displaying HTTP session sizes
Servlet context initialization parameters
splicer.properties file
Creating dynamic cache data grids
Configuring dynamic cache instances
Configuring the default dynamic cache instance (baseCache)
Configuring object or servlet dynamic cache instances
Customizing a dynamic cache instance with custom properties
Cache instances properties file
Dynamic cache custom properties
Dynamic cache provider overview
Creating catalog service domains in WebSphere Application Server
Catalog service domain administrative tasks
Configuring a near cache for the dynamic cache
Configuring the maximum capacity of a data grid
Enabling security for data grids
Clearing data grids
Removing data grids
Configuring a Spring cache provider
Configuring clients
Configuring Java clients
Java client overrides
Configuring Java clients with an XML configuration
Configuring Java clients programmatically
Configuring request and retry timeout values
Configuring the Liberty profile to use the data grid for session management
Configuring the Liberty profile for data grids that are accessed with SSL enabled
Configuring the Liberty profile to run with clients
Enabling the webApp feature in the Liberty profile
Liberty profile xsWebApp feature properties
Liberty profile xsDynacacheApp feature properties
Deploying the REST gateway
Configuring WebSphere eXtreme Scale Client for .NET
WebSphere eXtreme Scale Client for .NET overrides
Configuring WebSphere eXtreme Scale Client for .NET programmatically
Enabling dynamic configuration of WebSphere eXtreme Scale Client for .NET
Administering data grids
Querying , displaying, and invalidating data
Administering with the xscmd utility
Configuring security profiles for the xscmd utility
Administering with the HTTP command interface
Developing applications to access simple data grids
Developing Java applications
Accessing Java API documentation
Example: Simple data grid application
Creating dynamic maps with Java APIs
Programming for transactions
Interacting with data in a transaction
Developing applications that update multiple partitions in a single transaction
Two-phase commit and error recovery
Developing applications to write to multi-partition transactions for WebSphere eXtreme Scale in a stand-alone environment
Developing eXtreme Scale client components to use transactions
Using locking
Configuring and implementing locking in Java applications
Java exception handling for locking
Example: flush method lock ordering
Java examples for transaction isolation
Plug-ins for indexing data
Accessing data with indexes (Index API)
DynamicIndexCallback interface
Using Sessions to access data in the grid
Configuring the HashIndex plug-in
HashIndex plug-in attributes
Using a composite index
Using a global index
Notifying clients of map updates using continuous query
Developing data grid applications with the REST gateway
URI format
Data format
REST operations
Example: Inserting and getting data grid map entries
Example: Inserting and accessing data into a REST map from a Java client
Example: Clearing data grid map entries
Example: Creating dynamic maps
Example: TTL expiration
REST security configuration
REST HTTP sessions and cookies
Developing .NET applications
Setting up the .NET development environment
Accessing WebSphere eXtreme Scale Client for .NET API documentation
Creating dynamic maps with .NET APIs
Defining ClassAlias and FieldAlias annotations to correlate Java and .NET classes
ClassAlias and FieldAlias annotations
Mapping keys to partitions with PartitionKey annotations
Programming for transactions
Interacting with data in a transaction
Configuring and implementing locking in .NET applications
.NET exception handling for locking
Configuring data grid security for WebSphere eXtreme Scale Client for .NET
Configuring TLS for WebSphere eXtreme Scale Client for .NET
Programming client authentication for WebSphere eXtreme Scale Client for .NET
Example: Implementing a user password credential for .NET applications
Example: Implementing a user credential generator for .NET applications
Programming custom credentials for WebSphere eXtreme Scale Client for .NET
Monitoring
Monitoring the startup status of the appliance
Monitoring data grids in the user interface
Monitoring activities with tasks
Monitoring with the xscmd utility
Monitoring with CSV files
CSV file statistics definitions
Monitoring with the xsadmin utility
xsadmin utility reference
xsadmin tool to xscmd tool migration
Monitoring the health of the environment
Health monitoring overview
Viewing health event notifications in the message center
Viewing health notifications with the xscmd utility
Monitoring with SNMP
Enabling SNMP monitoring for your appliance
Configuring SNMP communities
Configuring SNMP trap subscribers
Managing SNMP trap subscriptions
SNMP trap reference
Configuring remote logging
Security
IBM WebSphere DataPower XC10 Appliance security overview
Configuring IBM WebSphere DataPower XC10 Appliance user interface security
Managing users and groups
Creating a user
Managing users
Removing a user
Registering a new user account
Creating a user group
Managing user groups
Removing a user group
User permissions
Enabling security for data grids
Configuring Transport Layer Security (TLS) for WebSphere Application Server
Configuring a data grid application to use client authentication
Configuring TLS for data grid applications
Configuring your appliance to authenticate users with an LDAP directory
REST security configuration
Troubleshooting
Troubleshooting and support for WebSphere DataPower XC10 Appliance
Techniques for troubleshooting problems
Searching knowledge bases
Getting fixes
Getting fixes from Fix Central
Contacting IBM Support
Gathering diagnostic information for IBM Support
Exchanging information with IBM
Subscribing to Support updates
Working with the WebSphere DataPower XC10 Appliance log files
Sending WebSphere DataPower XC10 Appliance log records to a remote UNIX system with syslog
Downloading auditing data
Analyzing log and trace data
Log analysis overview
Log files storage policy
Running log analysis
Creating custom scanners for log analysis
Troubleshooting log analysis
Monitoring the hardware temperatures
Monitoring your Ethernet interface status details with a serial connection
Verifying outbound connections from the appliance
Using the command line interface to run operations on your appliance
Troubleshooting deadlocks
Troubleshooting lock timeout exceptions for a multi-partition transaction
Resolving lock timeout exceptions
Troubleshooting cache integration
Troubleshooting installation
Troubleshooting administration
Release notes
Reference
xscmd utility reference
HTTP command interface reference
Client properties file
Regular expression syntax
Dynamic map configuration options
User interface settings
eXtreme Scale session management settings
Catalog service domain collection
Catalog service domain settings
Client security properties
Catalog service domain custom properties
Site map