org.sblim.cimclient.internal.cimxml

Class CIMClientXML_HelperImpl

public class CIMClientXML_HelperImpl extends Object

Class CIMClientXML_HelperImpl is responsible for building CIM-XML requests and responses.
Constructor Summary
CIMClientXML_HelperImpl()
Ctor.
Method Summary
ElementassociatorNames_request(Document pDoc, CIMObjectPath pObjectName, String pAssocClass, String pResultClass, String pRole, String pResultRole)
associatorNames_request
static ElementassociatorNames_response(Document pDoc, CIMObjectPath[] pPathA)
associatorNames_response
Elementassociators_request(Document pDoc, CIMObjectPath pObjectName, String pAssocClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList)
associators_request
static Elementassociators_response(Document pDoc, CIMNamedElementInterface[] pNamedElementA)
associators_response
ElementcreateCIMMessage(Document pDoc, Element pRequestE)
createCIMMessage
ElementcreateClass_request(Document pDoc, CIMObjectPath pPath, CIMClass pClass)
createClass_request
DocumentcreateIndication_response(CIMError error)
createIndication_response
ElementcreateInstance_request(Document pDoc, CIMObjectPath pName, CIMInstance pInstance)
createInstance_request
ElementcreateMultiReq(Document pDoc)
createMultiReq
ElementcreateQualifierType_request(Document pDoc, CIMObjectPath pPath, CIMQualifierType pQt)
createQualifierType_request
ElementdeleteClass_request(Document pDoc, CIMObjectPath pPath)
deleteClass_request
ElementdeleteInstance_request(Document pDoc, CIMObjectPath pName)
deleteInstance_request
ElementdeleteQualifierType_request(Document pDoc, CIMObjectPath pPath)
deleteQualifierType_request
static voiddumpDocument(OutputStream pOS, Document pDoc)
Serializes a given DOM document as (CIM-)XML to a given output stream.
ElementenumerateClasses_request(Document pDoc, CIMObjectPath pPath, boolean pDeepInheritance, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin)
enumerateClasses_request
static ElementenumerateClasses_response(Document pDoc, CIMClass[] pClA)
enumerateClasses_response
ElementenumerateClassNames_request(Document pDoc, CIMObjectPath pPath, boolean pDeepInheritance)
enumerateClassNames_request
ElementenumerateInstanceNames_request(Document pDoc, CIMObjectPath pPath)
enumerateInstanceNames_request
ElementenumerateInstances_request(Document pDoc, CIMObjectPath pPath, boolean pDeepInheritance, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList)
enumerateInstances_request
static ElementenumerateInstances_response(Document pDoc, CIMInstance[] pInstA)
enumerateInstances_response
ElementenumQualifierTypes_request(Document pDoc, CIMObjectPath pPath)
enumQualifierTypes_request
static ElementenumQualifierTypes_response(Document pDoc, CIMQualifierType[] pQualiTypeA)
enumQualifierTypes_response
ElementexecQuery_request(Document pDoc, CIMObjectPath pPath, String pQuery, String pQueryLanguage)
execQuery_request
ElementgetClass_request(Document pDoc, CIMObjectPath pName, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList)
getClass_request
DocumentBuildergetDocumentBuilder()
getDocumentBuilder
ElementgetInstance_request(Document pDoc, CIMObjectPath pName, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList)
getInstance_request
ElementgetProperty_request(Document pDoc, CIMObjectPath pPath, String pPropertyName)
getProperty_request
ElementgetQualifier_request(Document pDoc, CIMObjectPath pPath, String pQt)
getQualifier_request
ElementinvokeMethod_request(Document pDoc, CIMObjectPath pLocalPath, String pMethodName, CIMArgument[] pInArgs)
invokeMethod_request
static ElementinvokeMethod_response(Document pDoc, String pMethodName, CIMObjectPath pLocalPath, Object pRetVal, CIMArgument[] pOutArgA)
invokeMethod_response
DocumentnewDocument()
newDocument
Documentparse(InputSource pIS)
parse
ElementperformBatchOperation_request(Document pDoc, Vector pOperations)
performBatchOperation_request
ElementreferenceNames_request(Document pDoc, CIMObjectPath pPath, String pResultClass, String pRole)
referenceNames_request
Elementreferences_request(Document pDoc, CIMObjectPath pPath, String pResultClass, String pRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList)
references_request
static voidserialize(OutputStream pOS, Document pDoc)
Serializes a given DOM document as (CIM-)XML to a given output stream
ElementsetClass_request(Document pDoc, CIMObjectPath pPath, CIMClass pClass)
setClass_request
voidsetId(int pId)
Sets the message id counter to a given value.
ElementsetInstance_request(Document pDoc, CIMObjectPath pPath, CIMInstance pInstance, boolean pIncludeQualifiers, String[] pPropertyList)
setInstance_request
ElementsetProperty_request(Document pDoc, CIMObjectPath pPath, String pPropertyName, Object pNewValue)
setProperty_request
ElementsetQualifierType_request(Document pDoc, CIMObjectPath pPath, CIMQualifierType pQt)
setQualifierType_request

