File: RMAckRequested.java

package info (click to toggle)
libjboss-web-services-java 0.0%2Bsvn5660-2
  • links: PTS, VCS
  • area: contrib
  • in suites: lenny
  • size: 7,268 kB
  • ctags: 12,475
  • sloc: java: 79,207; xml: 38; makefile: 19; sh: 15
file content (69 lines) | stat: -rw-r--r-- 2,630 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2005, JBoss Inc., and individual contributors as indicated
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.jboss.ws.extensions.wsrm.spi.protocol;

/**
 * <p><b>AckRequested</b> element requests an Acknowledgement for the identified Sequence.</p>
 * 
 * The following infoset defines its syntax:
 * <p><blockquote><pre>
 * &lt;wsrm:AckRequested ...&gt;
 *     &lt;wsrm:Identifier ...&gt; xs:anyURI &lt;/wsrm:Identifier&gt;
 *     &lt;wsrm:MessageNumber&gt; xs:unsignedLong &lt;/wsrm:MessageNumber&gt; ?
 *     ... 
 * &lt;/wsrm:AckRequested&gt;
 * </pre></blockquote></p>
 *  
 * @author richard.opalka@jboss.com
 */
public interface RMAckRequested extends RMSerializable
{
   /**
    * An RM Source that includes an <b>AckRequested</b> header block in a SOAP envelope MUST include
    * this element in that header block. The RM Source MUST set the value of this element to the
    * absolute URI, (conformant with RFC3986), that uniquely identifies the Sequence to which the
    * request applies.
    * @param identifier
    */
   void setIdentifier(String identifier);

   /**
    * Getter
    * @return sequence identifier
    */
   String getIdentifier();
   
   /**
    * This optional element, if present, MUST contain an <b>xs:unsignedLong</b> representing the highest
    * <b>MessageNumber</b> sent by the RM Source within a Sequence. If present, it MAY be treated
    * as a hint to the RM Destination as an optimization to the process of preparing to transmit a
    * <b>SequenceAcknowledgement</b>.
    * @param lastMessageNumber
    */
   void setMessageNumber(long lastMessageNumber);
   
   /**
    * Getter
    * @return last message number in the sequence
    */
   long getMessageNumber();
}