pegasus/src/Pegasus/ControlProviders/InteropProvider/InteropProvider.h - diff

Return to InteropProvider.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / ControlProviders / InteropProvider

Diff for /pegasus/src/Pegasus/ControlProviders/InteropProvider/InteropProvider.h between version 1.12 and 1.43

version 1.12, 2005/05/25 16:25:41

version 1.43, 2013/04/09 05:53:14

Line 1

//%2005////////////////////////////////////////////////////////////////////////

//%LICENSE////////////////////////////////////////////////////////////////

// Licensed to The Open Group (TOG) under one or more contributor license

// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.

// agreements. Refer to the OpenPegasusNOTICE.txt file distributed with

// this work for additional information regarding copyright ownership.

// IBM Corp.; EMC Corporation, The Open Group.

// Each contributor licenses this file to you under the OpenPegasus Open

// Source License; you may not use this file except in compliance with the

// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.

// License.

// EMC Corporation; VERITAS Software Corporation; The Open Group.

// Permission is hereby granted, free of charge, to any person obtaining a copy

// Permission is hereby granted, free of charge, to any person obtaining a

// of this software and associated documentation files (the "Software"), to

// copy of this software and associated documentation files (the "Software"),

// deal in the Software without restriction, including without limitation the

// to deal in the Software without restriction, including without limitation

// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

// the rights to use, copy, modify, merge, publish, distribute, sublicense,

// sell copies of the Software, and to permit persons to whom the Software is

// and/or sell copies of the Software, and to permit persons to whom the

// furnished to do so, subject to the following conditions:

// Software is furnished to do so, subject to the following conditions:

// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN

// The above copyright notice and this permission notice shall be included

// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED

// in all copies or substantial portions of the Software.

// "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.

//==============================================================================

// 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: Karl Schopmeyer (k.schopmeyer@opengrooup.org)

//////////////////////////////////////////////////////////////////////////

// Modified By:

//%////////////////////////////////////////////////////////////////////////////

#ifndef InteropProvider_h

Line 58

Line 52

#include <Pegasus/Repository/CIMRepository.h>

#include <Pegasus/Provider/CIMInstanceProvider.h>

#include <Pegasus/Provider/CIMAssociationProvider.h>

#include <Pegasus/Provider/CIMMethodProvider.h>

#include <Pegasus/General/VersionUtil.h>

#include \

PEGASUS_NAMESPACE_BEGIN

