AckRequested.java

/*
 * Copyright(c) 2002 Center for E-Commerce Infrastructure Development, The
 * University of Hong Kong (HKU). All Rights Reserved.
 *
 * This software is licensed under the Academic Free License Version 1.0
 *
 * Academic Free License
 * Version 1.0
 *
 * This Academic Free License applies to any software and associated 
 * documentation (the "Software") whose owner (the "Licensor") has placed the 
 * statement "Licensed under the Academic Free License Version 1.0" immediately 
 * after the copyright notice that applies to the Software. 
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy 
 * of the Software (1) to use, copy, modify, merge, publish, perform, 
 * distribute, sublicense, and/or sell copies of the Software, and to permit 
 * persons to whom the Software is furnished to do so, and (2) under patent 
 * claims owned or controlled by the Licensor that are embodied in the Software 
 * as furnished by the Licensor, to make, use, sell and offer for sale the 
 * Software and derivative works thereof, subject to the following conditions: 
 *
 * - Redistributions of the Software in source code form must retain all 
 *   copyright notices in the Software as furnished by the Licensor, this list 
 *   of conditions, and the following disclaimers. 
 * - Redistributions of the Software in executable form must reproduce all 
 *   copyright notices in the Software as furnished by the Licensor, this list 
 *   of conditions, and the following disclaimers in the documentation and/or 
 *   other materials provided with the distribution. 
 * - Neither the names of Licensor, nor the names of any contributors to the 
 *   Software, nor any of their trademarks or service marks, may be used to 
 *   endorse or promote products derived from this Software without express 
 *   prior written permission of the Licensor. 
 *
 * DISCLAIMERS: LICENSOR WARRANTS THAT THE COPYRIGHT IN AND TO THE SOFTWARE IS 
 * OWNED BY THE LICENSOR OR THAT THE SOFTWARE IS DISTRIBUTED BY LICENSOR UNDER 
 * A VALID CURRENT LICENSE. EXCEPT AS EXPRESSLY STATED IN THE IMMEDIATELY 
 * PRECEDING SENTENCE, THE SOFTWARE IS PROVIDED BY THE LICENSOR, CONTRIBUTORS 
 * AND COPYRIGHT OWNERS "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE 
 * LICENSOR, CONTRIBUTORS OR COPYRIGHT OWNERS BE LIABLE FOR ANY CLAIM, DAMAGES 
 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE. 
 *
 * This license is Copyright (C) 2002 Lawrence E. Rosen. All rights reserved. 
 * Permission is hereby granted to copy and distribute this license without 
 * modification. This license may not be modified without the express written 
 * permission of its copyright owner. 
 */

/* ===== 
 *
 * $Header: /home/cvsroot/ebxml-pkg/src/hk/hku/cecid/ebms/pkg/AckRequested.java,v 1.1 2005/07/28 09:36:24 dcmsze Exp $
 *
 * Code authored by:
 *
 * cyng [2002-03-21]
 *
 * Code reviewed by:
 *
 * username [YYYY-MM-DD]
 *
 * Remarks:
 *
 * =====
 */

package hk.hku.cecid.ebms.pkg;

import javax.xml.soap.SOAPElement;
import javax.xml.soap.SOAPEnvelope;
import javax.xml.soap.SOAPException;

/**
 * An ebXML <code>AckRequested</code> in the SOAP Header of a
 * <code>HeaderContainer</code> [ebMSS 6.3.1].
 *
 * @author cyng
 * @version $Revision: 1.1 $
 */
public class AckRequested extends HeaderElement {

    /** <code>AckRequested</code> element name. */
    static final String ACK_REQUESTED = "AckRequested";

    /* Constants for AckRequested elements */
    /** Name of the Signed attribute. */
    static final String ATTRIBUTE_SIGNED = "signed";

    private final boolean signed;

    /** 
     * Constructs a <code>AckRequested</code> with the given mandatory
     * fields.
     *
     * @param soapEnvelope      <code>SOAPEnvelope</code>, the header of which
     *                          the <code>AckRequested</code> element is added
     *                          to.
     * @param signed            Indicates if a signed acknowledgement response
     *                          is requested. True if a signed response is 
     *                          requested; false otherwise.
     * @throws SOAPException 
    */
    AckRequested(SOAPEnvelope soapEnvelope, boolean signed)
        throws SOAPException {
        super(soapEnvelope, ACK_REQUESTED);
        this.signed = signed;
        addAttribute(ATTRIBUTE_SIGNED, String.valueOf(signed));
        setActor(ACTOR_TO_PARTY_MSH_URN);
    }

    /** 
     * Constructs a <code>AckRequested</code> with the given mandatory
     * fields.
     * 
     * @param soapEnvelope      <code>SOAPEnvelope</code>, the header of which
     *                          the <code>AckRequested</code> element is added
     *                          to.
     * @param soapElement       <code>SOAPElement</code> containing
     *                          acknowledgement request.
     * @throws SOAPException 
     */
    AckRequested(SOAPEnvelope soapEnvelope, SOAPElement soapElement)
        throws SOAPException {
        super(soapEnvelope, soapElement);
        final String isSigned = getAttributeValue(ATTRIBUTE_SIGNED);
        if (isSigned == null) {
            signed = false;
        }
        else {
            signed = Boolean.valueOf(isSigned).booleanValue();
        }
    }

    /** 
     * Gets the flag that if a signed acknowledgement response is requested.
     * 
     * @return true if a signed acknowledgement response is requested; false
     *         otherwise.
     */
    public boolean getSigned() {
        return signed;
    }
}