Class CIMClientXML_HelperImpl

java.lang.Object
org.sblim.cimclient.internal.cimxml.CIMClientXML_HelperImpl

public class CIMClientXML_HelperImpl extends Object
Class CIMClientXML_HelperImpl is responsible for building CIM-XML requests and responses.
  • Constructor Details

  • Method Details

    • getDocumentBuilder

      public DocumentBuilder getDocumentBuilder()
      getDocumentBuilder
      Returns:
      DocumentBuilder
    • newDocument

      public Document newDocument()
      newDocument
      Returns:
      Document
    • parse

      public Document parse(InputSource pIS) throws IOException, SAXException
      parse
      Parameters:
      pIS -
      Returns:
      Document
      Throws:
      IOException
      SAXException
    • serialize

      public static void serialize(OutputStream pOS, Document pDoc) throws IOException
      Serializes a given DOM document as (CIM-)XML to a given output stream
      Parameters:
      pOS - The output stream
      pDoc - The documents
      Throws:
      IOException - Whenever something goes wrong
    • dumpDocument

      public static void dumpDocument(OutputStream pOS, Document pDoc) throws IOException
      Serializes a given DOM document as (CIM-)XML to a given output stream. The document is pretty wrapped and indented and surrounded with markers for the begin and end.
      Parameters:
      pOS - The output stream
      pDoc - The documents
      Throws:
      IOException
    • dumpDocument

      public static void dumpDocument(OutputStream pOS, Document pDoc, String pOrigin) throws IOException
      Serializes a given DOM document as (CIM-)XML to a given output stream. The document is pretty wrapped and indented and surrounded with markers for the begin and end.
      Parameters:
      pOS - The output stream
      pDoc - The documents
      pOrigin - The origin of the output stream (request, indication response, etc.)
      Throws:
      IOException
    • createCIMMessage

      public Element createCIMMessage(Document pDoc, Element pRequestE)
      createCIMMessage
      Parameters:
      pDoc -
      pRequestE -
      Returns:
      Element
    • createMultiReq

      public Element createMultiReq(Document pDoc)
      createMultiReq
      Parameters:
      pDoc -
      Returns:
      Element
    • associatorNames_request

      public Element associatorNames_request(Document pDoc, CIMObjectPath pObjectName, String pAssocClass, String pResultClass, String pRole, String pResultRole) throws WBEMException
      associatorNames_request
      Parameters:
      pDoc -
      pObjectName -
      pAssocClass -
      pResultClass -
      pRole -
      pResultRole -
      Returns:
      Element
      Throws:
      WBEMException
    • associatorNames_response

      public static Element associatorNames_response(Document pDoc, CIMObjectPath[] pPathA)
      associatorNames_response
      Parameters:
      pDoc -
      pPathA -
      Returns:
      Element
    • associatorInstances_request

      public Element associatorInstances_request(Document pDoc, CIMObjectPath pObjectName, String pAssocClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
      associatorInstances_request
      Parameters:
      pDoc -
      pObjectName -
      pAssocClass -
      pResultClass -
      pRole -
      pResultRole -
      pIncludeClassOrigin -
      pPropertyList -
      Returns:
      Element
      Throws:
      WBEMException
    • associatorClasses_request

      public Element associatorClasses_request(Document pDoc, CIMObjectPath pObjectName, String pAssocClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
      associatorClasses_request
      Parameters:
      pDoc -
      pObjectName -
      pAssocClass -
      pResultClass -
      pRole -
      pResultRole -
      pIncludeQualifiers -
      pIncludeClassOrigin -
      pPropertyList -
      Returns:
      Element
      Throws:
      WBEMException
    • associators_request

      public Element associators_request(Document pDoc, CIMObjectPath pObjectName, String pAssocClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
      associators_request
      Parameters:
      pDoc -
      pObjectName -
      pAssocClass -
      pResultClass -
      pRole -
      pResultRole -
      pIncludeQualifiers -
      pIncludeClassOrigin -
      pPropertyList -
      Returns:
      Element
      Throws:
      WBEMException
    • associators_response

      public static Element associators_response(Document pDoc, CIMNamedElementInterface[] pNamedElementA)
      associators_response
      Parameters:
      pDoc -
      pNamedElementA -
      Returns:
      Element
    • enumerateInstanceNames_request

      public Element enumerateInstanceNames_request(Document pDoc, CIMObjectPath pPath) throws WBEMException
      enumerateInstanceNames_request
      Parameters:
      pDoc -
      pPath -
      Returns:
      Element
      Throws:
      WBEMException
    • enumerateInstances_request

      public Element enumerateInstances_request(Document pDoc, CIMObjectPath pPath, boolean pDeepInheritance, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
      enumerateInstances_request
      Parameters:
      pDoc -
      pPath -
      pDeepInheritance -
      pLocalOnly -
      pIncludeQualifiers -
      pIncludeClassOrigin -
      pPropertyList -
      Returns:
      Element
      Throws:
      WBEMException
    • getInstance_request

      public Element getInstance_request(Document pDoc, CIMObjectPath pName, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
      getInstance_request
      Parameters:
      pDoc -
      pName -
      pLocalOnly -
      pIncludeQualifiers -
      pIncludeClassOrigin -
      pPropertyList -
      Returns:
      Element
      Throws:
      WBEMException
    • deleteInstance_request

      public Element deleteInstance_request(Document pDoc, CIMObjectPath pName) throws WBEMException
      deleteInstance_request
      Parameters:
      pDoc -
      pName -
      Returns:
      Element
      Throws:
      WBEMException
    • getClass_request

      public Element getClass_request(Document pDoc, CIMObjectPath pName, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
      getClass_request
      Parameters:
      pDoc -
      pName -
      pLocalOnly -
      pIncludeQualifiers -
      pIncludeClassOrigin -
      pPropertyList -
      Returns:
      Element
      Throws:
      WBEMException
    • createInstance_request

      public Element createInstance_request(Document pDoc, CIMObjectPath pName, CIMInstance pInstance) throws WBEMException
      createInstance_request
      Parameters:
      pDoc -
      pName -
      pInstance -
      Returns:
      Element
      Throws:
      WBEMException
    • invokeMethod_request

      public Element invokeMethod_request(Document pDoc, CIMObjectPath pLocalPath, String pMethodName, CIMArgument<?>[] pInArgs) throws WBEMException
      invokeMethod_request
      Parameters:
      pDoc -
      pLocalPath -
      pMethodName -
      pInArgs -
      Returns:
      Element
      Throws:
      WBEMException
    • invokeMethod_response

      public static Element invokeMethod_response(Document pDoc, String pMethodName, CIMObjectPath pLocalPath, Object pRetVal, CIMArgument<?>[] pOutArgA) throws WBEMException
      invokeMethod_response
      Parameters:
      pDoc -
      pMethodName -
      pLocalPath -
      pRetVal -
      pOutArgA -
      Returns:
      Element
      Throws:
      WBEMException
    • createIndication_response

      public Document createIndication_response(CIMError error)
      createIndication_response
      Parameters:
      error -
      Returns:
      Document
    • createClass_request

      public Element createClass_request(Document pDoc, CIMObjectPath pPath, CIMClass pClass) throws WBEMException
      createClass_request
      Parameters:
      pDoc -
      pPath -
      pClass -
      Returns:
      Element
      Throws:
      WBEMException
    • getQualifier_request

      public Element getQualifier_request(Document pDoc, CIMObjectPath pPath, String pQt) throws WBEMException
      getQualifier_request
      Parameters:
      pDoc -
      pPath -
      pQt -
      Returns:
      Element
      Throws:
      WBEMException
    • createQualifierType_request

      public Element createQualifierType_request(Document pDoc, CIMObjectPath pPath, CIMQualifierType<?> pQt) throws WBEMException
      createQualifierType_request : This has been replaced by setQualifierType_request
      Parameters:
      pDoc -
      pPath -
      pQt -
      Returns:
      Element
      Throws:
      WBEMException
    • deleteClass_request

      public Element deleteClass_request(Document pDoc, CIMObjectPath pPath) throws WBEMException
      deleteClass_request
      Parameters:
      pDoc -
      pPath -
      Returns:
      Element
      Throws:
      WBEMException
    • deleteQualifierType_request

      public Element deleteQualifierType_request(Document pDoc, CIMObjectPath pPath) throws WBEMException
      deleteQualifierType_request
      Parameters:
      pDoc -
      pPath -
      Returns:
      Element
      Throws:
      WBEMException
    • enumerateClasses_request

      public Element enumerateClasses_request(Document pDoc, CIMObjectPath pPath, boolean pDeepInheritance, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin)
      enumerateClasses_request
      Parameters:
      pDoc -
      pPath -
      pDeepInheritance -
      pLocalOnly -
      pIncludeQualifiers -
      pIncludeClassOrigin -
      Returns:
      Element
    • enumerateClasses_response

      public static Element enumerateClasses_response(Document pDoc, CIMClass[] pClA)
      enumerateClasses_response
      Parameters:
      pDoc -
      pClA -
      Returns:
      Element
    • enumerateInstances_response

      public static Element enumerateInstances_response(Document pDoc, CIMInstance[] pInstA)
      enumerateInstances_response
      Parameters:
      pDoc -
      pInstA -
      Returns:
      Element
    • enumerateClassNames_request

      public Element enumerateClassNames_request(Document pDoc, CIMObjectPath pPath, boolean pDeepInheritance)
      enumerateClassNames_request
      Parameters:
      pDoc -
      pPath -
      pDeepInheritance -
      Returns:
      Element
    • getProperty_request

      public Element getProperty_request(Document pDoc, CIMObjectPath pPath, String pPropertyName) throws WBEMException
      getProperty_request
      Parameters:
      pDoc -
      pPath -
      pPropertyName -
      Returns:
      Element
      Throws:
      WBEMException
    • referenceNames_request

      public Element referenceNames_request(Document pDoc, CIMObjectPath pPath, String pResultClass, String pRole) throws WBEMException
      referenceNames_request
      Parameters:
      pDoc -
      pPath -
      pResultClass -
      pRole -
      Returns:
      Element
      Throws:
      WBEMException
    • referenceClasses_request

      public Element referenceClasses_request(Document pDoc, CIMObjectPath pPath, String pResultClass, String pRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
      referenceClasses_request
      Parameters:
      pDoc -
      pPath -
      pResultClass -
      pRole -
      pIncludeQualifiers -
      pIncludeClassOrigin -
      pPropertyList -
      Returns:
      Element
      Throws:
      WBEMException
    • referenceInstances_request

      public Element referenceInstances_request(Document pDoc, CIMObjectPath pPath, String pResultClass, String pRole, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
      referenceInstances_request
      Parameters:
      pDoc -
      pPath -
      pResultClass -
      pRole -
      pIncludeClassOrigin -
      pPropertyList -
      Returns:
      Element
      Throws:
      WBEMException
    • references_request

      public Element references_request(Document pDoc, CIMObjectPath pPath, String pResultClass, String pRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList) throws WBEMException
      references_request
      Parameters:
      pDoc -
      pPath -
      pResultClass -
      pRole -
      pIncludeQualifiers -
      pIncludeClassOrigin -
      pPropertyList -
      Returns:
      Element
      Throws:
      WBEMException
    • setClass_request

      public Element setClass_request(Document pDoc, CIMObjectPath pPath, CIMClass pClass) throws WBEMException
      setClass_request
      Parameters:
      pDoc -
      pPath -
      pClass -
      Returns:
      Element
      Throws:
      WBEMException
    • setInstance_request

      public Element setInstance_request(Document pDoc, CIMObjectPath pPath, CIMInstance pInstance, boolean pIncludeQualifiers, String[] pPropertyList) throws WBEMException
      setInstance_request
      Parameters:
      pDoc -
      pPath -
      pInstance -
      pIncludeQualifiers -
      pPropertyList -
      Returns:
      Element
      Throws:
      WBEMException
    • setProperty_request

      public Element setProperty_request(Document pDoc, CIMObjectPath pPath, String pPropertyName, Object pNewValue) throws WBEMException
      setProperty_request
      Parameters:
      pDoc -
      pPath -
      pPropertyName -
      pNewValue -
      Returns:
      Element
      Throws:
      WBEMException
    • setQualifierType_request

      public Element setQualifierType_request(Document pDoc, CIMObjectPath pPath, CIMQualifierType<?> pQt) throws WBEMException
      setQualifierType_request
      Parameters:
      pDoc -
      pPath -
      pQt -
      Returns:
      Element
      Throws:
      WBEMException
    • enumQualifierTypes_request

      public Element enumQualifierTypes_request(Document pDoc, CIMObjectPath pPath) throws WBEMException
      enumQualifierTypes_request
      Parameters:
      pDoc -
      pPath -
      Returns:
      Element
      Throws:
      WBEMException
    • enumQualifierTypes_response

      public static Element enumQualifierTypes_response(Document pDoc, CIMQualifierType<?>[] pQualiTypeA) throws WBEMException
      enumQualifierTypes_response
      Parameters:
      pDoc -
      pQualiTypeA -
      Returns:
      Element
      Throws:
      WBEMException
    • execQuery_request

      public Element execQuery_request(Document pDoc, CIMObjectPath pPath, String pQuery, String pQueryLanguage)
      execQuery_request
      Parameters:
      pDoc -
      pPath -
      pQuery -
      pQueryLanguage -
      Returns:
      Element
    • performBatchOperation_request

      public Element performBatchOperation_request(Document pDoc, Vector<CIMOperation> pOperations) throws WBEMException
      performBatchOperation_request
      Parameters:
      pDoc -
      pOperations -
      Returns:
      Element
      Throws:
      WBEMException
    • setId

      public void setId(int pId)
      Sets the message id counter to a given value. For use in units tests only.
      Parameters:
      pId - The new value
    • OpenAssociatorInstancePaths_request

      public Element OpenAssociatorInstancePaths_request(Document pDoc, CIMObjectPath pPath, String pAssocClass, String pResultClass, String pRole, String pResultRole, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pOperationTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjectCount) throws WBEMException
      pAssociatorPaths_request
      Parameters:
      pDoc -
      pPath -
      pAssocClass -
      pResultClass -
      pRole -
      pResultRole -
      pFilterQueryLanguage -
      pFilterQuery -
      pOperationTimeout -
      pContinueOnError -
      pMaxObjectCount -
      Returns:
      Element
      Throws:
      WBEMException
    • OpenAssociatorInstances_request

      public Element OpenAssociatorInstances_request(Document pDoc, CIMObjectPath pPath, String pAssocClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeClassOrigin, String[] pPropertyList, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pOperationTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjectCount) throws WBEMException
      OpenAssociatorInstances_request
      Parameters:
      pDoc -
      pPath -
      pAssocClass -
      pResultClass -
      pRole -
      pResultRole -
      pIncludeClassOrigin -
      pPropertyList -
      pFilterQueryLanguage -
      pFilterQuery -
      pOperationTimeout -
      pContinueOnError -
      pMaxObjectCount -
      Returns:
      Element OpenAssociatorInstances_request
      Throws:
      WBEMException
    • OpenEnumerateInstancePaths_request

      public Element OpenEnumerateInstancePaths_request(Document pDoc, CIMObjectPath pPath, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pOperationTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjectCount) throws WBEMException
      OpenEnumerateInstancePaths_request
      Parameters:
      pDoc -
      pPath -
      pFilterQueryLanguage -
      pFilterQuery -
      pOperationTimeout -
      pContinueOnError -
      pMaxObjectCount -
      Returns:
      Element
      Throws:
      WBEMException
    • OpenEnumerateInstances_request

      public Element OpenEnumerateInstances_request(Document pDoc, CIMObjectPath pPath, boolean pDeepInheritance, boolean pIncludeClassOrigin, String[] pPropertyList, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pOperationTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjectCount) throws WBEMException
      OpenEnumerateInstances_request
      Parameters:
      pDoc -
      pPath -
      pDeepInheritance -
      pIncludeClassOrigin -
      pPropertyList -
      pFilterQueryLanguage -
      pFilterQuery -
      pOperationTimeout -
      pContinueOnError -
      pMaxObjectCount -
      Returns:
      Element
      Throws:
      WBEMException
    • EnumerationCount_request

      public Element EnumerationCount_request(Document pDoc, CIMObjectPath pPath, String pEnumerationContext) throws WBEMException
      EnumerationCount_request
      Parameters:
      pDoc -
      pPath -
      pEnumerationContext -
      Returns:
      Element
      Throws:
      WBEMException
    • CloseEnumeration_request

      public Element CloseEnumeration_request(Document pDoc, CIMObjectPath pPath, String pEnumerationContext) throws WBEMException
      CloseEnumeration_request
      Parameters:
      pDoc -
      pPath -
      pEnumerationContext -
      Returns:
      Element
      Throws:
      WBEMException
    • OpenReferenceInstancePaths_request

      public Element OpenReferenceInstancePaths_request(Document pDoc, CIMObjectPath pPath, String pResultClass, String pRole, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pOperationTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjectCount) throws WBEMException
      referencePaths_request
      Parameters:
      pDoc -
      pPath -
      pResultClass -
      pRole -
      pFilterQueryLanguage -
      pFilterQuery -
      pOperationTimeout -
      pContinueOnError -
      pMaxObjectCount -
      Returns:
      Element referencePaths_request
      Throws:
      WBEMException
    • OpenReferenceInstances_request

      public Element OpenReferenceInstances_request(Document pDoc, CIMObjectPath pPath, String pResultClass, String pRole, boolean pIncludeClassOrigin, String[] pPropertyList, String pFilterQueryLanguage, String pFilterQuery, UnsignedInteger32 pOperationTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjectCount) throws WBEMException
      references_request
      Parameters:
      pDoc -
      pPath -
      pResultClass -
      pRole -
      pIncludeClassOrigin -
      pPropertyList -
      pFilterQueryLanguage -
      pFilterQuery -
      pOperationTimeout -
      pContinueOnError -
      pMaxObjectCount -
      Returns:
      Element references_request
      Throws:
      WBEMException
    • OpenQueryInstances_request

      public Element OpenQueryInstances_request(Document pDoc, CIMObjectPath pPath, String pFilterQuery, String pFilterQueryLanguage, boolean pReturnQueryResultClass, UnsignedInteger32 pOperationTimeout, boolean pContinueOnError, UnsignedInteger32 pMaxObjectCount, CIMClass pQueryResultClass) throws WBEMException
      OpenQueryInstances_request
      Parameters:
      pDoc -
      pPath -
      pFilterQuery -
      pFilterQueryLanguage -
      pReturnQueryResultClass -
      pOperationTimeout -
      pContinueOnError -
      pMaxObjectCount -
      pQueryResultClass -
      Returns:
      Element OpenQueryInstances_request
      Throws:
      WBEMException
    • PullInstancesWithPath_request

      public Element PullInstancesWithPath_request(Document pDoc, CIMObjectPath pPath, String pContext, UnsignedInteger32 pMaxObjectCount) throws WBEMException
      PullInstancesWithPath_request
      Parameters:
      pDoc -
      pPath -
      pContext -
      pMaxObjectCount -
      Returns:
      Element PullInstancesWithPath_request
      Throws:
      WBEMException
    • PullInstancePaths_request

      public Element PullInstancePaths_request(Document pDoc, CIMObjectPath pPath, String pContext, UnsignedInteger32 pMaxObjectCount) throws WBEMException
      PullInstancePaths_request
      Parameters:
      pDoc -
      pPath -
      pContext -
      pMaxObjectCount -
      Returns:
      Element PullInstancePaths
      Throws:
      WBEMException
    • PullInstances_request

      public Element PullInstances_request(Document pDoc, CIMObjectPath pPath, String pContext, UnsignedInteger32 pMaxObjectCount) throws WBEMException
      PullInstances_request
      Parameters:
      pDoc -
      pPath -
      pContext -
      pMaxObjectCount -
      Returns:
      Element PullInstances_request
      Throws:
      WBEMException
    • sendIndication_request

      public Element sendIndication_request(Document pDoc, CIMInstance pIndication) throws WBEMException
      sendIndication_request
      Parameters:
      pDoc -
      pIndication -
      Returns:
      Element sendIndication_request
      Throws:
      WBEMException