com.ibm.wsspi.wssecurity.wssapi
Class OMStructureFactory
- java.lang.Object
-
- com.ibm.wsspi.wssecurity.wssapi.OMStructureFactory
-
public abstract class OMStructureFactory extends java.lang.Object
This API is used for the creation of OMStructure elements. An OMStructure object is usually the expected input when a WS-Security api method signature has an XMLStructure.
-
-
Constructor Summary
Constructors Constructor and Description OMStructureFactory()
-
Method Summary
Methods Modifier and Type Method and Description static OMStructureFactory
getInstance()
Retrieves an instance of the OMStructureFactory.abstract com.ibm.wsspi.wssecurity.wssapi.OMStructure
getOMStructure(org.w3c.dom.Element element)
Create an OMStructure from an org.w3c.dom.Element.abstract com.ibm.wsspi.wssecurity.wssapi.OMStructure
getOMStructure(java.io.InputStream is)
Create an OMStructure based on an InputStream for a XML element.abstract com.ibm.wsspi.wssecurity.wssapi.OMStructure
getOMStructure(org.apache.axiom.om.OMElement node)
Create an OMStructure from an OMElement element.abstract com.ibm.wsspi.wssecurity.wssapi.OMStructure
getOMStructure(java.lang.String strElement)
Create an OMStructure from a java.lang.String
-
-
-
Method Detail
-
getInstance
public static OMStructureFactory getInstance() throws WSSException
Retrieves an instance of the OMStructureFactory.- Returns:
- OMStructureFactory object
- Throws:
WSSException
- if the illegal access occurs or if the WSSFactory instance is not generated.
-
getOMStructure
public abstract com.ibm.wsspi.wssecurity.wssapi.OMStructure getOMStructure(org.apache.axiom.om.OMElement node)
Create an OMStructure from an OMElement element.- Parameters:
node
- axiom representation of an element- Returns:
- A populated OMStructure object that can be used with WS-Security apis
-
getOMStructure
public abstract com.ibm.wsspi.wssecurity.wssapi.OMStructure getOMStructure(org.w3c.dom.Element element) throws java.lang.Exception
Create an OMStructure from an org.w3c.dom.Element.- Parameters:
element
- org.w3c.dom representation of an element- Returns:
- A populated OMStructure object that can be used with WS-Security apis
- Throws:
java.lang.Exception
- if org.w3c.dom.Element cannot be converted to an OMElement
-
getOMStructure
public abstract com.ibm.wsspi.wssecurity.wssapi.OMStructure getOMStructure(java.lang.String strElement) throws java.lang.Exception
Create an OMStructure from a java.lang.String- Parameters:
strElement
- String representation of an XML element- Returns:
- A populated OMStructure object that can be used with WS-Security apis
- Throws:
java.lang.Exception
- if String cannot be converted to an OMElement
-
getOMStructure
public abstract com.ibm.wsspi.wssecurity.wssapi.OMStructure getOMStructure(java.io.InputStream is) throws java.lang.Exception
Create an OMStructure based on an InputStream for a XML element.- Parameters:
is
- an InputStream corresponding to a serialized XML element. The programmer is responsible for closing of the stream accordingly.- Returns:
- A populated OMStructure object that can be used with WS-Security apis
- Throws:
java.lang.Exception
- if InputStream cannot be converted to an OMElement
-
-