com.ibm.wsspi.wssecurity.wssapi

Class OMStructureFactory

  1. java.lang.Object
  2. extended bycom.ibm.wsspi.wssecurity.wssapi.OMStructureFactory

  1. public abstract class OMStructureFactory
  2. 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

Constructor and Description
OMStructureFactory()

Method Summary

Modifier and Type Method and Description
  1. static
  2. OMStructureFactory
getInstance()
Retrieves an instance of the OMStructureFactory.
  1. abstract
  2. com.ibm.wsspi.wssecurity.wssapi.OMStructure
getOMStructure(org.w3c.dom.Element element)
Create an OMStructure from an org.w3c.dom.Element.
  1. abstract
  2. com.ibm.wsspi.wssecurity.wssapi.OMStructure
getOMStructure(java.io.InputStream is)
Create an OMStructure based on an InputStream for a XML element.
  1. abstract
  2. com.ibm.wsspi.wssecurity.wssapi.OMStructure
getOMStructure(org.apache.axiom.om.OMElement node)
Create an OMStructure from an OMElement element.
  1. abstract
  2. com.ibm.wsspi.wssecurity.wssapi.OMStructure
getOMStructure(java.lang.String strElement)
Create an OMStructure from a java.lang.String
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OMStructureFactory

  1. public OMStructureFactory()

Method Detail

getInstance

  1. public static OMStructureFactory getInstance( )
  2. 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

  1. 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

  1. public abstract com.ibm.wsspi.wssecurity.wssapi.OMStructure getOMStructure( org.w3c.dom.Element element)
  2. 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

  1. public abstract com.ibm.wsspi.wssecurity.wssapi.OMStructure getOMStructure( java.lang.String strElement)
  2. 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

  1. public abstract com.ibm.wsspi.wssecurity.wssapi.OMStructure getOMStructure( java.io.InputStream is)
  2. 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