KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sslexplorer > networkplaces > NetworkPlaceDatabase


1 /*
2  * SSL-Explorer
3  *
4  * Copyright (C) 2003-2006 3SP LTD. All Rights Reserved
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2 of
9  * the License, or (at your option) any later version.
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public
16  * License along with this program; if not, write to the Free Software
17  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18  */
19             
20 package com.sslexplorer.networkplaces;
21
22 import java.util.List JavaDoc;
23
24 import com.sslexplorer.extensions.types.PluginDatabase;
25
26 /**
27  * The <i>System Configuration> {@link com.sslexplorer.extensions.types.PluginDatabase} implementation
28  * is responsible for storing an retrieving SSL-Explorer's network places resources and
29  * configuration.
30  *
31  * @author James D Robinson <a HREF="mailto:james@3sp.com">&lt;james@3sp.com&gt;</a>
32  */
33 public interface NetworkPlaceDatabase extends PluginDatabase {
34
35     /**
36      * Get all network places.
37      *
38      * @return List<NetworkPlace>
39      * @throws Exception
40      */
41     public List JavaDoc<NetworkPlace> getNetworkPlaces() throws Exception JavaDoc;
42
43     /**
44      * Get all network places.
45      *
46      * @return List<NetworkPlace>
47      * @throws Exception
48      */
49     public List JavaDoc<NetworkPlace> getNetworkPlaces(int realmID) throws Exception JavaDoc;
50
51     /**
52      * Get the NetworkPlace for the specified resource_id.
53      * @param resource_id
54      * @return NetworkPlace
55      * @throws Exception
56      */
57     public NetworkPlace getNetworkPlace(int resource_id) throws Exception JavaDoc;
58     
59     /**
60      * Get the NetworkPlace for the specified name and realm
61      * @param name
62      * @param realmID
63      * @return NetworkPlace
64      * @throws Exception
65      */
66     public NetworkPlace getNetworkPlace(String JavaDoc name, int realmID) throws Exception JavaDoc;
67
68     /**
69      * Delete the NetworkPlace with the specified resource_id.
70      *
71      * @param resourceId
72      * @return NetworkPlace
73      * @throws Exception
74      */
75     public NetworkPlace deleteNetworkPlace(int resourceId) throws Exception JavaDoc;
76
77     /**
78      * Create a new network place.
79      *
80      * @param scheme
81      * @param shortName
82      * @param description
83      * @param host
84      * @param uri
85      * @param port
86      * @param username
87      * @param password
88      * @param readOnly
89      * @param allowResursive
90      * @param noDelete
91      * @param showHidden
92      * @return NetworkPlace
93      * @throws Exception
94      */
95     public NetworkPlace createNetworkPlace(String JavaDoc scheme, String JavaDoc shortName, String JavaDoc description, String JavaDoc host, String JavaDoc uri, int port, String JavaDoc username, String JavaDoc password, boolean readOnly,
96                     boolean allowResursive, boolean noDelete, boolean showHidden, int realmID) throws Exception JavaDoc;
97
98     /**
99      * Update the NetworkPlace.
100      *
101      * @param resourceId
102      * @param scheme
103      * @param resourceName
104      * @param resourceDescription
105      * @param host
106      * @param uri
107      * @param port
108      * @param username
109      * @param password
110      * @param readOnly
111      * @param allowResursive
112      * @param noDelete
113      * @param showHidden
114      * @throws Exception
115      */
116     public void updateNetworkPlace(int resourceId, String JavaDoc scheme, String JavaDoc resourceName, String JavaDoc resourceDescription, String JavaDoc host, String JavaDoc uri, int port, String JavaDoc username, String JavaDoc password, boolean readOnly,
117                     boolean allowResursive, boolean noDelete, boolean showHidden) throws Exception JavaDoc;
118
119 }
Popular Tags