SBLIM CIM Client for Java - 2.2.5 - Public API Specification

The SBLIM CIM Client for Java is a JSR48 compliant implementation of a WBEM services client that includes an IETF RFC 2614 compliant SLP client for CIM service discovery.

Getting Started Documents

Deep dive documents

Run Time Requirements

We support JREs from IBM and SUN release 1.5.x/1.6.x/1.7.x. In principal it should run on any platform offering a supported JRE. The library is tested on Windows on x86 systems and on Linux on x86 and POWER systems. Our exploiters operate it with success on zLinux and AIX.

Build Time Requirements

Backward Compatibility

We try to keep the public API of the CIM/WBEM invalid input: '&' SLP Clients (see the tables above) downward compatible. However this will not always be possible. Compatibility violations will be documented. A rule of thumb is:

  • Maintenance releases (a.b.c.++d) keep API unchanged. They include only hand-selected bug fixes.
  • Point releases (a.b.++c.d) keep API backward compatible. They include bug-fixes and functional enhancements.
  • Minor releases (a.++b.c.d) might deprecate API and drop API already deprecated. They include remarkable new functionality.
  • Major releases (++a.b.c.d) might do a disruptive API change. A major release usually comes with a larger redesign or adapts to a disruptive upgrade of an underlying standard.
There is no downward compatibility guarantee for the internal implementation packages for any version change.

Known Limitations

  • All known limitations have been resolved.

Bugs

If you discover any bugs in the SBLIM CIM Client for Java you can report them on SourceForge. Choose "jsr48-client" as Component in Bug Tickets.

Documentation Conventions

  • This documentation only describes public entities in the Java classes.
  • It provides an API specification, not a comprehensive programming guide.
  • It is written from a perspective of the consumer of the API. For example, the phrase "must" is used to indicate an obligation of the consumer, not of the implementor of the CIM Client class library, or the CIM server/provider.
  • If preconditions stated in method descriptions are not satisfied, Java exceptions should be expected to be thrown. Note that satisfying the preconditions does not guarantee that no exceptions are thrown (for example, unsuccessful CIM status codes returned by the CIM server may result in Java exceptions, plus there are some exceptions that can always be thrown such as NullPointerException).
  • Method descriptions list all Java exceptions that are explicitly thrown by the code of the SBLIM CIM Client for Java. There may be additional exceptions that are thrown by the JRE or underlying class libraries.

    The specific exception WBEMException contains a CIM status code. Method descriptions that list WBEMException list the CIM status code identifiers that can happen. If these identifiers are just listed without further description, their semantics is the standard semantics as documented in class WBEMException. If the semantics used by the method differs from the standard semantics, this is described specifically in the method description.

SBLIM Development Guidelines

See here.

Terminology Document

See here.

Package
Description
Provides classes and interfaces for handling the CIM (Common Information Model) Object Model and CIM Data Types as defined in the CIM Infrastructure Specification.
Provides classes and interfaces that are common across all WBEM APIs.
Provides classes and interfaces for writing WBEM Clients.
Provides classes and interfaces for writing WBEM Listeners.
Provides classes and interfaces for SBLIM extensions to JSR48.
Provides classes and interfaces for WBEM services discovery via SLP.
Internal helper classes for the CIM data classes.
Internal cim-xml DOM parser invalid input: '&' builder implementation.
Internal implementation of the SAX parser for cim-xml.
Internal implementation of the SAX parser for cim-xml.
This package and the subpackages contain the internal implementation of the SBLIM CIM Client for Java.
Internal implementation of HTTP client and server.
Internal implementation of HTTP streams.
Internal implementation of the logging invalid input: '&' messaging framework.
Internal implementation of the XML pull parser.
Internal implementation of WBEM-URI strings parsers as defined in the CIM Infrastructure Specification.
Internal utility classes, such as constants, defaults, configuration and others.
Internal implemenation of the interfaces from the javax.wbem package.
Internal implemenation of the indication processing.
Internal implemenation of WBEM batch operations.
This package contains the external API of the SLP library.
Internal implementation of the SLP library.