XKMSMessageFactory Class Reference
[XML Key Management System Implementation]

#include <XKMSMessageFactory.hpp>

List of all members.

---

Detailed Description

Interface definition for the XKMSMessageFactory class.

The XKMSMessageFactory classes are used to provide an interface to applicataions to produce and consume XKMS messages. No logic is defined within the class, other than that necessary to (for example) generate a response message using a request message as a base.

Client apps that wish to make use of XKMS should generally use the XKMSClient class.

Constructors and Destructors
virtual	~XKMSMessageFactory ()
	XKMSMessageFactory ()
Public Member Functions
Methods to build XKMS message objects from existing XML
virtual XKMSMessageAbstractType *	newMessageFromDOM (XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *elt)=0
	Load a message from an existing XML document.
Methods for building new X-KISS messages from scratch
virtual XKMSCompoundRequest *	createCompoundRequest (const XMLCh *service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc, const XMLCh *id=NULL)=0
	Create a new <CompoundRequest> message.
virtual XKMSCompoundRequest *	createCompoundRequest (const XMLCh *service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **doc, const XMLCh *id=NULL)=0
	Create a new <CompoundRequest> message and surrounding document.
virtual XKMSLocateRequest *	createLocateRequest (const XMLCh *service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc, const XMLCh *id=NULL)=0
	Create a new <LocateRequest> message.
virtual XKMSLocateRequest *	createLocateRequest (const XMLCh *service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **doc, const XMLCh *id=NULL)=0
	Create a new <LocateRequest> message and surrounding document.
virtual XKMSValidateRequest *	createValidateRequest (const XMLCh *service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc, const XMLCh *id=NULL)=0
	Create a new <ValidateRequest> message.
virtual XKMSValidateRequest *	createValidateRequest (const XMLCh *service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **doc, const XMLCh *id=NULL)=0
	Create a new <ValidateRequest> message and surrounding document.
virtual XKMSPendingRequest *	createPendingRequest (const XMLCh *service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc, const XMLCh *id=NULL)=0
	Create a new <PendingRequest> message.
virtual XKMSPendingRequest *	createPendingRequest (const XMLCh *service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **doc, const XMLCh *id=NULL)=0
	Create a new <PendingRequest> message and surrounding document.
virtual XKMSStatusRequest *	createStatusRequest (const XMLCh *service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc, const XMLCh *id=NULL)=0
	Create a new <StatusRequest> message.
virtual XKMSStatusRequest *	createStatusRequest (const XMLCh *service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **doc, const XMLCh *id=NULL)=0
	Create a new <StatusRequest> message and surrounding document.
virtual XKMSLocateResult *	createLocateResult (XKMSLocateRequest *request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc, XKMSResultType::ResultMajor rmaj, XKMSResultType::ResultMinor rmin=XKMSResultType::NoneMinor, const XMLCh *id=NULL)=0
	Create a new <LocateResult> message.
virtual XKMSLocateResult *	createLocateResult (XKMSLocateRequest *request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **doc, XKMSResultType::ResultMajor rmaj, XKMSResultType::ResultMinor rmin=XKMSResultType::NoneMinor, const XMLCh *id=NULL)=0
	Create a new <LocateResult> message and surrounding document.
virtual XKMSValidateResult *	createValidateResult (XKMSValidateRequest *request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc, XKMSResultType::ResultMajor rmaj, XKMSResultType::ResultMinor rmin=XKMSResultType::NoneMinor, const XMLCh *id=NULL)=0
	Create a new <ValidateResult> message.
virtual XKMSValidateResult *	createValidateResult (XKMSValidateRequest *request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **doc, XKMSResultType::ResultMajor rmaj, XKMSResultType::ResultMinor rmin=XKMSResultType::NoneMinor, const XMLCh *id=NULL)=0
	Create a new <ValidateResult> message and surrounding document.
virtual XKMSCompoundResult *	createCompoundResult (XKMSCompoundRequest *request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc, XKMSResultType::ResultMajor rmaj, XKMSResultType::ResultMinor rmin=XKMSResultType::NoneMinor, const XMLCh *id=NULL)=0
	Create a new <CompoundResult> message.
