View Javadoc

1   /*
2    * Copyright 2007 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.springframework.ws.soap.addressing.messageid;
18  
19  import java.net.URI;
20  
21  import org.springframework.ws.soap.SoapMessage;
22  
23  /**
24   * Strategy interface that encapsulates the creation and validation of WS-Addressing <code>MessageID</code>s.
25   *
26   * @author Arjen Poutsma
27   * @since 1.5.0
28   */
29  public interface MessageIdStrategy {
30  
31      /**
32       * Indicates whether the given <code>MessageID</code> value is a duplicate or not
33       *
34       * @param messageId the message id
35       * @return <code>true</code> if a duplicate; <code>false</code> otherwise
36       */
37      boolean isDuplicate(URI messageId);
38  
39      /**
40       * Returns a new WS-Addressing <code>MessageID</code> for the given [email protected] SoapMessage}.
41       *
42       * @param message the message to create an id for
43       * @return the new message id
44       */
45      URI newMessageId(SoapMessage message);
46  
47  }