blob: 9395cc77d13d7a5423855365993e22fffc9200b3 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
/*******************************************************************************
* Copyright (c) 2000, 2003 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.team.internal.core.target;
import java.net.URL;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.team.core.TeamException;
import org.eclipse.team.core.sync.IRemoteResource;
/**
* Interface for target resources that are not local. This is a handle to a
* clients-side 'proxy' for the server resource. There are no guarantees that
* the handle is not stale or invalid.
* <p>
* Use <code>exists()</code> to verify is the associated server resource
* exists.</p>
* <p>
* Methods that take progress monitors are expected to be long running and
* may contact the server. Progress and cancellation will be provided. Clients
* can assume that methods that don't take progress monitors are responsive
* and won't contact the server.
* </p>
*
* @see IRemoteResource
*/
public interface IRemoteTargetResource extends IRemoteResource {
/**
* Returns the URL of this remote resource.
*/
public URL getURL();
/**
* Returns the size of the resource.
*/
public int getSize(IProgressMonitor monitor) throws TeamException;
/**
* Returns the last modified time
*/
public String getLastModified(IProgressMonitor monitor) throws TeamException;
/**
* Return a boolean value indicating whether or not this resource exists on the
* remote server.
*/
public boolean exists(IProgressMonitor monitor) throws TeamException;
/**
* Creates the directory named by this URL, including any necessary but non-existant
* parent directories.
*/
public void mkdirs(IProgressMonitor monitor) throws TeamException;
/**
* Returns a handle to the remote file identified by the given path in this
* folder.
* <p>
* This is a remote resource handle operation; neither the resource nor
* the result need exist on the server.</p>
* <p>
* The supplied path may be absolute or relative; in either case, it is
* interpreted as relative to this resource and is appended
* to this container's full path to form the full path of the resultant resource.
* A trailing separator is ignored.
* </p>
*
* @param name the path of the remote member file
* @return the (handle of the) remote file
* @see #getFolder
*/
public IRemoteTargetResource getFile(String name);
/**
* Returns a handle to the remote folder identified by the given path in this
* folder.
* <p>
* This is a remote resource handle operation; neither the resource nor
* the result need exist on the server.</p>
* <p>
* The supplied path may be absolute or relative; in either case, it is
* interpreted as relative to this resource and is appended
* to this container's full path to form the full path of the resultant resource.
* A trailing separator is ignored.
* </p>
*
* @param path the path of the remote member file
* @return the (handle of the) remote file
* @see #getFolder
*/
public IRemoteTargetResource getFolder(String name);
/**
* Return the site where this remote resource exists
*/
public Site getSite();
/**
* Return true if this can be reached (in some fashion).
* This method is not guaranteed to catch all connection failure cases but is used
* to at least test the waters.
* @param monitor
* @return boolean
*/
boolean canBeReached(IProgressMonitor monitor) throws TeamException;
/**
* Delete the remote resource.
*/
public void delete(IProgressMonitor monitor) throws TeamException;
}
|
