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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
/*******************************************************************************
* Copyright (c) 2006, 2008 Steffen Pingel and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Tasktop Technologies - initial API and implementation
*******************************************************************************/
package org.eclipse.mylyn.internal.trac.core.client;
import java.io.InputStream;
import java.util.Date;
import java.util.List;
import java.util.Set;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.mylyn.internal.trac.core.model.TracComponent;
import org.eclipse.mylyn.internal.trac.core.model.TracMilestone;
import org.eclipse.mylyn.internal.trac.core.model.TracPriority;
import org.eclipse.mylyn.internal.trac.core.model.TracSearch;
import org.eclipse.mylyn.internal.trac.core.model.TracSeverity;
import org.eclipse.mylyn.internal.trac.core.model.TracTicket;
import org.eclipse.mylyn.internal.trac.core.model.TracTicketField;
import org.eclipse.mylyn.internal.trac.core.model.TracTicketResolution;
import org.eclipse.mylyn.internal.trac.core.model.TracTicketStatus;
import org.eclipse.mylyn.internal.trac.core.model.TracTicketType;
import org.eclipse.mylyn.internal.trac.core.model.TracVersion;
/**
* Defines the requirements for classes that provide remote access to Trac repositories.
*
* @author Steffen Pingel
*/
public interface ITracClient {
public enum Version {
XML_RPC, TRAC_0_9;
public static Version fromVersion(String version) {
try {
return Version.valueOf(version);
} catch (IllegalArgumentException e) {
return null;
}
}
@Override
public String toString() {
switch (this) {
case TRAC_0_9:
return "Web (Trac 0.9 or 0.10)";
case XML_RPC:
return "XML-RPC Plugin (Rev. " + TracXmlRpcClient.REQUIRED_REVISION + ")";
default:
return null;
}
}
}
public static final String CHARSET = "UTF-8";
public static final String TIME_ZONE = "UTC";
public static final String LOGIN_URL = "/login";
public static final String QUERY_URL = "/query?format=tab";
public static final String TICKET_URL = "/ticket/";
public static final String NEW_TICKET_URL = "/newticket";
public static final String CUSTOM_QUERY_URL = "/query";
public static final String TICKET_ATTACHMENT_URL = "/attachment/ticket/";
public static final String DEFAULT_USERNAME = "anonymous";
public static final String WIKI_URL = "/wiki/";
public static final String REPORT_URL = "/report/";
public static final String CHANGESET_URL = "/changeset/";
public static final String REVISION_LOG_URL = "/log/";
public static final String MILESTONE_URL = "/milestone/";
public static final String BROWSER_URL = "/browser/";
public static final String ATTACHMENT_URL = "/attachment/ticket/";
/**
* Gets ticket with <code>id</code> from repository.
*
* @param id
* the id of the ticket to get
* @param monitor
* TODO
* @return the ticket
* @throws TracException
* thrown in case of a connection error
*/
TracTicket getTicket(int id, IProgressMonitor monitor) throws TracException;
/**
* Returns the access type.
*/
Version getVersion();
/**
* Queries tickets from repository. All found tickets are added to <code>result</code>.
*
* @param query
* the search criteria
* @param result
* the list of found tickets
* @param monitor
* TODO
* @throws TracException
* thrown in case of a connection error
*/
void search(TracSearch query, List<TracTicket> result, IProgressMonitor monitor) throws TracException;
/**
* Validates the repository connection.
*
* @throws TracException
* thrown in case of a connection error
*/
void validate(IProgressMonitor monitor) throws TracException;
/**
* Returns true, if the repository details are cached. If this method returns true, invoking
* <tt>updateAttributes(monitor, false)</tt> will return without opening a connection.
*
* @see #updateAttributes(IProgressMonitor, boolean)
*/
boolean hasAttributes();
/**
* Updates cached repository details: milestones, versions etc.
*
* @throws TracException
* thrown in case of a connection error
*/
void updateAttributes(IProgressMonitor monitor, boolean force) throws TracException;
TracComponent[] getComponents();
TracTicketField[] getTicketFields();
TracMilestone[] getMilestones();
TracPriority[] getPriorities();
TracSeverity[] getSeverities();
TracTicketResolution[] getTicketResolutions();
TracTicketStatus[] getTicketStatus();
TracTicketType[] getTicketTypes();
TracVersion[] getVersions();
InputStream getAttachmentData(int ticketId, String filename, IProgressMonitor monitor) throws TracException;
void putAttachmentData(int ticketId, String name, String description, InputStream source, IProgressMonitor monitor)
throws TracException;
void deleteAttachment(int ticketId, String filename, IProgressMonitor monitor) throws TracException;
/**
* @return the id of the created ticket
*/
int createTicket(TracTicket ticket, IProgressMonitor monitor) throws TracException;
void updateTicket(TracTicket ticket, String comment, IProgressMonitor monitor) throws TracException;
/**
* Sets a reference to the cached repository attributes.
*
* @param data
* cached repository attributes
*/
void setData(TracClientData data);
Set<Integer> getChangedTickets(Date since, IProgressMonitor monitor) throws TracException;
Date getTicketLastChanged(Integer id, IProgressMonitor monitor) throws TracException;
}
|
