1   /*
2    * Copyright 2000-2001,2004 The Apache Software Foundation.
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  /* 
18  
19   */
20  
21  package org.apache.wsrp4j.consumer;
22  
23  /**
24   * <p>This interface provides a method performing Consumer URLRewriting.</p>
25   *
26   * @author <a href="mailto:stefan.behl@de.ibm.com">Stefan Behl</a>
27   *
28   * @version 1.1
29   */
30  public interface URLRewriter {
31  
32      /**
33       * Sets the URLGenerator to be used.
34       */
35      public void setURLGenerator(URLGenerator urlGenerator);
36  
37      /**
38       * Parses the entire markup and rewrites all found URLs. The URLs to be
39       * rewritten are enclosed by the tokens "wsrp-rewrite" and "/wsrp-rewrite".
40       *
41       * @param  markup           The markup to be parsed for URLs
42       *                          to be rewritten.
43       *
44       * @return String representing markup incl. complete URLs.
45       */
46      public String rewriteURLs(String markup);
47  
48  }