virtual XKMSCompoundResult *	createCompoundResult (XKMSCompoundRequest *request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **doc, XKMSResultType::ResultMajor rmaj, XKMSResultType::ResultMinor rmin=XKMSResultType::NoneMinor, const XMLCh *id=NULL)=0
	Create a new <CompoundResult> message and surrounding document.
virtual XKMSResult *	createResult (XKMSRequestAbstractType *request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc, XKMSResultType::ResultMajor rmaj, XKMSResultType::ResultMinor rmin=XKMSResultType::NoneMinor, const XMLCh *id=NULL)=0
	Create a new <Result> message.
virtual XKMSResult *	createResult (XKMSRequestAbstractType *request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **doc, XKMSResultType::ResultMajor rmaj, XKMSResultType::ResultMinor rmin=XKMSResultType::NoneMinor, const XMLCh *id=NULL)=0
	Create a new <Result> message and surrounding document.
virtual XKMSStatusResult *	createStatusResult (XKMSStatusRequest *request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc, XKMSResultType::ResultMajor rmaj, XKMSResultType::ResultMinor rmin=XKMSResultType::NoneMinor, const XMLCh *id=NULL)=0
	Create a new <StatusResult> message.
virtual XKMSStatusResult *	createStatusResult (XKMSStatusRequest *request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **doc, XKMSResultType::ResultMajor rmaj, XKMSResultType::ResultMinor rmin=XKMSResultType::NoneMinor, const XMLCh *id=NULL)=0
	Create a new <StatusResult> message and surrounding document.
Methods for building new X-KRSS messages from scratch
virtual XKMSRegisterRequest *	createRegisterRequest (const XMLCh *service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc, const XMLCh *id=NULL)=0
	Create a new <RegisterRequest> message.
virtual XKMSRegisterRequest *	createRegisterRequest (const XMLCh *service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **doc, const XMLCh *id=NULL)=0
	Create a new <RegisterRequest> message and surrounding document.
virtual XKMSRegisterResult *	createRegisterResult (XKMSRegisterRequest *request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc, XKMSResultType::ResultMajor rmaj, XKMSResultType::ResultMinor rmin=XKMSResultType::NoneMinor, const XMLCh *id=NULL)=0
	Create a new <RegisterResult> message.
virtual XKMSRegisterResult *	createRegisterResult (XKMSRegisterRequest *request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **doc, XKMSResultType::ResultMajor rmaj, XKMSResultType::ResultMinor rmin=XKMSResultType::NoneMinor, const XMLCh *id=NULL)=0
	Create a new <RegisterResult> message and surrounding document.
Environment Manipulation Functions
virtual void	setDSIGNSPrefix (const XMLCh *prefix)=0
	Set the prefix be used for the DSIG namespace.
virtual void	setECNSPrefix (const XMLCh *prefix)=0
	Set the prefix be used for the Exclusive Canonicalisation namespace.
virtual void	setXPFNSPrefix (const XMLCh *prefix)=0
	Set the prefix be used for the XPath-Filter2 namespace.
virtual void	setXENCNSPrefix (const XMLCh *prefix)=0
	Set the prefix be used for the XML Encryption namespace.
virtual void	setXKMSNSPrefix (const XMLCh *prefix)=0
	Set the prefix be used for the XKMS Namespace.
Message Conversions
virtual XKMSRequestAbstractType *	toRequestAbstractType (XKMSMessageAbstractType *msg)=0
	Convert to a Request type.
virtual XKMSResultType *	toResultType (XKMSMessageAbstractType *msg)=0
	Convert to a Result type.

---

Constructor & Destructor Documentation

XKMSMessageFactory::XKMSMessageFactory (   )  [inline, protected]

virtual XKMSMessageFactory::~XKMSMessageFactory (   )  [inline, virtual]

---

Member Function Documentation

virtual XKMSCompoundRequest* XKMSMessageFactory::createCompoundRequest (  const XMLCh *  service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **  doc, const XMLCh *  id = NULL )  [pure virtual]

Create a new <CompoundRequest> message and surrounding document. Generates a new CompoundRequest message from scratch, building the DOM as it goes. Parameters: service  URI doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. Returns: the new XKMSCompoundRequest structure Note: Like all the xsec library functions, the document is owned by the calling application. Deleteing the CompoundRequest object will not delete the DOM document as well.

