View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.rewriter.rules;
18  
19  /***
20   * Rule
21   *
22   * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
23   * @version $Id: Rule.java 516448 2007-03-09 16:25:47Z ate $
24   */
25  public interface Rule extends Identified
26  {
27      /***
28       * Flag indicating whether to use the Base URL for this rewriter.
29       * The default setting is true, use the rewriter's Base URL.
30       * 
31       * @return true if this rule uses the Base URL
32       */
33      boolean getUseBase();
34      
35      /***
36       * Flag indicating whether to use the Base URL for this rewriter.
37       * The default setting is true, use the rewriter's Base URL.
38       * 
39       * @param true if this rule uses the Base URL
40       */    
41      void setUseBase(boolean flag);
42      
43      /***
44       * Suffix string to append to the rewritten URL.
45       * 
46       * @return the value of the suffix string.
47       */
48      String getSuffix();
49      
50      /***
51       * Suffix string to append to the rewritten URL.
52       * 
53       * @param the value of the suffix string.
54       */    
55      void setSuffix(String suffix);
56      
57      /***
58       * Flag indicating whether to rewrite links as popups.
59       * The default setting is false, do not rewrite as a popup.
60       * 
61       * @return true if this rule rewrites links as popups
62       */
63      boolean getPopup();
64  
65      /***
66       * Flag indicating whether to rewrite links as popups.
67       * The default setting is false, do not rewrite as a popup.
68       * 
69       * @param true if this rule rewrites links as popups
70       */    
71      void setPopup(boolean flag);
72      
73      /***
74       * Checks to see if a URL should be rewritten or not.
75       * 
76       * @param url
77       */    
78      boolean shouldRewrite(String url);
79      
80      
81                          
82  }