Package com.intellij.tasks

Class TaskRepository

java.lang.Object

com.intellij.tasks.TaskRepository

Direct Known Subclasses:

BaseRepository

public abstract class TaskRepository
extends java.lang.Object

Describes bug-tracking server. Do not forget to mark your implementation with Tag annotation to make it persistent.

See Also:

TaskRepositoryType, BaseRepository

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TaskRepository.CancellableConnection

Field Summary

Fields

Modifier and Type	Field and Description
static int	BASIC_HTTP_AUTHORIZATION
static int	LOGIN_ANONYMOUSLY
protected java.lang.String	myCommitMessageFormat
protected boolean	myShouldFormatCommitMessage
static int	NATIVE_SEARCH Supporting this feature means that server implements some kind of issues filtering.
protected static int	NO_FEATURES
static int	STATE_UPDATING
static int	TIME_MANAGEMENT
static java.util.regex.Pattern	TIME_SPENT_PATTERN

Constructor Summary

Constructors

Modifier	Constructor and Description
	TaskRepository()
protected	TaskRepository(TaskRepository other)
	TaskRepository(TaskRepositoryType type)

Method Summary

Modifier and Type	Method and Description
abstract TaskRepository	clone()
TaskRepository.CancellableConnection	createCancellableConnection() Returns an object that can test connection.
boolean	equals(java.lang.Object o)
abstract java.lang.String	extractId(java.lang.String taskName) Attempts to extract server ID of the issue from the ID of local task (probably restored from project settings).
abstract Task	findTask(java.lang.String id)
java.util.Set<CustomTaskState>	getAvailableTaskStates(Task task) Retrieve states available for task from server.
java.lang.String	getComment()
java.lang.String	getCommitMessageFormat()
protected int	getFeatures()
javax.swing.Icon	getIcon()
Task[]	getIssues(java.lang.String query, int offset, int limit, boolean withClosed) Retrieve tasks from server using its own pagination capabilities and also filtering out closed issues.
Task[]	getIssues(java.lang.String query, int offset, int limit, boolean withClosed, ProgressIndicator cancelled)
Task[]	getIssues(java.lang.String query, int max, long since) Deprecated. To be removed in IDEA 14. Use getIssues(String, int, int, boolean) instead.
abstract CustomTaskState	getPreferredCloseTaskState() Task state that was used last time when closing task.
abstract CustomTaskState	getPreferredOpenTaskState() Task state that was used last time when opening task.
java.lang.String	getPresentableName()
TaskRepositoryType	getRepositoryType()
java.lang.String	getTaskComment(Task task)
java.lang.String	getUrl() URL of the server to be used in requests.
void	initializeRepository() This is invoked right after setting state.
boolean	isConfigured()
boolean	isShared() Shared repositories will be visible in visible in other projects, but only their URL will be initialized there.
boolean	isShouldFormatCommitMessage()
boolean	isSupported(int feature)
void	setCommitMessageFormat(java.lang.String commitMessageFormat)
abstract void	setPreferredCloseTaskState(CustomTaskState state) Remember state used when closing task most recently.
abstract void	setPreferredOpenTaskState(CustomTaskState state) Remember state used when opening task most recently.
void	setRepositoryType(TaskRepositoryType type)
void	setShared(boolean shared)
void	setShouldFormatCommitMessage(boolean shouldFormatCommitMessage)
void	setTaskState(Task task, CustomTaskState state) Update state of the task on server.
void	setTaskState(Task task, TaskState state) Deprecated. Use setTaskState(Task, CustomTaskState) instead.
void	setUrl(java.lang.String url)
void	testConnection() Deprecated. use #createCancellableConnection()
java.lang.String	toString()
void	updateTimeSpent(LocalTask task, java.lang.String timeSpent, java.lang.String comment)

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NO_FEATURES

protected static final int NO_FEATURES

See Also:

Constant Field Values