virtual XKMSCompoundRequest* XKMSMessageFactory::createCompoundRequest (  const XMLCh *  service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  doc, const XMLCh *  id = NULL )  [pure virtual]

Create a new <CompoundRequest> message. Generates a new CompoundRequest message from scratch, building the DOM as it goes. Parameters: service  URI doc  Document to create the DOM structure within. The caller will need to embed the DOM structure at the appropriate place in the document (using a call to getElement to find the top level element) id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. Returns: the new XKMSCompoundRequest structure

virtual XKMSCompoundResult* XKMSMessageFactory::createCompoundResult (  XKMSCompoundRequest *  request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **  doc, XKMSResultType::ResultMajor  rmaj, XKMSResultType::ResultMinor  rmin = XKMSResultType::NoneMinor, const XMLCh *  id = NULL )  [pure virtual]

Create a new <CompoundResult> message and surrounding document. Generates a new CompoundResult message from scratch, building the DOM as it goes. The response will be based on a input ValidateRequest message which is used to provide Id etc. Parameters: request  Request to base response on doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. rmaj  Major result code rmin  Minor result code Returns: the new XKMSCompoundResponse structure Note: Like all the xsec library functions, the document is owned by the calling application. Deleteing the ValidateRequest object will not delete the DOM document as well.

virtual XKMSCompoundResult* XKMSMessageFactory::createCompoundResult (  XKMSCompoundRequest *  request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  doc, XKMSResultType::ResultMajor  rmaj, XKMSResultType::ResultMinor  rmin = XKMSResultType::NoneMinor, const XMLCh *  id = NULL )  [pure virtual]

Create a new <CompoundResult> message. Generates a new CompoundResult message from scratch, building the DOM as it goes. The response will be based on a input CompoundRequest message which is used to provide Id etc. Parameters: request  Request to base response on doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. rmaj  Major result code rmin  Minor result code Returns: the new XKMSLocateResponse structure

virtual XKMSLocateRequest* XKMSMessageFactory::createLocateRequest (  const XMLCh *  service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **  doc, const XMLCh *  id = NULL )  [pure virtual]

Create a new <LocateRequest> message and surrounding document. Generates a new LocateRequest message from scratch, building the DOM as it goes. Parameters: service  URI doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. Returns: the new XKMSLocateRequest structure Note: Like all the xsec library functions, the document is owned by the calling application. Deleteing the LocateRequest object will not delete the DOM document as well.

virtual XKMSLocateRequest* XKMSMessageFactory::createLocateRequest (  const XMLCh *  service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  doc, const XMLCh *  id = NULL )  [pure virtual]

Create a new <LocateRequest> message. Generates a new LocateRequest message from scratch, building the DOM as it goes. Parameters: service  URI doc  Document to create the DOM structure within. The caller will need to embed the DOM structure at the appropriate place in the document (using a call to getElement to find the top level element) id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. Returns: the new XKMSLocateRequest structure

virtual XKMSLocateResult* XKMSMessageFactory::createLocateResult (  XKMSLocateRequest *  request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **  doc, XKMSResultType::ResultMajor  rmaj, XKMSResultType::ResultMinor  rmin = XKMSResultType::NoneMinor, const XMLCh *  id = NULL )  [pure virtual]

Create a new <LocateResult> message and surrounding document. Generates a new LocateResult message from scratch, building the DOM as it goes. The response will be based on a input LocateRequest message which is used to provide Id etc. Parameters: request  Request to base response on doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. rmaj  Major result code rmin  Minor result code Returns: the new XKMSLocateResponse structure Note: Like all the xsec library functions, the document is owned by the calling application. Deleteing the LocateRequest object will not delete the DOM document as well.

virtual XKMSLocateResult* XKMSMessageFactory::createLocateResult (  XKMSLocateRequest *  request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  doc, XKMSResultType::ResultMajor  rmaj, XKMSResultType::ResultMinor  rmin = XKMSResultType::NoneMinor, const XMLCh *  id = NULL )  [pure virtual]

Create a new <LocateResult> message. Generates a new LocateResult message from scratch, building the DOM as it goes. The response will be based on a input LocateRequest message which is used to provide Id etc. Parameters: request  Request to base response on doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. rmaj  Major result code rmin  Minor result code Returns: the new XKMSLocateResponse structure

