modules/core/src/main/java/org/apache/sandesha2/wsrm/SequenceAcknowledgement.java - sandesha - Git at Google

 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements. See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership. The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License. You may obtain a copy of the License at
  *
  * http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */

 package org.apache.sandesha2.wsrm;

 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;

 import javax.xml.namespace.QName;

 import org.apache.axiom.om.OMAttribute;
 import org.apache.axiom.om.OMElement;
 import org.apache.axiom.om.OMException;
 import org.apache.axiom.om.OMFactory;
 import org.apache.axiom.om.OMNamespace;
 import org.apache.axiom.soap.SOAPHeader;
 import org.apache.axiom.soap.SOAPHeaderBlock;
 import org.apache.sandesha2.Sandesha2Constants;
 import org.apache.sandesha2.SandeshaException;
 import org.apache.sandesha2.i18n.SandeshaMessageHelper;
 import org.apache.sandesha2.i18n.SandeshaMessageKeys;
 import org.apache.sandesha2.util.Range;
 import org.apache.sandesha2.util.SpecSpecificConstants;

 /**
  * Adds the SequenceAcknowledgement header block.
  *
  * Either RM10 or RM11 namespace supported
  */
 public class SequenceAcknowledgement implements RMHeaderPart {

 	private Identifier identifier;
 	private ArrayList<Range> acknowledgementRangeList;
 	private ArrayList<Long> nackList;
 	private String namespaceValue = null;
 	private OMNamespace omNamespace = null;
 	private boolean ackNone = false;
 	private boolean ackFinal = false;
 	private boolean piggybacked = false;

 	private OMElement originalSequenceAckElement;

 	public SequenceAcknowledgement(String namespaceValue, boolean _piggybacked) {
 		this.namespaceValue = namespaceValue;
 		if (Sandesha2Constants.SPEC_2005_02.NS_URI.equals(namespaceValue)) {
 			omNamespace = Sandesha2Constants.SPEC_2005_02.OM_NS_URI;
 		}else{
 			omNamespace = Sandesha2Constants.SPEC_2007_02.OM_NS_URI;
 		}
 		acknowledgementRangeList = new ArrayList<Range>();
 		nackList = new ArrayList<Long>();
 		piggybacked = _piggybacked;
 	}

 	public String getNamespaceValue() {
 		return namespaceValue;
 	}

 	public Object fromHeaderBlock(SOAPHeaderBlock sequenceAckElement) throws OMException,SandeshaException {
 		originalSequenceAckElement = sequenceAckElement.cloneOMElement();
 		OMElement identifierPart = null;
 		Iterator childElements = sequenceAckElement.getChildElements();
 		while(childElements.hasNext()){
 			OMElement element = (OMElement)childElements.next();
 			String elementNamespace = element.getQName().getNamespaceURI();
 			String elementLocalName = element.getQName().getLocalPart();
 			if(namespaceValue.equals(elementNamespace)){
 				if(Sandesha2Constants.WSRM_COMMON.ACK_RANGE.equals(elementLocalName)){
 					String lowerAttribValue = element.getAttributeValue(new QName(
 							Sandesha2Constants.WSRM_COMMON.LOWER));
 					String upperAttribValue = element.getAttributeValue(new QName(
 							Sandesha2Constants.WSRM_COMMON.UPPER));

 					if (lowerAttribValue == null || upperAttribValue == null)
 						throw new OMException(
 								SandeshaMessageHelper.getMessage(
 										SandeshaMessageKeys.noUpperOrLowerAttributesInElement,
 										element.toString()));

 					try {
 						long lower = Long.parseLong(lowerAttribValue);
 						long upper = Long.parseLong(upperAttribValue);
 						acknowledgementRangeList.add(new Range(lower, upper));
 					} catch (Exception ex) {
 						throw new OMException(
 								SandeshaMessageHelper.getMessage(
 										SandeshaMessageKeys.ackRandDoesNotHaveCorrectValues,
 										element.toString()));
 					}
 				}else if(Sandesha2Constants.WSRM_COMMON.NACK.equals(elementLocalName)){
 					try {
 						Long nack = Long.valueOf(element.getText());
 						nackList.add(nack);
 					}catch (Exception ex ) {
 						throw new OMException (SandeshaMessageHelper.getMessage(
 								SandeshaMessageKeys.nackDoesNotContainValidLongValue));
 					}
 				}else if(Sandesha2Constants.WSRM_COMMON.IDENTIFIER.equals(elementLocalName)){
 					identifierPart = element;
 				}else {
 					String rmSpecVersion = SpecSpecificConstants.getSpecVersionString (namespaceValue);
 					if (SpecSpecificConstants.isAckFinalAllowed(rmSpecVersion)) {
 						if(Sandesha2Constants.WSRM_COMMON.FINAL.equals(elementLocalName)){
 							ackFinal = true;
 						}
 					}
 					if (SpecSpecificConstants.isAckNoneAllowed(rmSpecVersion)) {
 						if(Sandesha2Constants.WSRM_COMMON.NONE.equals(elementLocalName)){
 							ackNone = true;
 						}
 					}
 				}
 			}
 		}

 		identifier = new Identifier(namespaceValue);
 		identifier.fromOMElement(identifierPart);

 		// Indicate that we have processed this part of the message.
 		sequenceAckElement.setProcessed();
 		return this;
 	}

 	public void setIdentifier(Identifier identifier) {
 		this.identifier = identifier;
 	}

 	public void setAckRanges(ArrayList<Range> acknowledgementRagngesList) {
 		acknowledgementRangeList = acknowledgementRagngesList;
 	}

 	public Long addNack(Long nack) {
 		nackList.add(nack);
 		return nack;
 	}

 	public Range addAcknowledgementRanges(
 			Range ackRange) {
 		acknowledgementRangeList.add(ackRange);
 		return ackRange;
 	}

 	public Identifier getIdentifier() {
 		return identifier;
 	}

 	public List<Range> getAcknowledgementRanges() {
 		return acknowledgementRangeList;
 	}

 	public List<Long> getNackList() {
 		return nackList;
 	}

 	public boolean getAckFinal() {
 		return ackFinal;
 	}

 	public void setAckFinal(boolean ackFinal) {
 		this.ackFinal = ackFinal;
 	}

 	public boolean getAckNone() {
 		return ackNone;
 	}

 	public void setAckNone(boolean ackNone) {
 		this.ackNone = ackNone;
 	}

 	public OMElement getOriginalSequenceAckElement() {
 		return originalSequenceAckElement;
 	}

 	public void toHeader(SOAPHeader header) throws SandeshaException{
 		SOAPHeaderBlock sequenceAcknowledgementHeaderBlock = header.addHeaderBlock(
 				Sandesha2Constants.WSRM_COMMON.SEQUENCE_ACK,omNamespace);

 		if (identifier == null)
 			throw new OMException(
 					SandeshaMessageHelper.getMessage(
 							SandeshaMessageKeys.invalidIdentifier,
 							header.toString()));

 		// SequenceACK messages should always have the MustUnderstand flag set to true
 		// Unless it is a piggybacked ack
 		if(piggybacked){
 			sequenceAcknowledgementHeaderBlock.setMustUnderstand(false);
 		} else {
 			sequenceAcknowledgementHeaderBlock.setMustUnderstand(true);
 		}

 		identifier.toOMElement(sequenceAcknowledgementHeaderBlock, omNamespace);

 		Iterator<Range> ackRangeIt = acknowledgementRangeList.iterator();
 		while (ackRangeIt.hasNext()) {
 			Range ackRange = (Range) ackRangeIt.next();

 			if (ackRange.upperValue <= 0 || ackRange.lowerValue <= 0 || ackRange.lowerValue > ackRange.upperValue)
 				throw new OMException(
 						SandeshaMessageHelper.getMessage(
 								SandeshaMessageKeys.ackRandDoesNotHaveCorrectValues,
 								ackRange.upperValue + ":" + ackRange.lowerValue));

 			OMFactory factory = sequenceAcknowledgementHeaderBlock.getOMFactory();

 			OMAttribute lowerAttrib = factory.createOMAttribute(
 					Sandesha2Constants.WSRM_COMMON.LOWER, null, Long.toString(ackRange.lowerValue));
 			OMAttribute upperAttrib = factory.createOMAttribute(
 					Sandesha2Constants.WSRM_COMMON.UPPER, null, Long.toString(ackRange.upperValue));

 			OMElement acknowledgementRangeElement = factory.createOMElement(Sandesha2Constants.WSRM_COMMON.ACK_RANGE, omNamespace);

 			acknowledgementRangeElement.addAttribute(lowerAttrib);
 			acknowledgementRangeElement.addAttribute(upperAttrib);
 			sequenceAcknowledgementHeaderBlock.addChild(acknowledgementRangeElement);
 		}

 		Iterator<Long> nackIt = nackList.iterator();
 		while (nackIt.hasNext()) {
 			Long nack = (Long) nackIt.next();

 			if (nack.longValue()<=0)
 				throw new OMException (SandeshaMessageHelper.getMessage(
 						SandeshaMessageKeys.nackDoesNotContainValidLongValue));

 			OMElement nackElement = sequenceAcknowledgementHeaderBlock.getOMFactory().createOMElement(Sandesha2Constants.WSRM_COMMON.NACK,omNamespace);
 			nackElement.setText(nack.toString());
 			sequenceAcknowledgementHeaderBlock.addChild(nackElement);
 		}

 		String rmSpecVersion = SpecSpecificConstants.getSpecVersionString(namespaceValue);

 		//setting a 'None' when nothing is there (for the correct RM version)
 		if (ackNone==false && acknowledgementRangeList.size()==0 && nackList.size()==0 && SpecSpecificConstants.isAckNoneAllowed(rmSpecVersion)) {
 			ackNone = true;
 		}

 		if (ackNone!=false) {
 			if (!SpecSpecificConstants.isAckNoneAllowed(rmSpecVersion)) {
 				throw new SandeshaException (SandeshaMessageHelper.getMessage(
 						SandeshaMessageKeys.noneNotAllowedNamespace,
 						rmSpecVersion));
 			}

 			if (acknowledgementRangeList.size()>0) {
 				throw new SandeshaException (SandeshaMessageHelper.getMessage(
 						SandeshaMessageKeys.noneNotAllowedAckRangesPresent));
 			}

 			if (nackList.size()>0) {
 				throw new SandeshaException (SandeshaMessageHelper.getMessage(
 						SandeshaMessageKeys.noneNotAllowedNackPresent));
 			}
 			OMElement noneElement = sequenceAcknowledgementHeaderBlock.getOMFactory().createOMElement(Sandesha2Constants.WSRM_COMMON.NONE, omNamespace);
 			sequenceAcknowledgementHeaderBlock.addChild(noneElement);
 		}

 		if (ackFinal!=false) {
 			if (!SpecSpecificConstants.isAckFinalAllowed(rmSpecVersion)) {
 				throw new SandeshaException (SandeshaMessageHelper.getMessage(
 						SandeshaMessageKeys.finalNotAllowedNamespace));
 			}

 			if (nackList.size()>0) {
 				throw new SandeshaException (SandeshaMessageHelper.getMessage(
 						SandeshaMessageKeys.cannotHaveFinalWithNack));
 			}
 			OMElement finalElement = sequenceAcknowledgementHeaderBlock.getOMFactory().createOMElement(Sandesha2Constants.WSRM_COMMON.FINAL, omNamespace);
 			sequenceAcknowledgementHeaderBlock.addChild(finalElement);
 		}
 	}
 }
	/*
	* Licensed to the Apache Software Foundation (ASF) under one
	* or more contributor license agreements. See the NOTICE file
	* distributed with this work for additional information
	* regarding copyright ownership. The ASF licenses this file
	* to you under the Apache License, Version 2.0 (the
	* "License"); you may not use this file except in compliance
	* with the License. You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing,
	* software distributed under the License is distributed on an
	* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	* KIND, either express or implied. See the License for the
	* specific language governing permissions and limitations
	* under the License.
	*/

	package org.apache.sandesha2.wsrm;

	import java.util.ArrayList;
	import java.util.Iterator;
	import java.util.List;

	import javax.xml.namespace.QName;

	import org.apache.axiom.om.OMAttribute;
	import org.apache.axiom.om.OMElement;
	import org.apache.axiom.om.OMException;
	import org.apache.axiom.om.OMFactory;
	import org.apache.axiom.om.OMNamespace;
	import org.apache.axiom.soap.SOAPHeader;
	import org.apache.axiom.soap.SOAPHeaderBlock;
	import org.apache.sandesha2.Sandesha2Constants;
	import org.apache.sandesha2.SandeshaException;
	import org.apache.sandesha2.i18n.SandeshaMessageHelper;
	import org.apache.sandesha2.i18n.SandeshaMessageKeys;
	import org.apache.sandesha2.util.Range;
	import org.apache.sandesha2.util.SpecSpecificConstants;

	/**
	* Adds the SequenceAcknowledgement header block.
	*
	* Either RM10 or RM11 namespace supported
	*/
	public class SequenceAcknowledgement implements RMHeaderPart {

	private Identifier identifier;
	private ArrayList<Range> acknowledgementRangeList;
	private ArrayList<Long> nackList;
	private String namespaceValue = null;
	private OMNamespace omNamespace = null;
	private boolean ackNone = false;
	private boolean ackFinal = false;
	private boolean piggybacked = false;

	private OMElement originalSequenceAckElement;

	public SequenceAcknowledgement(String namespaceValue, boolean _piggybacked) {
	this.namespaceValue = namespaceValue;
	if (Sandesha2Constants.SPEC_2005_02.NS_URI.equals(namespaceValue)) {
	omNamespace = Sandesha2Constants.SPEC_2005_02.OM_NS_URI;
	}else{
	omNamespace = Sandesha2Constants.SPEC_2007_02.OM_NS_URI;
	}
	acknowledgementRangeList = new ArrayList<Range>();
	nackList = new ArrayList<Long>();
	piggybacked = _piggybacked;
	}

	public String getNamespaceValue() {
	return namespaceValue;
	}

	public Object fromHeaderBlock(SOAPHeaderBlock sequenceAckElement) throws OMException,SandeshaException {
	originalSequenceAckElement = sequenceAckElement.cloneOMElement();
	OMElement identifierPart = null;
	Iterator childElements = sequenceAckElement.getChildElements();
	while(childElements.hasNext()){
	OMElement element = (OMElement)childElements.next();
	String elementNamespace = element.getQName().getNamespaceURI();
	String elementLocalName = element.getQName().getLocalPart();
	if(namespaceValue.equals(elementNamespace)){
	if(Sandesha2Constants.WSRM_COMMON.ACK_RANGE.equals(elementLocalName)){
	String lowerAttribValue = element.getAttributeValue(new QName(
	Sandesha2Constants.WSRM_COMMON.LOWER));
	String upperAttribValue = element.getAttributeValue(new QName(
	Sandesha2Constants.WSRM_COMMON.UPPER));

	if (lowerAttribValue == null \|\| upperAttribValue == null)
	throw new OMException(
	SandeshaMessageHelper.getMessage(
	SandeshaMessageKeys.noUpperOrLowerAttributesInElement,
	element.toString()));

	try {
	long lower = Long.parseLong(lowerAttribValue);
	long upper = Long.parseLong(upperAttribValue);
	acknowledgementRangeList.add(new Range(lower, upper));
	} catch (Exception ex) {
	throw new OMException(
	SandeshaMessageHelper.getMessage(
	SandeshaMessageKeys.ackRandDoesNotHaveCorrectValues,
	element.toString()));
	}
	}else if(Sandesha2Constants.WSRM_COMMON.NACK.equals(elementLocalName)){
	try {
	Long nack = Long.valueOf(element.getText());
	nackList.add(nack);
	}catch (Exception ex ) {
	throw new OMException (SandeshaMessageHelper.getMessage(
	SandeshaMessageKeys.nackDoesNotContainValidLongValue));
	}
	}else if(Sandesha2Constants.WSRM_COMMON.IDENTIFIER.equals(elementLocalName)){
	identifierPart = element;
	}else {
	String rmSpecVersion = SpecSpecificConstants.getSpecVersionString (namespaceValue);
	if (SpecSpecificConstants.isAckFinalAllowed(rmSpecVersion)) {
	if(Sandesha2Constants.WSRM_COMMON.FINAL.equals(elementLocalName)){
	ackFinal = true;
	}
	}
	if (SpecSpecificConstants.isAckNoneAllowed(rmSpecVersion)) {
	if(Sandesha2Constants.WSRM_COMMON.NONE.equals(elementLocalName)){
	ackNone = true;
	}
	}
	}
	}
	}

	identifier = new Identifier(namespaceValue);
	identifier.fromOMElement(identifierPart);

	// Indicate that we have processed this part of the message.
	sequenceAckElement.setProcessed();
	return this;
	}

	public void setIdentifier(Identifier identifier) {
	this.identifier = identifier;
	}

	public void setAckRanges(ArrayList<Range> acknowledgementRagngesList) {
	acknowledgementRangeList = acknowledgementRagngesList;
	}

	public Long addNack(Long nack) {
	nackList.add(nack);
	return nack;
	}

	public Range addAcknowledgementRanges(
	Range ackRange) {
	acknowledgementRangeList.add(ackRange);
	return ackRange;
	}

	public Identifier getIdentifier() {
	return identifier;
	}

	public List<Range> getAcknowledgementRanges() {
	return acknowledgementRangeList;
	}

	public List<Long> getNackList() {
	return nackList;
	}

	public boolean getAckFinal() {
	return ackFinal;
	}

	public void setAckFinal(boolean ackFinal) {
	this.ackFinal = ackFinal;
	}

	public boolean getAckNone() {
	return ackNone;
	}

	public void setAckNone(boolean ackNone) {
	this.ackNone = ackNone;
	}

	public OMElement getOriginalSequenceAckElement() {
	return originalSequenceAckElement;
	}

	public void toHeader(SOAPHeader header) throws SandeshaException{
	SOAPHeaderBlock sequenceAcknowledgementHeaderBlock = header.addHeaderBlock(
	Sandesha2Constants.WSRM_COMMON.SEQUENCE_ACK,omNamespace);

	if (identifier == null)
	throw new OMException(
	SandeshaMessageHelper.getMessage(
	SandeshaMessageKeys.invalidIdentifier,
	header.toString()));

	// SequenceACK messages should always have the MustUnderstand flag set to true
	// Unless it is a piggybacked ack
	if(piggybacked){
	sequenceAcknowledgementHeaderBlock.setMustUnderstand(false);
	} else {
	sequenceAcknowledgementHeaderBlock.setMustUnderstand(true);
	}

	identifier.toOMElement(sequenceAcknowledgementHeaderBlock, omNamespace);

	Iterator<Range> ackRangeIt = acknowledgementRangeList.iterator();
	while (ackRangeIt.hasNext()) {
	Range ackRange = (Range) ackRangeIt.next();

	if (ackRange.upperValue <= 0 \|\| ackRange.lowerValue <= 0 \|\| ackRange.lowerValue > ackRange.upperValue)
	throw new OMException(
	SandeshaMessageHelper.getMessage(
	SandeshaMessageKeys.ackRandDoesNotHaveCorrectValues,
	ackRange.upperValue + ":" + ackRange.lowerValue));

	OMFactory factory = sequenceAcknowledgementHeaderBlock.getOMFactory();

	OMAttribute lowerAttrib = factory.createOMAttribute(
	Sandesha2Constants.WSRM_COMMON.LOWER, null, Long.toString(ackRange.lowerValue));
	OMAttribute upperAttrib = factory.createOMAttribute(
	Sandesha2Constants.WSRM_COMMON.UPPER, null, Long.toString(ackRange.upperValue));

	OMElement acknowledgementRangeElement = factory.createOMElement(Sandesha2Constants.WSRM_COMMON.ACK_RANGE, omNamespace);

	acknowledgementRangeElement.addAttribute(lowerAttrib);
	acknowledgementRangeElement.addAttribute(upperAttrib);
	sequenceAcknowledgementHeaderBlock.addChild(acknowledgementRangeElement);
	}

	Iterator<Long> nackIt = nackList.iterator();
	while (nackIt.hasNext()) {
	Long nack = (Long) nackIt.next();

	if (nack.longValue()<=0)
	throw new OMException (SandeshaMessageHelper.getMessage(
	SandeshaMessageKeys.nackDoesNotContainValidLongValue));

	OMElement nackElement = sequenceAcknowledgementHeaderBlock.getOMFactory().createOMElement(Sandesha2Constants.WSRM_COMMON.NACK,omNamespace);
	nackElement.setText(nack.toString());
	sequenceAcknowledgementHeaderBlock.addChild(nackElement);
	}

	String rmSpecVersion = SpecSpecificConstants.getSpecVersionString(namespaceValue);

	//setting a 'None' when nothing is there (for the correct RM version)
	if (ackNone==false && acknowledgementRangeList.size()==0 && nackList.size()==0 && SpecSpecificConstants.isAckNoneAllowed(rmSpecVersion)) {
	ackNone = true;
	}

	if (ackNone!=false) {
	if (!SpecSpecificConstants.isAckNoneAllowed(rmSpecVersion)) {
	throw new SandeshaException (SandeshaMessageHelper.getMessage(
	SandeshaMessageKeys.noneNotAllowedNamespace,
	rmSpecVersion));
	}

	if (acknowledgementRangeList.size()>0) {
	throw new SandeshaException (SandeshaMessageHelper.getMessage(
	SandeshaMessageKeys.noneNotAllowedAckRangesPresent));
	}

	if (nackList.size()>0) {
	throw new SandeshaException (SandeshaMessageHelper.getMessage(
	SandeshaMessageKeys.noneNotAllowedNackPresent));
	}
	OMElement noneElement = sequenceAcknowledgementHeaderBlock.getOMFactory().createOMElement(Sandesha2Constants.WSRM_COMMON.NONE, omNamespace);
	sequenceAcknowledgementHeaderBlock.addChild(noneElement);
	}

	if (ackFinal!=false) {
	if (!SpecSpecificConstants.isAckFinalAllowed(rmSpecVersion)) {
	throw new SandeshaException (SandeshaMessageHelper.getMessage(
	SandeshaMessageKeys.finalNotAllowedNamespace));
	}

	if (nackList.size()>0) {
	throw new SandeshaException (SandeshaMessageHelper.getMessage(
	SandeshaMessageKeys.cannotHaveFinalWithNack));
	}
	OMElement finalElement = sequenceAcknowledgementHeaderBlock.getOMFactory().createOMElement(Sandesha2Constants.WSRM_COMMON.FINAL, omNamespace);
	sequenceAcknowledgementHeaderBlock.addChild(finalElement);
	}
	}
	}