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.container.url;
18  
19  /***
20   * <p>
21   * BasePortalURL defines the interface for manipulating Base URLs in a portal.
22   * Base URLs contain the isSecure flag, server name, server port, and server scheme.
23   * This abstraction was necessary for wiring the entire portal's base URL via another
24   * mechanism than retrieving from the servlet request.
25   * </p>
26   * 
27   * @author <a href="mailto:david@bluesunrise.com">David Sean Taylor</a>
28   * @version $Id: $
29   *
30   */
31  public interface BasePortalURL
32  {
33      boolean isSecure();    
34      void setSecure(boolean secure);    
35      String getServerName();    
36      void setServerName(String serverName);
37      int getServerPort();    
38      void setServerPort(int serverPort);    
39      String getServerScheme();    
40      void setServerScheme(String serverScheme);    
41  }