virtual XKMSPendingRequest* XKMSMessageFactory::createPendingRequest (  const XMLCh *  service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **  doc, const XMLCh *  id = NULL )  [pure virtual]

Create a new <PendingRequest> message and surrounding document. Generates a new PendingRequest message from scratch, building the DOM as it goes. Parameters: service  URI doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. Returns: the new XKMSPendingRequest structure Note: Like all the xsec library functions, the document is owned by the calling application. Deleting the PendingRequest object will not delete the DOM document as well.

virtual XKMSPendingRequest* XKMSMessageFactory::createPendingRequest (  const XMLCh *  service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  doc, const XMLCh *  id = NULL )  [pure virtual]

Create a new <PendingRequest> message. Generates a new PendingRequest message from scratch, building the DOM as it goes. Parameters: service  URI doc  Document to create the DOM structure within. The caller will need to embed the DOM structure at the appropriate place in the document (using a call to getElement to find the top level element) id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. Returns: the new XKMSPendingRequest structure

virtual XKMSRegisterRequest* XKMSMessageFactory::createRegisterRequest (  const XMLCh *  service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **  doc, const XMLCh *  id = NULL )  [pure virtual]

Create a new <RegisterRequest> message and surrounding document. Generates a new RegisterRequest message from scratch, building the DOM as it goes. Parameters: service  URI doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. Returns: the new XKMSRegisterRequest structure Note: Like all the xsec library functions, the document is owned by the calling application. Deleting the RegisterRequest object will not delete the DOM document as well.

virtual XKMSRegisterRequest* XKMSMessageFactory::createRegisterRequest (  const XMLCh *  service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  doc, const XMLCh *  id = NULL )  [pure virtual]

Create a new <RegisterRequest> message. Generates a new RegisterRequest message from scratch, building the DOM as it goes. Parameters: service  URI doc  Document to create the DOM structure within. The caller will need to embed the DOM structure at the appropriate place in the document (using a call to getElement to find the top level element) id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. Returns: the new XKMSRegisterRequest structure

virtual XKMSRegisterResult* XKMSMessageFactory::createRegisterResult (  XKMSRegisterRequest *  request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **  doc, XKMSResultType::ResultMajor  rmaj, XKMSResultType::ResultMinor  rmin = XKMSResultType::NoneMinor, const XMLCh *  id = NULL )  [pure virtual]

Create a new <RegisterResult> message and surrounding document. Generates a new RegisterResult message from scratch, building the DOM as it goes. The response will be based on a input ValidateRequest message which is used to provide Id etc. Parameters: request  Request to base response on doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. rmaj  Major result code rmin  Minor result code Returns: the new XKMSRegisterResponse structure Note: Like all the xsec library functions, the document is owned by the calling application. Deleting the RegisterRequest object will not delete the DOM document as well.

virtual XKMSRegisterResult* XKMSMessageFactory::createRegisterResult (  XKMSRegisterRequest *  request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  doc, XKMSResultType::ResultMajor  rmaj, XKMSResultType::ResultMinor  rmin = XKMSResultType::NoneMinor, const XMLCh *  id = NULL )  [pure virtual]

Create a new <RegisterResult> message. Generates a new RegisterResult message from scratch, building the DOM as it goes. The response will be based on a input ValidateRequest message which is used to provide Id etc. Parameters: request  Request to base response on doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. rmaj  Major result code rmin  Minor result code Returns: the new XKMSRegisterResponse structure

virtual XKMSResult* XKMSMessageFactory::createResult (  XKMSRequestAbstractType *  request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **  doc, XKMSResultType::ResultMajor  rmaj, XKMSResultType::ResultMinor  rmin = XKMSResultType::NoneMinor, const XMLCh *  id = NULL )  [pure virtual]

Create a new <Result> message and surrounding document. Generates a new Result message from scratch, building the DOM as it goes. The response will be based on a input Request message which is used to provide Id etc. Parameters: request  Request to base response on doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. rmaj  Major result code rmin  Minor result code Returns: the new Response structure Note: Like all the xsec library functions, the document is owned by the calling application. Deleting the Request object will not delete the DOM document as well.

