KickJava   Java API By Example, From Geeks To Geeks.

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


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 com.sslexplorer.policyframework.LaunchSession;
23 import com.sslexplorer.policyframework.Resource;
24
25 /**
26  * <p>
27  * Implementation of {@link com.sslexplorer.policyframework.Resource} for a
28  * network place on a number of different Mounts. i.e. ftp, local files, network
29  * resources.
30  *
31  * @author James D Robinson <a HREF="mailto:james@3sp.com">&lt;james@3sp.com&gt;</a>
32  *
33  */
34 public interface NetworkPlace extends Resource {
35
36     /**
37      * Hidden
38      */
39     public final static int TYPE_HIDDEN = 1;
40
41     /**
42      * Normal
43      */
44     public final static int TYPE_NORMAL = 0;
45
46     /**
47      * @return The NetworkPlace's host.
48      */
49     public String JavaDoc getHost();
50
51     /**
52      * @param host The NetworkPlace's host.
53      */
54     public void setHost(String JavaDoc host);
55     
56     /**
57      * @return The NetworkPlace's uri.
58      */
59     public String JavaDoc getPath();
60
61     /**
62      * @param uri The NetworkPlace's path.
63      */
64     public void setPath(String JavaDoc path);
65     
66     /**
67      * @return The NetworkPlace's port.
68      */
69     public int getPort();
70
71     /**
72      * @param port The NetworkPlace's port.
73      */
74     public void setPort(int port);
75     
76     /**
77      * @return The NetworkPlace's username.
78      */
79     public String JavaDoc getUsername();
80
81     /**
82      * @param username The NetworkPlace's username.
83      */
84     public void setUsername(String JavaDoc username);
85     
86     /**
87      * @return The NetworkPlace's password.
88      */
89     public String JavaDoc getPassword();
90
91     /**
92      * @param password The NetworkPlace's password.
93      */
94     public void setPassword(String JavaDoc password);
95
96     /**
97      * @return The Type of file, Hidden or Normal
98      */
99     public int getType();
100
101     /**
102      * @return Weather the resource can have its folders accessable.
103      */
104     public boolean isAllowRecursive();
105
106     /**
107      * @param allowResursive Weather the resource can have its folders accessable.
108      */
109     public void setAllowResursive(boolean allowResursive);
110
111     /**
112      * @return Weather the resource does not allow deletion.
113      */
114     public boolean isNoDelete();
115
116     /**
117      * @param noDelete Weather the resource does not allow deletion.
118      */
119     public void setNoDelete(boolean noDelete);
120
121     /**
122      * @return Weather the resource is read only.
123      */
124     public boolean isReadOnly();
125
126     /**
127      * @param readOnly Weather the resource is read only.
128      */
129     public void setReadOnly(boolean readOnly);
130
131     /**
132      * @return Weather the resource shows hidden files.
133      */
134     public boolean isShowHidden();
135
136     /**
137      * @param showHidden Weather the resource shows hidden files.
138      */
139     public void setShowHidden(boolean showHidden);
140
141     /**
142      * Get the scheme to use for the path. This will determine what
143      * store will be used
144      *
145      * @return scheme name
146      */
147     public String JavaDoc getScheme();
148
149     /**
150      * Set the scheme portion to use for the path. This will determine what
151      * store will be used
152      *
153      * @param scheme scheme
154      */
155     public void setScheme(String JavaDoc scheme);
156
157     /**
158      * Get the URI required to launch this network place
159      *
160      * @param launchSession launch session
161      * @return uri
162      */
163     public String JavaDoc getLaunchUri(LaunchSession launchSession);
164     
165 }
Popular Tags