BASIC_HTTP_AUTHORIZATION

public static final int BASIC_HTTP_AUTHORIZATION

See Also:

Constant Field Values

LOGIN_ANONYMOUSLY

public static final int LOGIN_ANONYMOUSLY

See Also:

Constant Field Values

TIME_MANAGEMENT

public static final int TIME_MANAGEMENT

See Also:

Constant Field Values

STATE_UPDATING

public static final int STATE_UPDATING

See Also:

Constant Field Values

NATIVE_SEARCH

public static final int NATIVE_SEARCH

Supporting this feature means that server implements some kind of issues filtering. It may be special query language like the one used in YouTrack or mere plain text search.

If server supports this feature it MUST return tasks already filtered according to query parameter from getIssues(java.lang.String, int, long)} method, otherwise they will be filtered internally in TaskManager.getIssues(java.lang.String).

See Also:

Constant Field Values

TIME_SPENT_PATTERN

public static final java.util.regex.Pattern TIME_SPENT_PATTERN

myShouldFormatCommitMessage

protected boolean myShouldFormatCommitMessage

myCommitMessageFormat

protected java.lang.String myCommitMessageFormat

Constructor Detail

TaskRepository

public TaskRepository()

TaskRepository

public TaskRepository(TaskRepositoryType type)

TaskRepository

protected TaskRepository(TaskRepository other)

Method Detail

getUrl

public java.lang.String getUrl()

URL of the server to be used in requests. For more human-readable name of repository (e.g. some imaginary URL containing name of selected project), that will be used in settings, use getPresentableName().

See Also:

getPresentableName()

setUrl

public void setUrl(java.lang.String url)

isConfigured

public boolean isConfigured()

isShared

public boolean isShared()

Shared repositories will be visible in visible in other projects, but only their URL will be initialized there.

setShared

public void setShared(boolean shared)

getPresentableName

public java.lang.String getPresentableName()

Returns:

name of this repository, that will be shown in settings

getIcon

public javax.swing.Icon getIcon()

testConnection

@Deprecated
public void testConnection()
                    throws java.lang.Exception

Deprecated. use #createCancellableConnection()

Throws:

java.lang.Exception

createCancellableConnection

public TaskRepository.CancellableConnection createCancellableConnection()

Returns an object that can test connection. CancellableRunnable.cancel() should cancel the process.

Returns:

null if not supported

getIssues

@Deprecated
public Task[] getIssues(java.lang.String query,
                        int max,
                        long since)
                 throws java.lang.Exception

Deprecated. To be removed in IDEA 14. Use getIssues(String, int, int, boolean) instead.

Get issues from the repository. If query is null, return issues should assigned to current user only. If server supports NATIVE_SEARCH feature, tasks returned MUST be filtered by specified query.

Parameters:

query - repository specific.

max - maximum issues number to return

since - last updated timestamp. If 0, all issues should be returned.

Returns:

found issues

Throws:

java.lang.Exception

getIssues

public Task[] getIssues(java.lang.String query,
                        int offset,
                        int limit,
                        boolean withClosed)
                 throws java.lang.Exception

Retrieve tasks from server using its own pagination capabilities and also filtering out closed issues.

Previously used approach with filtering tasks on client side leads to non-filled up popup in "Open Task" action and, as result, missing tasks and various issues with caching.

Parameters:

query - arbitrary search query, possibly provided by user for search. It may utilize server specific query language.

offset - index of the first issue to return

limit - maximum number of issues returned by server in this request (or number of issues per page in some interpretations)

withClosed - whether to include closed (e.g. fixed/resolved) issues to response

Returns:

found tasks

Throws:

java.lang.Exception

getIssues

public Task[] getIssues(java.lang.String query,
                        int offset,
                        int limit,
                        boolean withClosed,
                        ProgressIndicator cancelled)
                 throws java.lang.Exception

Throws:

java.lang.Exception