virtual XKMSResult* XKMSMessageFactory::createResult (  XKMSRequestAbstractType *  request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  doc, XKMSResultType::ResultMajor  rmaj, XKMSResultType::ResultMinor  rmin = XKMSResultType::NoneMinor, const XMLCh *  id = NULL )  [pure virtual]

Create a new <Result> message. Generates a new Result message from scratch, building the DOM as it goes. The response will be based on an input Request message which is used to provide Id etc. Parameters: request  Request to base response on doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. rmaj  Major result code rmin  Minor result code Returns: the new XKMSResult structure

virtual XKMSStatusRequest* XKMSMessageFactory::createStatusRequest (  const XMLCh *  service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **  doc, const XMLCh *  id = NULL )  [pure virtual]

Create a new <StatusRequest> message and surrounding document. Generates a new StatusRequest message from scratch, building the DOM as it goes. Parameters: service  URI doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. Returns: the new XKMSStatusRequest structure Note: Like all the xsec library functions, the document is owned by the calling application. Deleting the StatusRequest object will not delete the DOM document as well.

virtual XKMSStatusRequest* XKMSMessageFactory::createStatusRequest (  const XMLCh *  service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  doc, const XMLCh *  id = NULL )  [pure virtual]

Create a new <StatusRequest> message. Generates a new StatusRequest message from scratch, building the DOM as it goes. Parameters: service  URI doc  Document to create the DOM structure within. The caller will need to embed the DOM structure at the appropriate place in the document (using a call to getElement to find the top level element) id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. Returns: the new XKMSStatusRequest structure

virtual XKMSStatusResult* XKMSMessageFactory::createStatusResult (  XKMSStatusRequest *  request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **  doc, XKMSResultType::ResultMajor  rmaj, XKMSResultType::ResultMinor  rmin = XKMSResultType::NoneMinor, const XMLCh *  id = NULL )  [pure virtual]

Create a new <StatusResult> message and surrounding document. Generates a new StatusResult message from scratch, building the DOM as it goes. The response will be based on a input StatusRequest message which is used to provide Id etc. Parameters: request  Request to base response on doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. rmaj  Major result code rmin  Minor result code Returns: the new XKMSStatusResult structure Note: Like all the xsec library functions, the document is owned by the calling application. Deleting the StatusResult object will not delete the DOM document as well.

virtual XKMSStatusResult* XKMSMessageFactory::createStatusResult (  XKMSStatusRequest *  request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  doc, XKMSResultType::ResultMajor  rmaj, XKMSResultType::ResultMinor  rmin = XKMSResultType::NoneMinor, const XMLCh *  id = NULL )  [pure virtual]

Create a new <StatusResult> message. Generates a new StatusResult message from scratch, building the DOM as it goes. The response will be based on a input StatusRequest message which is used to provide Id etc. Parameters: request  Request to base response on doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. rmaj  Major result code rmin  Minor result code Returns: the new XKMSStatusRessult structure

virtual XKMSValidateRequest* XKMSMessageFactory::createValidateRequest (  const XMLCh *  service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **  doc, const XMLCh *  id = NULL )  [pure virtual]

Create a new <ValidateRequest> message and surrounding document. Generates a new ValidateRequest message from scratch, building the DOM as it goes. Parameters: service  URI doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. Returns: the new XKMSValidateRequest structure Note: Like all the xsec library functions, the document is owned by the calling application. Deleting the LocateRequest object will not delete the DOM document as well.

virtual XKMSValidateRequest* XKMSMessageFactory::createValidateRequest (  const XMLCh *  service, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  doc, const XMLCh *  id = NULL )  [pure virtual]

Create a new <ValidateRequest> message. Generates a new ValidateRequest message from scratch, building the DOM as it goes. Parameters: service  URI doc  Document to create the DOM structure within. The caller will need to embed the DOM structure at the appropriate place in the document (using a call to getElement to find the top level element) id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. Returns: the new XKMSValidateRequest structure

virtual XKMSValidateResult* XKMSMessageFactory::createValidateResult (  XKMSValidateRequest *  request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument **  doc, XKMSResultType::ResultMajor  rmaj, XKMSResultType::ResultMinor  rmin = XKMSResultType::NoneMinor, const XMLCh *  id = NULL )  [pure virtual]