Constructor Detail

CIMClientXML_HelperImpl

public CIMClientXML_HelperImpl()
Ctor.

Throws: ParserConfigurationException

Method Detail

associatorNames_request

public Element associatorNames_request(Document pDoc, CIMObjectPath pObjectName, String pAssocClass, String pResultClass, String pRole, String pResultRole)
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

associators_request

public Element associators_request(Document pDoc, CIMObjectPath pObjectName, String pAssocClass, String pResultClass, String pRole, String pResultRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList)
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

createCIMMessage

public Element createCIMMessage(Document pDoc, Element pRequestE)
createCIMMessage

Parameters: pDoc pRequestE

Returns: Element

createClass_request

public Element createClass_request(Document pDoc, CIMObjectPath pPath, CIMClass pClass)
createClass_request

Parameters: pDoc pPath pClass

Returns: Element

Throws: WBEMException

createIndication_response

public Document createIndication_response(CIMError error)
createIndication_response

Parameters: error

Returns: Document

createInstance_request

public Element createInstance_request(Document pDoc, CIMObjectPath pName, CIMInstance pInstance)
createInstance_request

Parameters: pDoc pName pInstance

Returns: Element

Throws: WBEMException

createMultiReq

public Element createMultiReq(Document pDoc)
createMultiReq

Parameters: pDoc

Returns: Element

createQualifierType_request

public Element createQualifierType_request(Document pDoc, CIMObjectPath pPath, CIMQualifierType pQt)
createQualifierType_request

Parameters: pDoc pPath pQt

Returns: Element

Throws: WBEMException

deleteClass_request

public Element deleteClass_request(Document pDoc, CIMObjectPath pPath)
deleteClass_request

Parameters: pDoc pPath

Returns: Element

Throws: WBEMException

deleteInstance_request

public Element deleteInstance_request(Document pDoc, CIMObjectPath pName)
deleteInstance_request

Parameters: pDoc pName

Returns: Element

Throws: WBEMException

deleteQualifierType_request

public Element deleteQualifierType_request(Document pDoc, CIMObjectPath pPath)
deleteQualifierType_request

Parameters: pDoc pPath

Returns: Element

Throws: WBEMException

dumpDocument

public static void dumpDocument(OutputStream pOS, Document pDoc)
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

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

enumerateClassNames_request

public Element enumerateClassNames_request(Document pDoc, CIMObjectPath pPath, boolean pDeepInheritance)
enumerateClassNames_request

Parameters: pDoc pPath pDeepInheritance

Returns: Element

enumerateInstanceNames_request

public Element enumerateInstanceNames_request(Document pDoc, CIMObjectPath pPath)
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)
enumerateInstances_request

