#2631 CR30: Deprecate non-pull methods with equivalents

closed-wont-fix
Dave Blaschke
jsr48-client
4
2013-12-11
2013-04-30
Dave Blaschke
No

Background/Rationale

The group agree don the last call to deprecate all operations that have pull equivalents. The list of operations are

EnumerateInstances
EnumerateInstanceNames
ExecQuery

The following are overloaded operations and will be deprecated for instance use only

Associators
AssociatorNames
References
ReferenceNames

Requested Change

1) Add "(Deprecated)" to the end of the name of each of the following operations (this will also update the table of contents).

EnumerateInstances
EnumerateInstanceNames
ExecQuery

2) Add the following immediately under the method signature of EnumerateInstances
DEPRECATION NOTE: The use of the EnumerateInstances method is deprecated. The replacement method is OpenEnumerateInstances

3)Add the following immediately under the method signature of EnumerateInstanceNames

DEPRECATION NOTE: The use of the EnumerateInstanceNames method is deprecated. The replacement method is OpenEnumerateInstancePaths

4) Add the following immediately under the method signature of ExecQuery

DEPRECATION NOTE: The use of the ExecQuery method is deprecated. The replacement method is OpenQueryInstances

5) Add the following immediately under the method signature of Associators and add "(Deprecated for instances)" after the title

DEPRECATION NOTE: The use of the Associators method for instances is deprecated. The replacement method is OpenAssociatorInstances

6) Add the following immediately under the method signature of AssociatorNames and add "(Deprecated for instances)" after the title

DEPRECATION NOTE: The use of the AssociatorNames method for instances is deprecated. The replacement method is OpenAssociatorInstancePaths

7) Add the following immediately under the method signature of References and add "(Deprecated for instances)" after the title

DEPRECATION NOTE: The use of the References method for instances is deprecated. The replacement method is OpenReferenceInstances

8) Add the following immediately under the method signature of ReferenceNames and add "(Deprecated for instances)" after the title

DEPRECATION NOTE: The use of the ReferenceNames method for instances is deprecated. The replacement method is OpenReferenceInstancePaths

Discussion

  • Dave Blaschke
    Dave Blaschke
    2013-04-30

    DSP0200 1.4.0a-rc1 was published yesterday, the net of the CR30 changes is that the WBEMClient APIs on the left should be deprecated with users switching to the APIs on the right:

    CloseableIterator<CIMInstance> enumerateInstances() ==> EnumerateResponse<CIMInstance> enumerateInstances()
    CloseableIterator<CIMObjectPath> enumerateInstanceNames() ==> EnumerateResponse<CIMObjectPath> enumerateInstancePaths()
    CloseableIterator<CIMInstance> execQuery() ==> EnumerateResponse<CIMInstance> execQueryInstances()
    CloseableIterator<CIMInstance> associatorInstances() ==> EnumerateResponse<CIMInstance> associators()
    CloseableIterator<CIMObjectPath> associatorNames() ==> EnumerateResponse<CIMObjectPath> associatorPaths()
    CloseableIterator<CIMInstance> referenceInstances() ==> EnumerateResponse<CIMInstance> references()
    CloseableIterator<CIMObjectPath> referenceNames() ==> EnumerateResponse<CIMObjectPath> referencePaths()
    

    This will have to be reflected in an updated JSR48 spec before being incorporated in the Java CIM Client.

     
  • Dave Blaschke
    Dave Blaschke
    2013-05-09

    • Priority: 5 --> 4
     
  • Dave Blaschke
    Dave Blaschke
    2013-05-09

    Lowering priority one notch below normal, this bug is dependent on DMTF CIM-XML changes

     
  • Dave Blaschke
    Dave Blaschke
    2013-09-19

    • labels: --> Java Client (JSR48)
     
  • Dave Blaschke
    Dave Blaschke
    2013-10-17

    This should be a document change only (WBEMClient javadoc), the deprecations are "just a statement that they may go away in cimv3" but the APIs will remain in CIMv2. Will wait to see how the JSR48 update addresses this issue.

     
    Last edit: Dave Blaschke 2013-10-17
  • Dave Blaschke
    Dave Blaschke
    2013-12-11

    • status: open --> closed-wont-fix
     
  • Dave Blaschke
    Dave Blaschke
    2013-12-11

    The latest (and supposedly final) version of JSR48 1.0.0 javadoc (dated Dec 10, 2013) does not address any of these deprecations. Because the methods will not be deprecated in CIMv2, which is the only version of CIM the Java CIM Client supports, this bug is being returned as "won't fix" since it does not apply.

    It should also be noted that, as of this date, OpenPegasus and sfcb do NOT support the pull operations, so the only operations they do support are those listed as being deprecated. Can't happen.