Pegasus Enhancement Proposal (PEP)

PEP #: 278

Title: OpenPegasus 2.6 External Interface Definition

Version: 1.2

Created: 19 September 2006

Authors: Denise Eckstein

Status:  Approved

Version History:

Version Date Author Change Description
1.0 19 Sept 2006 Denise Eckstein Initial Submission based on  PEP#209 - OpenPegasus 2.5 External Interface PEP.
1.1 14 Dec 2006 Denise Eckstein
  • Updated references to PEP 279.
  • Per PEP 246 added the following to the OpenPegasus  2.6.0 External Interface Definition: Pegasus/Common/LanguageTag.h, Pegasus/Common/AcceptLanguageList.h, and Pegasus/Common/ContentLanguageList.h
  • Per Oct. 06, 2006 Architecture Team Discussion added cimreparchive and cimtrust to CLI External Interface Definition.
  • Per Oct. 37, 2006 Architecture Team Discussion added cimsub to CLI External Interface Definition.
  • 1.2 15 Dec Denise Eckstein
  • Removed the file Pegasus/Provider/CMPI/cmpi_cql.h.  Only EXPERIMENTAL interfaces are defined in this file. Therefore this file does not contribute to the OpenPegasus 2.6 External Interface definition and can be removed.
  • Approved - Ballot 128 - Dec. 22, 2006
  •  


    Abstract: This PEP provides THE list of the OpenPegasus 2.6 interfaces that are considered external and therefore "frozen". Unless an exception is explicitly approved by the Steering Committee all subsequent releases of Pegasus MUST continue to support these interfaces. Interfaces not explicitly listed in this document, should be considered as internal and subject to change.


    Definition of the Problem

    With each release, as new features mature and gain Community acceptance and old features age and lose value,  the OpenPegasus External Interface Definition needs to be reviewed.  The purpose of this PEP is to provide an OpenPegasus 2.6 timeframe forum for consideration and approval of any proposed changes (i.e., additions, modifications or deprecations) to the OpenPegasus External Interface Definition.

    Note: Support for forward-compatibility is a fundamental design principle for the OpenPegasus project.  As a Community, our goal is for well-behaved OpenPegasus Providers or Clients, using only the externally defined OpenPegasus interface, to continue to work with a minor version upgrade of OpenPegasus.  EXPERIMENTAL interfaces are not considered part of the OpenPegasus External Interface Definition.  Applications using either EXPERIMENTAL or internal interfaces should have no expectation of working in the next release.

    Note: PEP 279, OpenPegasus 2.6 SDK Packaging Definition, contains a description of the files included in the OpenPegasus 2.6 SDK release.  Although the content of the OpenPegasus 2.6 SDK is strongly influenced by the OpenPegasus 2.6 External Interface Definition, not all APIs included in PEP 279 are part of the External Interface Definition.  In addition, not all External Interfaces are included in the SDK.

    Proposed Solution

    2.0 External Interface Definitions

    2.1 OpenPegasus 2.6 C++ Interfaces

    2.1.1 Common

    2.1.2 Client

    2.1.3 Provider

    2.1.4 Consumer

    2.2 OpenPegasus 2.6 CMPI C Interfaces

    2.2.1 Provider

    2.2 Schema Definitions

    Only schema changes consistent with the DMTF definition of "minor" version changes are considered "backward compatible".

    2.2.1 CIM Schema (CIM_)

    As a statement of policy, the use of CIM_Schema is strongly encouraged and any use of CIM_ Schema MUST be DMTF compliant.

    2.2.2 Pegasus Schema (PG_)

    2.3 Command Line Interfaces

    2.4 Configuration Parameters

    References

    1. PEP#040 - Pegasus External Interface Definition (Approved,  March 2003)
    2. PEP#096 - Pegasus External Interface Definition (Draft, November 2003 )
    3. PEP#112 - Process for Deprecating Pegasus interfaces  (Approved, January 2004 )
    4. PEP#189 - OpenPegasus 2.4 External Interface Definition   (Approved, September 2004)
    5. PEP#209 - OpenPegasus 2.5 External Interface Definition (Approved, August 2005)
    6. PEP#210 - OpenPegasus 2.5 SDK Packaging Definition  (Approved, August 2005 )
    7. PEP #279 - OpenPegasus 2.6 SDK Packaging Definition

    Rationale

    Schedule

    Discussion


    Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
    EMC Corporation; Symantec Corporation; The Open Group.

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to
    deal in the Software without restriction, including without limitation the
    rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
    sell copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
    ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
    "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
    LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
    PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
    HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
    ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


    Template last modified: March 26th 2006 by Martin Kirk
    Template version: 1.11