Parameters: pDoc pPath pDeepInheritance pLocalOnly pIncludeQualifiers pIncludeClassOrigin pPropertyList

Returns: Element

Throws: WBEMException

enumerateInstances_response

public static Element enumerateInstances_response(Document pDoc, CIMInstance[] pInstA)
enumerateInstances_response

Parameters: pDoc pInstA

Returns: Element

enumQualifierTypes_request

public Element enumQualifierTypes_request(Document pDoc, CIMObjectPath pPath)
enumQualifierTypes_request

Parameters: pDoc pPath

Returns: Element

Throws: WBEMException

enumQualifierTypes_response

public static Element enumQualifierTypes_response(Document pDoc, CIMQualifierType[] pQualiTypeA)
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

getClass_request

public Element getClass_request(Document pDoc, CIMObjectPath pName, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList)
getClass_request

Parameters: pDoc pName pLocalOnly pIncludeQualifiers pIncludeClassOrigin pPropertyList

Returns: Element

Throws: WBEMException

getDocumentBuilder

public DocumentBuilder getDocumentBuilder()
getDocumentBuilder

Returns: DocumentBuilder

getInstance_request

public Element getInstance_request(Document pDoc, CIMObjectPath pName, boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList)
getInstance_request

Parameters: pDoc pName pLocalOnly pIncludeQualifiers pIncludeClassOrigin pPropertyList

Returns: Element

Throws: WBEMException

getProperty_request

public Element getProperty_request(Document pDoc, CIMObjectPath pPath, String pPropertyName)
getProperty_request

Parameters: pDoc pPath pPropertyName

Returns: Element

Throws: WBEMException

getQualifier_request

public Element getQualifier_request(Document pDoc, CIMObjectPath pPath, String pQt)
getQualifier_request

Parameters: pDoc pPath pQt

Returns: Element

Throws: WBEMException

invokeMethod_request

public Element invokeMethod_request(Document pDoc, CIMObjectPath pLocalPath, String pMethodName, CIMArgument[] pInArgs)
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)
invokeMethod_response

Parameters: pDoc pMethodName pLocalPath pRetVal pOutArgA

Returns: Element

Throws: WBEMException

newDocument

public Document newDocument()
newDocument

Returns: Document

parse

public Document parse(InputSource pIS)
parse

Parameters: pIS

Returns: Document

Throws: IOException SAXException

performBatchOperation_request

public Element performBatchOperation_request(Document pDoc, Vector pOperations)
performBatchOperation_request

Parameters: pDoc pOperations

Returns: Element

Throws: WBEMException

referenceNames_request

public Element referenceNames_request(Document pDoc, CIMObjectPath pPath, String pResultClass, String pRole)
referenceNames_request

Parameters: pDoc pPath pResultClass pRole

Returns: Element

Throws: WBEMException

references_request

public Element references_request(Document pDoc, CIMObjectPath pPath, String pResultClass, String pRole, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList)
references_request

Parameters: pDoc pPath pResultClass pRole pIncludeQualifiers pIncludeClassOrigin pPropertyList

Returns: Element

Throws: WBEMException

serialize

public static void serialize(OutputStream pOS, Document pDoc)
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

setClass_request

public Element setClass_request(Document pDoc, CIMObjectPath pPath, CIMClass pClass)
setClass_request

Parameters: pDoc pPath pClass

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

setInstance_request

public Element setInstance_request(Document pDoc, CIMObjectPath pPath, CIMInstance pInstance, boolean pIncludeQualifiers, String[] pPropertyList)
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)
setProperty_request

Parameters: pDoc pPath pPropertyName pNewValue

Returns: Element

Throws: WBEMException

setQualifierType_request

public Element setQualifierType_request(Document pDoc, CIMObjectPath pPath, CIMQualifierType pQt)
setQualifierType_request

Parameters: pDoc pPath pQt

Returns: Element

Throws: WBEMException

Copyright © 2005, 2009 IBM Corporation. All Rights Reserved.