Site xref

This project has retired. For details please refer to its Attic page.
Site xref

1   /*
2    * Copyright 2000-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  package org.apache.jetspeed.services.webpage;
18  
19  /* 
20   * Holds the state of a site
21   *
22   */
23  public interface Site
24  {    
25  
26      /* 
27       * Get the unique ID of the proxied target.
28       *
29       * return The unique ID of the target.
30       */
31      public long getID();
32  
33      /* 
34       * Get the URL of the proxied target.
35       *
36       * return The URL of the proxied target.
37       */
38      public String getURL();
39      
40      /* 
41       * get the common name for this proxied target.
42       *
43       * return the string value of the proxied target name.
44       */
45      public String getName();
46  
47      /* 
48       * get the user name used to logon to this proxied target.
49       *
50       * return the string value of the proxied target user name.
51       */
52      public String getUserName();
53      
54      /* 
55       * get the password used to logon to this proxied target.
56       *
57       * return the string value of the proxied target password.
58       */
59      public String getPassword();
60       
61      /* 
62       * get the availability status of this proxied target.
63       *
64       * return the int value of the proxied target availability status.
65       */
66      public int getStatus();
67      /* 
68       * sets the status of this proxied target.
69       *
70       * @param the int value of the proxied target status.
71       */
72      public void setStatus(int status);
73      
74      /* 
75       * Is this site secured.
76       *
77       * return True if the target is secured.
78       */
79      public boolean isSecured();
80      
81  }