getAvailableTaskStates

public java.util.Set<CustomTaskState> getAvailableTaskStates(Task task)
                                                      throws java.lang.Exception

Retrieve states available for task from server. One of these states will be passed later to setTaskState(Task, TaskState).

Parameters:

task - task to update

Throws:

java.lang.Exception

setPreferredOpenTaskState

public abstract void setPreferredOpenTaskState(CustomTaskState state)

Remember state used when opening task most recently.

getPreferredOpenTaskState

public abstract CustomTaskState getPreferredOpenTaskState()

Task state that was used last time when opening task.

setPreferredCloseTaskState

public abstract void setPreferredCloseTaskState(CustomTaskState state)

Remember state used when closing task most recently.

getPreferredCloseTaskState

public abstract CustomTaskState getPreferredCloseTaskState()

Task state that was used last time when closing task.

findTask

public abstract Task findTask(java.lang.String id)
                       throws java.lang.Exception

Parameters:

id - task ID. Don't forget to define extractId(String), if your server uses not PROJECT-123 format for task IDs.

Returns:

found task or null otherwise. Basically you should return null on e.g. 404 error and throw exception with information about failure in other cases.

Throws:

java.lang.Exception

clone

public abstract TaskRepository clone()

Overrides:

clone in class java.lang.Object

extractId

public abstract java.lang.String extractId(java.lang.String taskName)

Attempts to extract server ID of the issue from the ID of local task (probably restored from project settings). It's perfectly legal to return the argument unchanged, e.g. YouTrack repository does so for ID of form IDEA-123.

Basically this method works as filter that tells what repository local task belongs to. If it returns not null, this repository is attached to that local task and is used then to refresh it via findTask(String), update its state via setTaskState(Task, CustomTaskState), etc. Because the decision is based only on syntactic structure of ID, this approach works poorly in case of several repositories with similar issue IDs, e.g. JIRA and YouTrack, and so it's a subject of change in future.

Parameters:

taskName - ID of the task to check

Returns:

extracted ID of the issue or null if it doesn't look like issue ID of this tracker

setTaskState

@Deprecated
public void setTaskState(Task task,
                         TaskState state)
                  throws java.lang.Exception

Deprecated. Use setTaskState(Task, CustomTaskState) instead.

Throws:

java.lang.Exception

setTaskState

public void setTaskState(Task task,
                         CustomTaskState state)
                  throws java.lang.Exception

Update state of the task on server. It's guaranteed that only issues returned by getAvailableTaskStates(Task) will be passed here.

Don't forget to add STATE_UPDATING in getFeatures() and supported states in getAvailableTaskStates(Task).

Parameters:

task - issue to update

state - new state of the issue

Throws:

java.lang.Exception

See Also:

TaskRepositoryType.getPossibleTaskStates(), getFeatures()

initializeRepository

public void initializeRepository()

This is invoked right after setting state.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getRepositoryType

public final TaskRepositoryType getRepositoryType()

setRepositoryType

public final void setRepositoryType(TaskRepositoryType type)

isShouldFormatCommitMessage

public boolean isShouldFormatCommitMessage()

setShouldFormatCommitMessage

public void setShouldFormatCommitMessage(boolean shouldFormatCommitMessage)

getCommitMessageFormat

public java.lang.String getCommitMessageFormat()

setCommitMessageFormat

public void setCommitMessageFormat(java.lang.String commitMessageFormat)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTaskComment

public java.lang.String getTaskComment(Task task)

getComment

public java.lang.String getComment()

updateTimeSpent

public void updateTimeSpent(LocalTask task,
                            java.lang.String timeSpent,
                            java.lang.String comment)
                     throws java.lang.Exception

Parameters:

timeSpent - time in TIME_SPENT_PATTERN format

Throws:

java.lang.Exception

isSupported

public boolean isSupported(int feature)

getFeatures

protected int getFeatures()