View Javadoc

1   /*
2    * Copyright 2005 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.server.endpoint;
18  
19  import javax.xml.transform.Source;
20  
21  /**
22   * Defines the basic contract for Web Services interested in just the message payload.
23   * <p/>
24   * The main entrypoint is [email protected] #invoke(Source)}, which gets invoked with the contents of the requesting message.
25   *
26   * @author Arjen Poutsma
27   * @since 1.0.0
28   */
29  public interface PayloadEndpoint {
30  
31      /**
32       * Invokes the endpoint with the given request payload, and possibly returns a response.
33       *
34       * @param request the payload of the request message, may be <code>null</code>
35       * @return the payload of the response message, may be <code>null</code> to indicate no response
36       * @throws Exception if an exception occurs
37       */
38      Source invoke(Source request) throws Exception;
39  }