blob: d65818bc22e13894316a435a8de594161bda07c3 (
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
|
/*******************************************************************************
* Copyright (c) 2002 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v0.5
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v05.html
*
* Contributors:
* IBM - Initial API and implementation
******************************************************************************/
package org.eclipse.team.core.target;
import java.io.ObjectOutputStream;
import java.net.URL;
import java.security.Provider;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.eclipse.team.core.TeamException;
import org.eclipse.team.core.sync.IRemoteResource;
/**
* A <code>Site</code> is a place where resources can be deployed and
* retrieved via a target provider.
*
* @see ISiteFactory
*/
public abstract class Site {
/**
* Answers a <code>TargetProvider</code> instance for the given path at
* this site.
*/
public abstract TargetProvider newProvider(IPath intrasitePath)
throws TeamException;
/**
* Answers the type identifier for this site. For example:
* <blockquote><pre>
* org.eclipse.team.target.webdav
* </pre></blockquote>
*
* @return string identifier for this site
*/
public abstract String getType();
/**
* Answers the location of this site as a URL. For example:
* <blockquote><pre>
* http://www.mysite.com:14356/dav
* </pre></blockquote>
*
* @return URL location of this site
*/
public abstract URL getURL();
/**
* Answers a string that can be displayed to the user that represents
* this site. For example:
* <blockquote><pre>
* http://usename@www.mysite.com/dav (WebDav)
* </pre></blockquote>
*/
public abstract String getDisplayName();
/**
* Writes the state of this site such that the corresponding concrete
* <code>ISiteFactory</code> class can restore the site.
*
* @param os the object stream into which to write it's state
*/
public abstract void writeObject(ObjectOutputStream os);
/**
* Returns a handle to the remote resource that represents this site
* on the server.
*
* @return a remote handle to this site that may or may not exist
*/
public IRemoteTargetResource getRemoteResource() throws TeamException {
return newProvider(Path.EMPTY).getRemoteResource();
}
/**
* Compares two Sites. The result is <code>true</code> if and only if
* the argument is not <code>null</code> and is a Site object that
* represents the same Site as this object. Two Site objects are equal
* if they have the same types and URLs.
*
* @param other the Site to compare against
*
* @return <code>true</code> if the Sites are the same; <code>false</code>
* otherwise
*
* @see Object#equals(Object)
*/
public boolean equals(Object other) {
if(this == other) return true;
if(! (other instanceof Site)) return false;
Site location = (Site)other;
return getType().equals(location.getType()) &&
getURL().equals(location.getURL());
}
/**
* Debugging helper
*
* @see Object#toString()
*/
public String toString() {
return getDisplayName();
}
}
|
