/**
* 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.cxf.ws.rm;
import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import java.util.TimerTask;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.apache.cxf.common.logging.LogUtils;
import org.apache.cxf.continuations.Continuation;
import org.apache.cxf.continuations.ContinuationProvider;
import org.apache.cxf.continuations.SuspendedInvocationException;
import org.apache.cxf.message.Message;
import org.apache.cxf.ws.addressing.v200408.EndpointReferenceType;
import org.apache.cxf.ws.rm.SequenceAcknowledgement.AcknowledgementRange;
import org.apache.cxf.ws.rm.manager.AcksPolicyType;
import org.apache.cxf.ws.rm.manager.DeliveryAssuranceType;
import org.apache.cxf.ws.rm.persistence.RMStore;
import org.apache.cxf.ws.rm.policy.PolicyUtils;
import org.apache.cxf.ws.rm.policy.RMAssertion;
import org.apache.cxf.ws.rm.policy.RMAssertion.AcknowledgementInterval;
import org.apache.cxf.ws.rm.policy.RMAssertion.InactivityTimeout;
public class DestinationSequence extends AbstractSequence {
private static final Logger LOG = LogUtils.getL7dLogger(DestinationSequence.class);
private Destination destination;
private EndpointReferenceType acksTo;
private long lastMessageNumber;
private SequenceMonitor monitor;
private boolean acknowledgeOnNextOccasion;
private List<DeferredAcknowledgment> deferredAcknowledgments;
private SequenceTermination scheduledTermination;
private String correlationID;
private long inProcessNumber;
private long highNumberCompleted;
private List<Continuation> continuations = new LinkedList<Continuation>();
public DestinationSequence(Identifier i, EndpointReferenceType a, Destination d) {
this(i, a, 0, null);
destination = d;
}
public DestinationSequence(Identifier i, EndpointReferenceType a,
long lmn, SequenceAcknowledgement ac) {
super(i);
acksTo = a;
lastMessageNumber = lmn;
acknowledgement = ac;
if (null == acknowledgement) {
acknowledgement = RMUtils.getWSRMFactory().createSequenceAcknowledgement();
acknowledgement.setIdentifier(id);
}
monitor = new SequenceMonitor();
}
/**
* @return the acksTo address for the sequence
*/
public EndpointReferenceType getAcksTo() {
return acksTo;
}
/**
* @return the message number of the last message or 0 if the last message had not been received.
*/
public long getLastMessageNumber() {
return lastMessageNumber;
}
/**
* @return the sequence acknowledgement presenting the sequences thus far received by a destination
*/
public SequenceAcknowledgement getAcknowledgment() {
return acknowledgement;
}
/**
* @return the identifier of the rm destination
*/
public String getEndpointIdentifier() {
return destination.getName();
}
public void acknowledge(Message message) throws SequenceFault {
SequenceType st = RMContextUtils.retrieveRMProperties(message, false).getSequence();
long messageNumber = st.getMessageNumber().longValue();
LOG.fine("Acknowledging message: " + messageNumber);
if (0 != lastMessageNumber && messageNumber > lastMessageNumber) {
throw new SequenceFaultFactory().createLastMessageNumberExceededFault(st.getIdentifier());
}
monitor.acknowledgeMessage();
synchronized (this) {
boolean done = false;
int i = 0;
for (; i < acknowledgement.getAcknowledgementRange().size(); i++) {
AcknowledgementRange r = acknowledgement.getAcknowledgementRange().get(i);
if (r.getLower().compareTo(messageNumber) <= 0
&& r.getUpper().compareTo(messageNumber) >= 0) {
done = true;
break;
} else {
long diff = r.getLower() - messageNumber;
if (diff == 1) {
r.setLower(messageNumber);
done = true;
} else if (diff > 0) {
break;
} else if (messageNumber - r.getUpper().longValue() == 1) {
r.setUpper(messageNumber);
done = true;
break;
}
}
}
if (!done) {
AcknowledgementRange range = RMUtils.getWSRMFactory()
.createSequenceAcknowledgementAcknowledgementRange();
range.setLower(messageNumber);
range.setUpper(messageNumber);
acknowledgement.getAcknowledgementRange().add(i, range);
}
mergeRanges();
wakeupAll();
}
RMAssertion rma = PolicyUtils.getRMAssertion(destination.getManager().getRMAssertion(), message);
long acknowledgementInterval = 0;
AcknowledgementInterval ai = rma.getAcknowledgementInterval();
if (null != ai) {
Long val = ai.getMilliseconds();
if (null != val) {
acknowledgementInterval = val.longValue();
}
}
scheduleAcknowledgement(acknowledgementInterval);
long inactivityTimeout = 0;
InactivityTimeout iat = rma.getInactivityTimeout();
if (null != iat) {
Long val = iat.getMilliseconds();
if (null != val) {
inactivityTimeout = val.longValue();
}
}
scheduleSequenceTermination(inactivityTimeout);
}
void mergeRanges() {
List<AcknowledgementRange> ranges = acknowledgement.getAcknowledgementRange();
for (int i = ranges.size() - 1; i > 0; i--) {
AcknowledgementRange current = ranges.get(i);
AcknowledgementRange previous = ranges.get(i - 1);
if (current.getLower().longValue() - previous.getUpper().longValue() == 1) {
previous.setUpper(current.getUpper());
ranges.remove(i);
}
}
}
void setDestination(Destination d) {
destination = d;
}
Destination getDestination() {
return destination;
}
/**
* Returns the monitor for this sequence.
*
* @return the sequence monitor.
*/
SequenceMonitor getMonitor() {
return monitor;
}
void setLastMessageNumber(long lmn) {
lastMessageNumber = lmn;
}
boolean canPiggybackAckOnPartialResponse() {
// TODO: should also check if we allow breaking the WI Profile rule by which no headers
// can be included in a HTTP response
return getAcksTo().getAddress().getValue().equals(RMConstants.getAnonymousAddress());
}
/**
* Ensures that the delivery assurance is honored, e.g. by throwing an
* exception if the message had already been delivered and the delivery
* assurance is AtMostOnce.
* If the delivery assurance includes either AtLeastOnce or ExactlyOnce, combined with InOrder, this
* queues out-of-order messages for processing after the missing messages have been received.
*
* @param mn message number
* @return <code>true</code> if message processing to continue, <code>false</code> if to be dropped
* @throws Fault if message had already been acknowledged
*/
boolean applyDeliveryAssurance(long mn, Message message) throws RMException {
Continuation cont = getContinuation(message);
DeliveryAssuranceType da = destination.getManager().getDeliveryAssurance();
if (cont != null && da.isSetInOrder() && !cont.isNew()) {
return waitInQueue(mn, !(da.isSetAtLeastOnce() || da.isSetExactlyOnce()),
message, cont);
}
if ((da.isSetExactlyOnce() || da.isSetAtMostOnce()) && isAcknowledged(mn)) {
org.apache.cxf.common.i18n.Message msg = new org.apache.cxf.common.i18n.Message(
"MESSAGE_ALREADY_DELIVERED_EXC", LOG, mn, getIdentifier().getValue());
LOG.log(Level.INFO, msg.toString());
throw new RMException(msg);
}
if (da.isSetInOrder()) {
return waitInQueue(mn, !(da.isSetAtLeastOnce() || da.isSetExactlyOnce()),
message, cont);
}
return true;
}
private Continuation getContinuation(Message message) {
if (message == null) {
return null;
}
return message.get(Continuation.class);
}
synchronized boolean waitInQueue(long mn, boolean canSkip,
Message message, Continuation continuation) {
while (true) {
// can process now if no other in process and this one is next
if (inProcessNumber == 0) {
long diff = mn - highNumberCompleted;
if (diff == 1 || canSkip && diff > 0) {
inProcessNumber = mn;
return true;
}
}
// can abort now if same message in process or already processed
if (mn == inProcessNumber || isAcknowledged(mn)) {
return false;
}
if (continuation == null) {
ContinuationProvider p = message.get(ContinuationProvider.class);
if (p != null) {
boolean isOneWay = message.getExchange().isOneWay();
message.getExchange().setOneWay(false);
continuation = p.getContinuation();
message.getExchange().setOneWay(isOneWay);
message.put(Continuation.class, continuation);
}
}
if (continuation != null) {
continuation.setObject(message);
if (continuation.suspend(-1)) {
continuations.add(continuation);
throw new SuspendedInvocationException();
}
}
try {
//if we get here, there isn't a continuation available
//so we need to block/wait
wait();
} catch (InterruptedException ie) {
// ignore
}
}
}
synchronized void wakeupAll() {
while (!continuations.isEmpty()) {
Continuation c = continuations.remove(0);
c.resume();
}
notifyAll();
}
synchronized void processingComplete(long mn) {
inProcessNumber = 0;
highNumberCompleted = mn;
wakeupAll();
}
void purgeAcknowledged(long messageNr) {
RMStore store = destination.getManager().getStore();
if (null == store) {
return;
}
Collection<Long> messageNrs = new ArrayList<Long>();
messageNrs.add(messageNr);
store.removeMessages(getIdentifier(), messageNrs, false);
}
/**
* Called after an acknowledgement header for this sequence has been added to an outgoing message.
*/
void acknowledgmentSent() {
acknowledgeOnNextOccasion = false;
}
public boolean sendAcknowledgement() {
return acknowledgeOnNextOccasion;
}
/**
* The correlation of the incoming CreateSequence call used to create this
* sequence is recorded so that in the absence of an offer, the corresponding
* outgoing CreateSeqeunce can be correlated.
*/
void setCorrelationID(String cid) {
correlationID = cid;
}
String getCorrelationID() {
return correlationID;
}
void scheduleAcknowledgement(long acknowledgementInterval) {
AcksPolicyType ap = destination.getManager().getDestinationPolicy().getAcksPolicy();
if (acknowledgementInterval > 0 && getMonitor().getMPM() >= ap.getIntraMessageThreshold()) {
LOG.fine("Schedule deferred acknowledgment");
scheduleDeferredAcknowledgement(acknowledgementInterval);
} else {
LOG.fine("Schedule immediate acknowledgment");
scheduleImmediateAcknowledgement();
destination.getManager().getTimer().schedule(
new ImmediateFallbackAcknowledgment(), ap.getImmediaAcksTimeout());
}
}
void scheduleImmediateAcknowledgement() {
acknowledgeOnNextOccasion = true;
}
synchronized void scheduleSequenceTermination(long inactivityTimeout) {
if (inactivityTimeout <= 0) {
return;
}
boolean scheduled = null != scheduledTermination;
if (null == scheduledTermination) {
scheduledTermination = new SequenceTermination();
}
scheduledTermination.updateInactivityTimeout(inactivityTimeout);
if (!scheduled) {
destination.getManager().getTimer().schedule(scheduledTermination, inactivityTimeout);
}
}
synchronized void scheduleDeferredAcknowledgement(long delay) {
if (null == deferredAcknowledgments) {
deferredAcknowledgments = new ArrayList<DeferredAcknowledgment>();
}
long now = System.currentTimeMillis();
long expectedExecutionTime = now + delay;
for (DeferredAcknowledgment da : deferredAcknowledgments) {
if (da.scheduledExecutionTime() <= expectedExecutionTime) {
return;
}
}
DeferredAcknowledgment da = new DeferredAcknowledgment();
deferredAcknowledgments.add(da);
destination.getManager().getTimer().schedule(da, delay);
LOG.fine("Scheduled acknowledgment to be sent in " + delay + " ms");
}
synchronized void cancelDeferredAcknowledgments() {
if (null == deferredAcknowledgments) {
return;
}
for (int i = deferredAcknowledgments.size() - 1; i >= 0; i--) {
DeferredAcknowledgment da = deferredAcknowledgments.get(i);
da.cancel();
}
}
synchronized void cancelTermination() {
if (null != scheduledTermination) {
scheduledTermination.cancel();
}
}
final class DeferredAcknowledgment extends TimerTask {
public void run() {
LOG.fine("timer task: send acknowledgment.");
DestinationSequence.this.scheduleImmediateAcknowledgement();
try {
RMEndpoint rme = destination.getReliableEndpoint();
Proxy proxy = rme.getProxy();
proxy.acknowledge(DestinationSequence.this);
} catch (RMException ex) {
// already logged
} finally {
synchronized (DestinationSequence.this) {
DestinationSequence.this.deferredAcknowledgments.remove(this);
}
}
}
}
final class ImmediateFallbackAcknowledgment extends TimerTask {
public void run() {
LOG.fine("timer task: send acknowledgment.");
if (!sendAcknowledgement()) {
//Acknowledgment already get send out
return;
}
try {
destination.getReliableEndpoint().getProxy().acknowledge(DestinationSequence.this);
} catch (RMException ex) {
// already logged
}
}
}
final class SequenceTermination extends TimerTask {
private long maxInactivityTimeout;
void updateInactivityTimeout(long timeout) {
maxInactivityTimeout = Math.max(maxInactivityTimeout, timeout);
}
public void run() {
synchronized (DestinationSequence.this) {
DestinationSequence.this.scheduledTermination = null;
RMEndpoint rme = destination.getReliableEndpoint();
long lat = Math.max(rme.getLastControlMessage(), rme.getLastApplicationMessage());
if (0 == lat) {
return;
}
long now = System.currentTimeMillis();
if (now - lat >= maxInactivityTimeout) {
// terminate regardless outstanding acknowledgments - as we assume that the client is
// gone there is no point in sending a SequenceAcknowledgment
LogUtils.log(LOG, Level.WARNING, "TERMINATING_INACTIVE_SEQ_MSG",
DestinationSequence.this.getIdentifier().getValue());
DestinationSequence.this.destination.removeSequence(DestinationSequence.this);
} else {
// reschedule
SequenceTermination st = new SequenceTermination();
st.updateInactivityTimeout(maxInactivityTimeout);
DestinationSequence.this.destination.getManager().getTimer()
.schedule(st, maxInactivityTimeout);
}
}
}
}
}