blob: b7f7fdd8966e8ca445c9c0a8c631eaa9d5075408 (
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
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
|
/*******************************************************************************
* Copyright (c) 2006 - 2006 Mylar eclipse.org project 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:
* Mylar project committers - initial API and implementation
*******************************************************************************/
package org.eclipse.mylar.internal.trac.core;
import java.util.Date;
import java.util.List;
import java.util.Set;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.mylar.internal.trac.model.TracComponent;
import org.eclipse.mylar.internal.trac.model.TracMilestone;
import org.eclipse.mylar.internal.trac.model.TracPriority;
import org.eclipse.mylar.internal.trac.model.TracSearch;
import org.eclipse.mylar.internal.trac.model.TracSeverity;
import org.eclipse.mylar.internal.trac.model.TracTicket;
import org.eclipse.mylar.internal.trac.model.TracTicketResolution;
import org.eclipse.mylar.internal.trac.model.TracTicketStatus;
import org.eclipse.mylar.internal.trac.model.TracTicketType;
import org.eclipse.mylar.internal.trac.model.TracVersion;
/**
* Defines the requirements for classes that provide remote access to Trac
* repositories.
*
* @author Steffen Pingel
*/
public interface ITracClient {
public enum Version {
TRAC_0_9, XML_RPC;
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 "Trac 0.9 and later";
case XML_RPC:
return "XML-RPC Plugin (Rev. 848)";
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 TICKET_ATTACHMENT_URL = "/attachment/ticket/";
/**
* Gets ticket with <code>id</code> from repository.
*
* @param id
* the id of the ticket to get
* @return the ticket
* @throws TracException
* thrown in case of a connection error
*/
TracTicket getTicket(int id) 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
* @throws TracException
* thrown in case of a connection error
*/
void search(TracSearch query, List<TracTicket> result) throws TracException;
/**
* Validates the repository connection.
*
* @throws TracException
* thrown in case of a connection error
*/
void validate() throws TracException;
/**
* 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();
TracMilestone[] getMilestones();
TracPriority[] getPriorities();
TracSeverity[] getSeverities();
TracTicketResolution[] getTicketResolutions();
TracTicketStatus[] getTicketStatus();
TracTicketType[] getTicketTypes();
TracVersion[] getVersions();
byte[] getAttachmentData(int id, String filename) throws TracException;
void putAttachmentData(int id, String name, String description, byte[] data) throws TracException;
void createTicket(TracTicket ticket) throws TracException;
void updateTicket(TracTicket ticket, String comment) throws TracException;
/**
* Sets a reference to the cached repository attributes.
*
* @param data cached repository attributes
*/
void setData(TracClientData data);
Set<Integer> getChangedTickets(Date since) throws TracException;
}
|
