OASIS Web Services Security SOAP header. More...

Inheritance diagram for Header:

Collaboration diagram for Header:

Public Member Functions
_.Library.Status	AddSecurityElement (_.SOAP.Security.Element element, position)
	Add an element to the Security header. More...

_.SOAP.Security.Element	FindByEncryptedKeySHA1 (_.Library.Binary encryptedKeySHA1)
	Find the key from an EncryptedKey element which corresponds to the EncryptedKeySHA1 argument. More...

_.SOAP.Security.Element	FindElement (_.Library.String type, _.Library.String pos)
	Find the first security element of the specified type after position pos and return the element. More...

_.XML.Security.EncryptedKey	FindEncryptedKey (_.Library.Boolean usedAsSigningKey)
	Find an EncryptedKey element. More...

_.SOAP.Security.Element	FindLastElement (_.Library.String type, _.Library.String pos)
	Find the last security element of the specified type and return the element. More...

Public Member Functions inherited from Header
_.Library.String	GetId ()
	Return the value of the Id property. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Static Public Member Functions
	GetSecurityNamespace ()
	Return the default WS-Security namespace.

_.Library.Boolean	IsSecurityNamespace (_.Library.String namespace)
	Return true if the specified namespace is a valid namespace for a WS-Security header.

Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Public Attributes
	Namespace
	The actual XML namespace for this header. More...

	SecurityContextToken
	The SecurityContextToken obtained from the received Security header while. More...

	Signature
	If the Security header has a Signature, then the XML.Security.Signature instance. More...

	UsernameToken
	The UsernameToken which was in an imported Security header. More...

Public Attributes inherited from Header
	Fault
	Fault which is to be returned by web service based on error importing the header. More...

	XmlId
	The xml:id attribute to be added to the header element when writing a SOAP message. More...

	actor
	SOAP 1.1 uses actor. More...

	mustUnderstand
	More...

	role
	SOAP 1.2 uses role instead of actor. More...

Additional Inherited Members
Static Public Attributes inherited from Header
	OUTPUTTYPEATTRIBUTE = None
	OUTPUTTYPEATTRIBUTE allows the programmer to force the xsi:type attribute to be included. More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Detailed Description

OASIS Web Services Security SOAP header.

Member Function Documentation

◆ AddSecurityElement()

_.Library.Status AddSecurityElement	(	_.SOAP.Security.Element	element,
			position
	)

Add an element to the Security header.

If position is specified as a SOAP.Security.Element subclass, then the element is added after this element. Otherwise, position is the Integer position at which to the element is added. If position=-1, then the element is added after all elements.
If position is not specified, the position depends on which type of element is added. Token elements are those which do not specify signature (Signature) or encryption (ReferenceList or EncryptedKey with ReferenceList) are added after all previously added token elements. The exception is the Timestamp element always goes first.
If any tokens which are to be encrypted are added, they should be added after the EncryptedKey element is added and should be postioned after the EncryptedKey specified as the position argument.
Elements which specify signature (Signature) or encryption (ReferenceList or EncryptedKey with ReferenceList) are added following all tokens elements and thus before all other non-token elements.
This method replaces the deprecated methods AddToken and AddElement. There is no need to modify existing code, but if you choose to do so, you can simply replace references to AddToken and AddElement with references to AddSecurityToken. It is not necessary to adjust the argument lists.

◆ FindByEncryptedKeySHA1()

_.SOAP.Security.Element FindByEncryptedKeySHA1 ( _.Library.Binary encryptedKeySHA1 )

Find the key from an EncryptedKey element which corresponds to the EncryptedKeySHA1 argument.

Return the key if found, else "".

◆ FindElement()

_.SOAP.Security.Element FindElement	(	_.Library.String	type,
		_.Library.String	pos
	)

Find the first security element of the specified type after position pos and return the element.

Return "" if no element of the specified type is found. Types are Timestamp, BinarySecurityToken, UsernameToken, Signature, SignatureConfirmation, EncryptedKey.

◆ FindEncryptedKey()

_.XML.Security.EncryptedKey FindEncryptedKey ( _.Library.Boolean usedAsSigningKey )

Find an EncryptedKey element.

Return the key if found, else "".

◆ FindLastElement()

_.SOAP.Security.Element FindLastElement	(	_.Library.String	type,
		_.Library.String	pos
	)

Find the last security element of the specified type and return the element.

Return "" if no element of the specified type is found. Types are Timestamp, BinarySecurityToken, UsernameToken, Signature, SignatureConfirmation, EncryptedKey.

Member Data Documentation

◆ Namespace

Namespace

The actual XML namespace for this header.

◆ SecurityContextToken

SecurityContextToken

The SecurityContextToken obtained from the received Security header while.

the SecurityContextToken is being validated. This token may be used in the response.

◆ Signature

Signature

If the Security header has a Signature, then the XML.Security.Signature instance.

instance corresponding to the signature is stored here.

◆ UsernameToken

UsernameToken

The UsernameToken which was in an imported Security header.

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members