Create a new <ValidateResult> message and surrounding document. Generates a new ValidateResult message from scratch, building the DOM as it goes. The response will be based on a input ValidateRequest message which is used to provide Id etc. Parameters: request  Request to base response on doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. rmaj  Major result code rmin  Minor result code Returns: the new XKMSValidateResponse structure Note: Like all the xsec library functions, the document is owned by the calling application. Deleteing the ValidateRequest object will not delete the DOM document as well.

virtual XKMSValidateResult* XKMSMessageFactory::createValidateResult (  XKMSValidateRequest *  request, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  doc, XKMSResultType::ResultMajor  rmaj, XKMSResultType::ResultMinor  rmin = XKMSResultType::NoneMinor, const XMLCh *  id = NULL )  [pure virtual]

Create a new <ValidateResult> message. Generates a new ValidateResult message from scratch, building the DOM as it goes. The response will be based on a input ValidateRequest message which is used to provide Id etc. Parameters: request  Request to base response on doc  Will be used to return the newly created document element in. id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. rmaj  Major result code rmin  Minor result code Returns: the new XKMSLocateResponse structure

virtual XKMSMessageAbstractType* XKMSMessageFactory::newMessageFromDOM (  XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *  elt  )  [pure virtual]

Load a message from an existing XML document. Reads in the XML document and produces the corresponding XKMS message object. Callers should make use of the ::getMessageType method to determine what type of message they are actually working with. Parameters: elt  The element at the head of the XKMS structure

virtual void XKMSMessageFactory::setDSIGNSPrefix (  const XMLCh *  prefix  )  [pure virtual]

Set the prefix be used for the DSIG namespace. Parameters: prefix  The UTF-16 encoided NS prefix to use for the XML Digital Signature nodes

virtual void XKMSMessageFactory::setECNSPrefix (  const XMLCh *  prefix  )  [pure virtual]

Set the prefix be used for the Exclusive Canonicalisation namespace. The Exclusive Canonicalisation specification defines a new namespace for the InclusiveNamespaces node. This function can be used to set the prefix that the library will use when creating nodes within this namespace. xmlns:ds="http://www.w3.org/2001/10/xml-exc-c14n#" If no prefix is set, the default namespace will be used Parameters: prefix  The UTF-16 encoided NS prefix to use for the XML Exclusive Canonicalisation nodes

virtual void XKMSMessageFactory::setXENCNSPrefix (  const XMLCh *  prefix  )  [pure virtual]

Set the prefix be used for the XML Encryption namespace. Parameters: prefix  The UTF-16 encoided NS prefix to use for the XML Encryption nodes

virtual void XKMSMessageFactory::setXKMSNSPrefix (  const XMLCh *  prefix  )  [pure virtual]

Set the prefix be used for the XKMS Namespace. Parameters: prefix  The UTF-16 encoided NS prefix to use for the XKMS nodes

virtual void XKMSMessageFactory::setXPFNSPrefix (  const XMLCh *  prefix  )  [pure virtual]

Set the prefix be used for the XPath-Filter2 namespace. The XPathFilter definition uses its own namespace. This method can be used to set the prefix that the library will use when creating elements in this namespace xmlns:ds="http://www.w3.org/2002/06/xmldsig-filter2" If no prefix is set, the default namespace will be used Parameters: prefix  The UTF-16 encoided NS prefix to use for the XPath filter nodes

virtual XKMSRequestAbstractType* XKMSMessageFactory::toRequestAbstractType (  XKMSMessageAbstractType *  msg  )  [pure virtual]

Convert to a Request type. Used to convert a MessageAbstractType to a RequestAbstractType Parameters: msg  The message to convert Returns: the same message typecast to a RequestAbstractType (if NULL otherwise) otherwise

virtual XKMSResultType* XKMSMessageFactory::toResultType (  XKMSMessageAbstractType *  msg  )  [pure virtual]

Convert to a Result type. Used to convert a MessageAbstractType to a ResultType Parameters: msg  The message to convert Returns: the same message typecast to a ResultType (if OK - NULL otherwise) otherwise

---

The documentation for this class was generated from the following file:

• XKMSMessageFactory.hpp

---