cimmanagedclient.h

Pegasus is an open-source implementationof the DMTF CIM and WBEM standards. It is designed to be por

//%2006////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
// IBM Corp.; EMC Corporation, The Open Group.
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
// EMC Corporation; VERITAS Software Corporation; The Open Group.
// 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.
//
//==============================================================================
//
// Author: Mike Brasher ([e-mail])
//         Marek Szermutzky ([e-mail]) PEP#139 Stage2
//
// Modified By: Nitin Upasani, Hewlett-Packard Company ([e-mail])
//              Yi Zhou, Hewlett-Packard Company ([e-mail])
//              Nag Boranna, Hewlett-Packard Company ([e-mail])
//              Roger Kumpf, Hewlett-Packard Company ([e-mail])
//              Carol Ann Krug Graves, Hewlett-Packard Company
//                  ([e-mail])
//              Jair Santos, Hewlett-Packard Company ([e-mail])
//              David Dillard, VERITAS Software Corp.
//                  ([e-mail])
//
//%/////////////////////////////////////////////////////////////////////////////
#ifndef Pegasus_CIMManagedClient_h
#define Pegasus_CIMManagedClient_h

#include "CIMClientConnectionManager.h"

// #define CDEBUG(X) PEGASUS_STD(cout) << "CIMManagedClient:" << X << PEGASUS_STD(endl)
#define CDEBUG(X);

PEGASUS_NAMESPACE_BEGIN

class PEGASUS_CLIENT_LINKAGE CIMManagedClient
{

public:

    // class constructor
    CIMManagedClient();

    CIMManagedClient(CIMClientConnectionManager* cccm);

    void setConnectionManager(CIMClientConnectionManager* cccm);
    CIMClientConnectionManager* getConnectionManager(void);

    // virtual class destructor has to be implemented by specific implementation
    ~CIMManagedClient();

#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES
// l10n start
    /** Sets the accept languages that will be used on the next request.
        Accept languages are the preferred languages that are to be
        returned on the response to the next request.
        @param host - input parameter, string containing hostname of CIMOM
        @param port - input parameter, string containing port of CIMOM
        @param langs - REVIEWERS: Complete this
    */
    void setRequestAcceptLanguages(
        const String& host,
        const String& port,
        const AcceptLanguageList& langs
    );

    /** Gets the accept languages that will be used on the next request.
        Accept languages are the preferred languages that are to be
        returned on the response to the next request.
        @param host - input parameter, string containing hostname of CIMOM
        @param port - input parameter, string containing port of CIMOM
    */
    AcceptLanguageList getRequestAcceptLanguages(
        const String& host,
        const String& port
    ) const;

    /** Sets the content languages that will be used on the next request.
        These content languages are the languages of the CIM objects that will
        sent on the next request.
        @param host - input parameter, string containing hostname of CIMOM
        @param port - input parameter, string containing port of CIMOM
        @param langs REVIEWERS: Complete this
    */
    void setRequestContentLanguages(
        const String& host,
        const String& port,
        const ContentLanguageList& langs
    );

    /** Gets the content languages that will be used on the next request.
      * These content languages are the languages of the CIM objects that will
      * sent on the next request.
        @param host - input parameter, string containing hostname of CIMOM
        @param port - input parameter, string containing port of CIMOM
    */
    ContentLanguageList getRequestContentLanguages(
        const String& host,
        const String& port
    ) const;

    /** Gets the content languages of the last response.
      * These content languages are the languages of the CIM objects, or
      * CIM exceptions, that were returned on the last response..
        @param host - input parameter, string containing hostname of CIMOM
        @param port - input parameter, string containing port of CIMOM
    */
    ContentLanguageList getResponseContentLanguages(
        const String& host,
        const String& port
    ) const;

    /** REVIEWERS: Complete this
     *
        @param host - input parameter, string containing hostname of CIMOM
        @param port - input parameter, string containing port of CIMOM
    */
    void setRequestDefaultLanguages(
        const String& host,
        const String& port
    );
// l10n end
#endif // PEGASUS_USE_EXPERIMENTAL_INTERFACES


    /** The <TT>enumerateInstanceNames</TT> operation enumerates the
    names (model paths) of the instances of a CIM Class in the target Namespace.

    @param host - input parameter, string containing hostname of CIMOM
    @param port - input parameter, string containing port of CIMOM
    @param nameSpace The nameSpace parameter is a string that defines the target
    namespace. See defintion of
    \URL[Namespace]{DefinitionofTerms.html#NAMESPACE}.
    @param className The <TT>className</TT> input parameter defines the Class
    that is the basis for the enumeration.
    @return If successful, the method returns zero or more names of Instances
    (model paths) that meet the requested criteria.
    If unsuccessful, one of the following status codes MUST be returned by this
    method, where the first applicable error in the list (starting with the
    first element of the list, and working down) is the error returned. Any
    additional method-specific interpretation of the error in is given in
    parentheses.

    <UL>
      <LI>CIM_ERR_ACCESS_DENIED
      <LI>CIM_ERR_NOT_SUPPORTED
      <LI>CIM_ERR_INVALID_NAMESPACE
      <LI>CIM_ERR_INVALID_PARAMETER (including missing,
      duplicate, unrecognized or otherwise incorrect parameters)
      <LI>CIM_ERR_INVALID_CLASS (the CIM Class that is the
      basis for this enumeration does not exist)
      <LI>CIM_ERR_FAILED (some other unspecified error occurred)</LI>
     </UL>
    */
    Array<CIMObjectPath> enumerateInstanceNames(
        const String& host,
        const String& port,
        const CIMNamespaceName& nameSpace,
        const CIMName& className
    );

    /** The <TT>enumerateInstances</TT> method enumerates instances of a CIM
    Class in the target Namespace.

    @param host - input parameter, string containing hostname of CIMOM

    @param port - input parameter, string containing port of CIMOM

    @param nameSpace The nameSpace parameter is a string that defines the target
    namespace. See defintion of
    \URL[Namespace]{DefinitionofTerms.html#NAMESPACE}.

    @param className The <TT>className</TT> input parameter defines the
    Class that is the basis for the enumeration.

    @param localOnly If the <TT>localOnly</TT> input parameter is
    <TT>true</TT>, this specifies that, for each returned Instance,
    only elements (properties and qualifiers) overriden within the
    definition of that Instance are included.  If <TT>false</TT>,
    all elements are returned.  This parameter therefore effects a CIM
    Server-side mechanism to filter certain elements of the returned object
    based on whether or not they have been propagated from the parent
    Class (as defined by the <TT>PROPAGATED</TT> attribute).

    Only elements (properties, methods and qualifiers) defined or
    overridden within the class are included in the response. Propagated
    properties are not included because their values are based on another class