SBLIM CIM Client - 1.3.9.3 - Public API Specification
The SBLIM CIM Client is a class library that provides access to CIM servers using the CIM Operations over HTTP protocol defined by the DMTF. The package contains an IETF RFC 2614 compliant SLP client for CIM service discovery.
Backward CompatibilityRun Time Requirements
Build Time Requirements
Getting Started
Related Documentation on the web
SBLIM Development Process Documentation
Documentation Conventions
Terminology
Backward Compatibility
The public API of the CIMinvalid input: '&SLP' Clients (see the tables above) will be downward compatible across minor version changes (i.e. when the second version number changes). There is no downward compatibility guarantee for the internal implementation packages for any version change.
Run Time Requirements
- SUN/IBM JRE 1.4.x/1.5.x or GCJ 4.1
Build Time Requirements
- SUN/IBM JDK 1.4.x/1.5.x or GCJ 4.1
- javadoc 1.4.2 or higher
- ant 1.6.2 or higher
Getting Started
- First steps
- Configuring the client.
- Getting started with secure connections.
- Getting started with indications.
Related Documentation on the web
- DMTF DSP0004:2005, CIM Infrastructure Specification, version 2.3 (final), available at:
http://www.dmtf.org/standards/published_documents/DSP0004V2.3_final.pdf - DMTF DSP0200:2005, CIM Operations over HTTP, version 1.2 (preliminary), available at:
http://www.dmtf.org/standards/published_documents/DSP200.pdf - DMTF DSP0201:2005, Representation of CIM in XML, version 2.2 (preliminary), available at:
http://www.dmtf.org/standards/published_documents/DSP201.pdf - IETF RFC 2614, An API for Service Location, available at:
http://tools.ietf.org/html/rfc2614 - IETF RFC 2608, Service Location Protocol, Version 2, available at:
http://tools.ietf.org/html/rfc2608 - IETF RFC 2609, Service Templates and Service: Schemes, available at:
http://tools.ietf.org/html/rfc2609 - IETF RFC 3224, Vendor Extensions for Service Location Protocol, Version 2, available at:
http://tools.ietf.org/html/rfc3224
SBLIM Development Process Documentation
see here
Documentation Conventions
- This documentation only describes public entities in the Java classes.
- It provides an API specification, not a comprehensive progamming 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. There may be additional exceptions
that are thrown by the JRE or underlying class libraries.
The specific exception
CIMException
contains a CIM status code. Method descriptions that listCIMException
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 classCIMException
. If the semantics used by the method differs from the standard semantics, this is described specifically in the method description.
Terminology
The following terminology is used in the documentation of the SBLIM CIM Client. As a DMTF Glossary document evolves, this terminology will be drawn from there, over time.
CIM object related terms
- CIM namespace
- Run-time container within a CIM server that can contain CIM classes, instances and qualifier declarations. For details, refer to the CIM Infrastructure Specification [DSP0004].
- CIM class
- A CIM class, as defined in the CIM Infrastructure Specification [DSP0004]. The term is used for all three kinds of CIM classes (normal, association and indication). The term is used both for the CIM class object in the CIM server/provider and for its client side copy.
- CIM instance
- An instance of a CIM class. The term is used both for the CIM instance object in the CIM server/provider and for its client side copy.
- CIM object
- A general term for either CIM class or CIM instance. Sometimes also includes CIM namespace in addition. Sometimes also includes the name (path) of the object.
- Normal CIM class
- A CIM class that is neither an association class nor an indication class.
- CIM association class
- A CIM class that has its Association qualifier effectively being true. Note that the Association qualifier is inherited into subclasses. Note that the Aggregation and Composition qualifiers may refine the semantics of an association class, but such classes still remain association classes.
- CIM indication class
- A CIM class that has its Indication qualifier effectively being true. Note that the Indication qualifier is inherited into subclasses.
- Local copy of a CIM object
- When a CIM object is returned to the CIM client, the data being returned is called a local copy of the CIM object.
- CIM object in the CIM server
- Refers to the "live" CIM object in the CIM server (or better in the provider). In the case of CIM instances, the live object represents an aspect of a real world resource, and manipulation of the CIM instance manipulates the real world resource.
Terms denoting specific kinds of CIM classes:
Phrases denoting whether the objects are the objects in the CIM server or their local copies:
Note: These phrases can be used with all the object related terms above.
CIM object naming related terms
- CIM object path
- General term for a reference to a CIM namespace, class or instance object in a CIM server. These object paths allow accessing the referenced CIM object in the CIM server. The term does not imply any particular scope at which the object path is unique. An alternative phrase used in DMTF documents is "CIM object name".
- CIM namespace path
- CIM object path referencing a CIM namespace object in a CIM server.
- CIM class path
- CIM object path referencing a CIM class object within a CIM namespace in a CIM server.
- CIM instance path
- CIM object path referencing a CIM instance object within a CIM namespace in a CIM server.
- Global CIM object path
- CIM object path using a reference that is globally unique (that is, across CIM servers). The object path identifies the host and port of the CIM server, the CIM namespace within the server, and the name of the object within the namespace.
- Intra-Server CIM object path
- CIM object path using a reference that is unique within a single CIM server. The object path does not identify the CIM server. It identifies the CIM namespace within a CIM server, and the name of the object within the namespace. An alternative phrase used in DMTF documents is "local object path".
- Intra-Namespace CIM object path
- CIM object path using a reference that is unique within a single CIM namespace. The object path does not identify the CIM server or namespace. It identifies the name of the object within the namespace. An alternative phrase used in DMTF documents is "model path", or "class name" for class objects and "instance name" for instance objects.
Terms for specific kinds of CIM object paths:
Phrases describing the uniqueness scope of object paths:
Note: These phrases can be used with all the path related terms above.
CIM class/instance member related terms
- Properties defined in a class
- The set of properties introduced in the class, or overidden in the class. This does not include any properties inherited from superclasses, or properties introduced or overridden in subclasses of the class.
- Properties defined in the class of an instance
- The set of properties defined in the class an instance has been created of.
- Properties of a class
- The set of properties effectively visible in the class, including any inherited properties. Overridden properties are contained in that set only once. Non-overridden properties with the same name are contained in that separately (This should be avoided, but it can happen in different classes, for instance when a superclass in a DMTF common schema adds a property that is already defined in a subclass that is a vendor extension class).
- Properties of an instance
- The set of properties effectively present in the instance.
Phrases defining the set of elements in a class or instance:
Note: These phrases are stated for properties but are equally valid for references and methods.
Other terms
- CIM element
- General term for CIM class (all kinds: normal, association, indication), property, reference, method, method parameter, qualifier, qualifier flavor or schema.
- CIM client protocol
- General term for a remote communications protocol between CIM client and CIM server. Note that this includes for instance any upcoming Web services protocol and the new SM-CLP, and is not restricted to CIM Operations over HTTP.
- CIM Operations over HTTP
- Name of the dominant CIM client protocol, specified in DMTF DSP0200 and DSP0201.
- CIM client
- General term for a component (usually a class library) used to communicate with a CIM server. Handlers for indication delivery or asynchronous operation responses are also considered part of a CIM client. Usually, a CIM client is used by a management application.
- SBLIM CIM Client
- Name of this specific CIM client.
- CIM server
- General term for a component (usually a demon) providing a service accessible through a CIM client protocol. A single CIM server instance may be used by multiple CIM client instances. In the course of handling the requests resulting from interactions with CIM clients, a CIM server interfaces with CIM providers for getting certain requests handled.
- CIM provider
- General term for a component implementing all behaviour that is specific to a particular CIM class. This means, CIM providers are the link between the CIM server and any interfaces specific to the real world resources. It is left open whether a single CIM provider can implement one or more CIM classes. A particular CIM provider API is not implied.
SessionProperties
.