/**

The InteropProvider provides information and manipulates the

* The InteropProvider services the Interop classes of the DMTF CIM Schema

following classes from the DMTF CIM_Interop schema:

* in the root/PG_InterOp namespace (as well as some related cross-namespace

CIM_Namespace - Creation and deletion of namespaces

* associations in other namespaces). Through this implementation, combined

Note: Effective Pegasus 2.4, it processes PG_Namespace

* with the SLP provider and one or more vendor-supplied SMI providers, the

__Namespace - Creation and deletion of namespaces (deprecated)

* Pegasus WBEM Server is able to provide a fully-functional implementation of

CIM_ObjectManager - Reports on the status of the object manager

* the SMI-S Server profile (currently, version 1.1.0).

CIM_ObjectManagerCommunicationMechanism - Reports on CIMOM communications

COM_CIMXMLCommunicationMechanism - Reports on CIMXML communications

* The following is a list of the association and instance classes supported

CIM_ProtocolAdapter

* by this provider in the root/PG_InterOp namespace:

Associations

* PG_CIMXMLCommunicationMechanism (CIM_CIMXMLCommunicationMechanism)

NamespaceinManager

* PG_CommMechanismForManager (CIM_CommMechanismForManager)

* PG_ComputerSystem (CIM_ComputerSystem)

creation and deletion of namespaces using the __namespace class

* PG_ElementConformsToProfile (CIM_ElementConformsToProfile)

Note however, that the DMTF specification model does not define a class for

* PG_ElementSoftwareIdentity (CIM_ElementSoftwareIdentity)

__namespace so that it is, a "false" class. We assume that it has the

* PG_HostedAccessPoint (CIM_HostedAccessPoint)

same characteristics as the CIM_namespace class defined in CIM 2.6.

* PG_HostedObjectManager (CIM_HostedService)

* PG_InstalledSoftwareIdentity (CIM_InstalledSoftwareIdentity)

This provider implements the following functions:

* PG_Namespace (CIM_Namespace)

- createInstance ( adds a new namespace to the repository)

* PG_NamespaceInManager (CIM_NamespaceInManager)

- getInstance ( Gets one instance containing a namespace name)

* PG_ObjectManager (CIM_ObjectManager)

- modifyInstance ( Limited Support)

* PG_ReferencedProfile (CIM_ReferencedProfile)

- enumerateInstances ( Lists all namespaces as Instances)

* PG_RegisteredProfile (CIM_RegisteredProfile)

- enumerateInstanceNames ( Lists all namespace names )

* PG_RegisteredSubProfile (CIM_RegisteredSubProfile)

TBD

* PG_SoftwareIdentity (CIM_SoftwareIdentity)

* PG_SubProfileRequiredProfile (CIM_SubProfileRequiresProfile)

typedef Array<CIMName> CIMNameArray;

typedef Array<CIMNamespaceName> CIMNamespaceArray;

class PEGASUS_INTEROPPROVIDER_LINKAGE InteropProvider :

public CIMInstanceProvider, public CIMAssociationProvider

public CIMInstanceProvider,

public CIMAssociationProvider,

public CIMMethodProvider

{

public:

InteropProvider(CIMRepository* repository);

InteropProvider(

CIMRepository* repository,

ProviderRegistrationManager* provRegManager);

virtual ~InteropProvider()

{

PEG_METHOD_ENTER(TRC_CONTROLPROVIDER,"InteropProvider::~InteropProvider");

PEG_METHOD_ENTER(TRC_CONTROLPROVIDER,

"InteropProvider::~InteropProvider");

PEG_METHOD_EXIT();

}

// Note: The initialize() and terminate() methods are not called for

// Control Providers.

void initialize(CIMOMHandle& handle) { }

void terminate() { }

virtual void createInstance(

const OperationContext & context,

const CIMObjectPath & instanceReference,

Line 142

Line 156

const CIMObjectPath & classReference,

ObjectPathResponseHandler & handler);

// Association Interfaces

// CIMAssociationProvider interface

virtual void associators(

Line 183

Line 196

const String & role,

ObjectPathResponseHandler & handler);

/**

// CIMMethodProvider interface

Standard initialization function for the provider.

virtual void invokeMethod(

const OperationContext & context,

void initialize(CIMOMHandle& cimomHandle)

const CIMObjectPath & objectReference,

{

const CIMName & methodName,

}

const Array<CIMParamValue> & inParameters,

MethodResultResponseHandler & handler);

void terminate(void)

{

// delete self. this is necessary because the entry point for this object allocated it, and

// the module is responsible for its memory management.

delete this;

}

private:

void initProvider();

CIMInstance _buildInstanceSkeleton(

CIMInstance buildInstanceSkeleton(

const CIMObjectPath & objectPath,

const CIMNamespaceName & nameSpace,

const CIMName& className);

CIMObjectPath _buildReference(

const CIMObjectPath& objectPath,

const CIMInstance& instance,

const CIMName& className);

CIMObjectPath _buildObjectPath(

const CIMObjectPath& objectPath,

const CIMName& className,

const CIMInstance& instance);

CIMObjectPath _buildInstancePath(

const CIMObjectPath& objectPath,

const CIMName& className,

const CIMInstance& instance);

Boolean includeQualifiers,

CIMClass& returnedClass);

CIMClass _getClass(const CIMObjectPath& objectPath,

const CIMName& className);

Array<CIMNamespaceName> _enumerateNameSpaces();

CIMInstance _buildInstancePGCIMXMLCommunicationMechanism(

CIMInstance buildCIMXMLCommunicationMechanismInstance(

const CIMObjectPath& objectPath,

const String& namespaceType,

const Uint16& accessProtocol,

const String& IPAddress,

const Boolean& includeQualifiers,

const CIMClass & commMechClass);

const Boolean& includeClassOrigin,

const CIMPropertyList& propertyList);

Array<CIMInstance> _buildInstancesPGCIMXMLCommunicationMechanism(

Array<CIMInstance> enumCIMXMLCommunicationMechanismInstances();

const CIMObjectPath& objectPath,

const Boolean includeQualifiers,

const Boolean includeClassOrigin,

const CIMPropertyList& propertyList);

CIMInstance _getInstanceCIMObjectManager(

Array<CIMInstance> enumHostedAccessPointInstances(

const CIMObjectPath& objectPath,

const OperationContext &opContext);

const Boolean includeQualifiers,

const Boolean includeClassOrigin,

const CIMPropertyList& propertyList);

Array<CIMInstance> _getInstancesCIMNamespace(

CIMInstance getObjectManagerInstance();

const CIMObjectPath& objectPath,

const Boolean& includeQualifiers,

const Boolean& includeClassOrigin,

const CIMPropertyList& propertyList);

CIMInstance getComputerSystemInstance(const OperationContext &opContext);

CIMInstance _getInstanceCIMNamespace(

CIMInstance getHostedObjectManagerInstance(

const CIMObjectPath& objectPath);

const OperationContext &opContext);

CIMInstance _buildInstancePGNamespace(

const CIMObjectPath& objectPath,

CIMNamespaceName& nameSpace);

Array<CIMInstance> _buildInstancesNamespaceInManager(

Array<CIMInstance> enumNamespaceInstances();

const CIMObjectPath& objectPath);

Array<CIMInstance> _buildInstancesCommMechanismForManager(

CIMInstance buildNamespaceInstance(const String & nameSpace);

const CIMObjectPath& objectPath);

CIMInstance getNameSpaceInstance(const CIMObjectPath & ref);

Boolean _getInstanceFromRepositoryCIMObjectManager(

CIMObjectPath createNamespace(const CIMInstance & namespaceInstance);

const CIMObjectPath& objectPath,

void deleteNamespace(const CIMObjectPath & instanceName);

CIMInstance& rtnInstance,

const Boolean includeQualifiers,

CIMObjectPath createProviderProfileCapabilityInstance(

const Boolean includeClassOrigin,

const CIMInstance & profileInstance,

const CIMPropertyList& propertyList);

const OperationContext & context);

void deleteProviderProfileCapabilityInstance(

const CIMObjectPath & instanceName,

const OperationContext & context);

Array<CIMInstance> enumNamespaceInManagerInstances();

Array<CIMInstance> enumCommMechanismForManagerInstances();

void modifyObjectManagerInstance(const OperationContext & context,

const CIMObjectPath & instanceReference,

const CIMInstance& modifiedIns,

const Boolean includeQualifiers,

const CIMPropertyList& propertyList,

const CIMPropertyList& propertyList);

ResponseHandler & handler);

void extractSoftwareIdentityInfo(

const CIMInstance & providerInstance,

String & moduleName,

String & providerName,

String & version,

String & vendor,

Uint16 & majorVersion,

Uint16 & minorVersion,

Uint16 & revision,

Uint16 & build,

bool & extendedVersionSupplied,

String & interfaceType,

String & elementName,

String & caption);

Array<CIMInstance> enumRegisteredProfileInstances();

Array<CIMInstance> enumRegisteredSubProfileInstances();

Array<CIMInstance> enumReferencedProfileInstances();

Array<CIMInstance> getProfilesForVersion(

Array<CIMInstance>& subprofs,

Uint16 regOrg,

Uint32 majorVer,

Uint32 minorVer,

Uint32 updateVer);

Array<CIMInstance> enumElementConformsToProfileInstances(

const OperationContext & opContext,

const CIMNamespaceName & opNamespace);

Array<CIMInstance> enumElementConformsToProfileRPRPInstances(

const OperationContext & opContext,

const CIMNamespaceName & opNamespace);

Array<CIMInstance> enumSubProfileRequiresProfileInstances();

Array<CIMInstance> enumSoftwareIdentityInstances();

Array<CIMInstance> enumElementSoftwareIdentityInstances();

Array<CIMInstance> enumInstalledSoftwareIdentityInstances(

const OperationContext &opContext);

Array<CIMInstance> enumDefaultSoftwareIdentityInstances();

CIMInstance getSoftwareIdentityInstance(

const CIMObjectPath &ref);

Array<CIMInstance> enumProviderProfileCapabilityInstances(

Boolean checkProviders = true,

Boolean includeQualifiers = false,

Boolean includeClassOrigin = false,

const CIMPropertyList &propertyList = CIMPropertyList());

#ifdef PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT

Array<CIMInstance> enumIndicationServiceInstances(

const OperationContext &opContext);

Array<CIMInstance> enumElementCapabilityInstances(

const OperationContext & opContext);

Array<CIMInstance> enumHostedIndicationServiceInstances(

const OperationContext & opContext);

Array<CIMInstance> enumServiceAffectsElementInstances(

const OperationContext & opContext);

CIMInstance buildAssociationInstance(

const CIMName &className,

const CIMName &propName1,

const CIMObjectPath &objPath1,

const CIMName &propName2,

const CIMObjectPath &objPath2);

#endif

CIMInstance buildRegisteredProfile(

const String & instanceId,

const String & profileName,

const String & profileVersion,

Uint16 profileOrganization,

const String & otherProfileOrganization,

const CIMClass & profileClass);

CIMInstance buildDependencyInstance(

const String & antecedentId,

const CIMName & antecedentClass,

const String & dependentId,

const CIMName & dependentClass,

const CIMClass & dependencyClass);

CIMInstance buildSoftwareIdentity(

const String & module,

const String & provider,

const String & vendor,

const String & version,

Uint16 majorVersion,

Uint16 minorVersion,

Uint16 revisionNumber,

Uint16 buildNumber,

bool extendedVersionSupplied,

const String & interfaceType,

const String & elementName,

const String & caption);

Array<CIMInstance> getProfileInstances(

const CIMName & profileType,

const Array<String> & defaultSniaProfiles);

Array<CIMInstance> getDMTFProfileInstances(

const CIMName & profileType);

// The following are internal equivalents of the operations

// allowing the operations to call one another internally within

// the provider.

Array<CIMInstance> localEnumerateInstances(

const OperationContext & context,

const CIMObjectPath & ref,

const CIMPropertyList& propertyList=CIMPropertyList());

Array<CIMInstance> localReferences(

const OperationContext & context,

const CIMObjectPath & objectName,

const CIMName & resultClass,

String & originRole,

String & targetRole,

const CIMPropertyList & propertyList=CIMPropertyList(),

const CIMName & targetClass=CIMName());

CIMInstance localGetInstance(

const OperationContext & context,

const CIMObjectPath & instanceName,

const CIMPropertyList & propertyList);

// This function fetches the other side of the reference.

Array<CIMInstance> getReferencedInstances(

const Array<CIMInstance> &refs,

const String &targetRole,

const OperationContext & context,

const CIMPropertyList & propertyList);

void cacheProfileRegistrationInfo();

void verifyCachedInfo();

void initializeNamespaces();

bool validAssocClassForObject(

const OperationContext & context,

const CIMName & assocClass, const CIMObjectPath & objectName,

const CIMNamespaceName & opNamespace,

String & originProperty, String & targetProperty);

#ifdef PEGASUS_ENABLE_SLP

void sendUpdateRegMessageToSLPProvider(

const OperationContext & context);

#endif

// Repository Instance variable

CIMOMHandle cimomHandle;

CIMRepository* _repository;

CIMRepository * repository;

ProviderRegistrationManager *providerRegistrationManager;

String objectManagerName;

String hostName;

CIMClass profileCapabilitiesClass;

CIMClass softwareIdentityClass;

Array<Uint16> providerClassifications;

Mutex interopMut;

bool providerInitialized;

AtomicInt updateProfileCache;

// Registration info to cache

Array<String> profileIds;

Array<CIMNameArray> conformingElements;

Array<CIMNamespaceArray> elementNamespaces;

Boolean enableSLP;

String httpPort;

String httpsPort;

// Cached CIM_ObjectManager instance.

CIMInstance _CIMObjectManagerInst;

};

PEGASUS_NAMESPACE_END

Legend:

Removed from v.1.12
changed lines
	Added in v.1.43

No CVS admin address has been configured