Generate SOAP message from Java class

[Atul Mishra]

Hi All,

In my requirement I have to generate SOAP message from a java class.
The sending portion will be handled by a framework [ our firm has a framework built over JMS], so I just need to create a message only.

I tried to use these methods

MessageFactory messageFactory = MessageFactory.newInstance();
SOAPMessage message = messageFactory.createMessage();

//Create objects for the message parts
SOAPPart soapPart = message.getSOAPPart();

in a simple program but while running it throws the following exception

xception in thread "main" java.lang.NoClassDefFoundError: com/ibm/ws/ffdc/FFDCFilter
at javax.xml.soap.MessageFactory.newInstance(MessageFactory.java:197)

So, I am thinking I somehow am not proceeding correct.

Can anyone please provide suggestions ?

Thanks

[Gaurav Purandare]

No Class Def Found Exeption usually means that the class path was not set properly,
Have you checked that all the libraries are included in classpath.

[Atul Mishra]

Gaurav,

First thanks for the reply.

I have the j2ee.jar added. But the complaint is about an IBM file.

My enironment is eclipse and I dont have [I dont need to have any IBM dependancy]

So thats why I am confused when it threw an IBM related exception

I want to use javax.xml.soap package.

Thanks

[Atul Mishra]

Could anyone please mention on how to generate SOAP message from a Java class.

Thanks

[Rob Spoor]

Moving to the Web Services forum.

[shivendra tripathi]

use AXIOM soap api to generate soap envelope. AXIOM is provided by apache and quite handy. following link is useful as well.
http://www.nabble.com/How-to-create-a-soap-envelope-using-AXIOM--to13848521.html
dont forget to keep axiom related jar in class path, otherwise you will get classNotFound exception

[Atul Mishra]

use AXIOM soap api to generate soap envelope. AXIOM is provided by apache and quite handy. following link is useful as well.
http://www.nabble.com/How-to-create-a-soap-envelope-using-AXIOM--to13848521.html
dont forget to keep axiom related jar in class path, otherwise you will get classNotFound exception

Thanks for the suggestion, but unfortunately we wont be able to use any external APIs.

Can I achieve this by using SAAJ ?

Thanks

[Ivan Krizsan]

Hi!
You can use SAAJ to create and populate SOAP messages. To make life a little easier, you can use JAXB to marshal and unmarshal the contents of the SOAP body, if you want to. Both these APIs are part of the JRE 6.
The following code shows how to create SOAP messages using SAAJ:

    /**
     * Creates an instance of this class and performs the following
     * initialization:<br/>
     * - Creates a SOAP 1.2 messages factory.<br/>
     * - Creates a factory that creates objects associated with SOAP
     * messages.<br/>
     * 
     * @throws SOAPException If error occurs creating SOAP factory.
     */
    public SAAJExamples() throws SOAPException
    {
        /*
         * Create a factory for creating SOAP message objects. A
         * message factory can be configured to create SOAP 1.2
         * messages, as in the case below, or SOAP 1.1 messages or to
         * allow for both versions of SOAP messages. The latter allow
         * for processing of incoming SOAP 1.1 and 1.2 messages.
         */
        mSOAPMsgFactory =
            MessageFactory.newInstance(SOAPConstants.SOAP_1_2_PROTOCOL);

        /*
         * Create a factory that creates various objects that can
         * exist in a SOAP message.
         */
        mSOAPObjectsFactory = SOAPFactory.newInstance();
    }

    /**
     * Creates an empty SOAP message. The code in this method also
     * demonstrates how to access the different parts of a SOAP
     * message.
     * 
     * @return Empty SOAP message.
     * @throws SOAPException If error occurs creating or accessing
     * SOAP message.
     */
    public SOAPMessage createEmptySOAPMessage() throws SOAPException
    {
        SOAPMessage theMsg = mSOAPMsgFactory.createMessage();

        /*
         * Here, different ways of accessing the different parts of a
         * SOAP message are shown. First going via the SOAP part and
         * the SOAP envelope...
         */
        SOAPPart thePart = theMsg.getSOAPPart();
        SOAPEnvelope theEnvelope = thePart.getEnvelope();
        SOAPBody theBody = theEnvelope.getBody();
        SOAPHeader theHeader = theEnvelope.getHeader();

        System.out.println("The long way:");
        System.out.println(" The SOAP part: " + thePart);
        System.out.println(" The SOAP envelope: " + theEnvelope);
        System.out.println(" The SOAP body: " + theBody);
        System.out.println(" The SOAP header: " + theHeader);

        /* A faster way... */
        theBody = theMsg.getSOAPBody();
        theHeader = theMsg.getSOAPHeader();

        System.out.println("The short way:");
        System.out.println(" The SOAP body: " + theBody);
        System.out.println(" The SOAP header: " + theHeader);

        return theMsg;
    }

    /**
     * Creates an empty SOAP message. The code in this method also
     * demonstrates how to access the different parts of a SOAP
     * message.
     * 
     * @return Empty SOAP message.
     * @throws SOAPException If error occurs creating or accessing
     * SOAP message.
     * @throws IOException If error occurs reading file containing
     * SOAP message.
     */
    public SOAPMessage createSOAPMessageFromFile() throws SOAPException,
        IOException
    {
        /*
         * Prepare stream reading from file containing SOAP message
         * and an object containing the MIME headers. It is also
         * possible to supply a null MimeHeaders object, in which case
         * an empty one will be created when the SOAP message is
         * created. In this example we do not include any MIME
         * headers.
         * 
         * Note that if the format of the SOAP message in the file is
         * illegal, there will not be any errors until we try to get
         * some part of the SOAP message, for instance the body. To
         * see this behavior, change the protocol when retrieving the
         * message factory above to SOAP 1.1.
         */
        FileInputStream theFIS = new FileInputStream(SOAP_FILE);
        MimeHeaders theMimeHdrs = new MimeHeaders();
        SOAPMessage theMsg = mSOAPMsgFactory.createMessage(theMimeHdrs, theFIS);
        theFIS.close();

        SOAPBody theBody = theMsg.getSOAPBody();
        SOAPHeader theHeader = theMsg.getSOAPHeader();

        System.out.println("Retrieving parts of SOAP message:");
        System.out.println(" The SOAP body: " + theBody);
        System.out.println(" The SOAP header: " + theHeader);

        return theMsg;
    }

Best wishes!

[Atul Mishra]

Thanks for the code Ivan..

Unfortunately have a 1.5 limitation..

Trying your code now.

Please suggest on additional jars needed if using 1.5

Thanks
Atul

[Ulf Dittmer]

Isn't this kind of the same discussion as this one: http://www.coderanch.com/t/452113/Web-Services/java/SOAP-body-Java-client ? Maybe it should be continued in just one topic?

[Summer liki]

in java5, you could add two more jar files: saaj.jar, saaj-api.jar. Then use the code like below:
DocumentBuilder oBuilder = oDocFactory.newDocumentBuilder();
Document oDoc = oBuilder.parse(new File("xxx"));

MessageFactory oMsgFac = MessageFactory
.newInstance(SOAPConstants.SOAP_1_1_PROTOCOL);
SOAPMessage oMessage = oMsgFac.createMessage();
SOAPBody oBody = oMessage.getSOAPBody();
oBody.addDocument(oDoc);

[Atul Mishra]

The problem I am facing is the company standards
Have anyone use Artix lite to generate SOAP messages ?