edu.umd.cs.findbugs.cloud

Class AbstractCloud

java.lang.Object

edu.umd.cs.findbugs.cloud.AbstractCloud

All Implemented Interfaces:

Cloud

Direct Known Subclasses:

BugCollectionStorageCloud

public abstract class AbstractCloud
extends java.lang.Object
implements Cloud

Author:

William Pugh

Nested Class Summary

Nested classes/interfaces inherited from interface edu.umd.cs.findbugs.cloud.Cloud

Cloud.BugFilingStatus, Cloud.CloudListener, Cloud.CloudStatusListener, Cloud.CloudTask, Cloud.CloudTaskListener, Cloud.Mode, Cloud.SigninState, Cloud.UserDesignation

Field Summary

Fields

Modifier and Type	Field and Description
protected BugCollection	bugCollection
static long	MIN_TIMESTAMP
protected CloudPlugin	plugin
protected PropertyBundle	properties
protected static boolean	THROW_EXCEPTION_IF_CANT_CONNECT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCloud(CloudPlugin plugin, BugCollection bugs, java.util.Properties properties)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDateSeen(BugInstance b, long when)
void	addListener(Cloud.CloudListener listener)
void	addStatusListener(Cloud.CloudStatusListener listener)
void	bugsPopulated() Called after the bugs in the bug collection are loaded; bugs should not be synchronized before this method is called
boolean	canSeeCommentsByOthers(BugInstance bug)
boolean	canStoreUserAnnotation(BugInstance bugInstance) Is this bug one that gets persisted to the cloud? We may decide that we don't persist low confidence issues to the database to avoid overloading it
boolean	claim(BugInstance b) Claim the bug
java.lang.String	claimedBy(BugInstance b) Get the user who has claimed a bug; null if no one has
boolean	communicationInitiated() Returns true if communication has already been initiated (and perhaps completed).
MutableCloudTask	createTask(java.lang.String name)
java.net.URL	fileBug(BugInstance bug)
protected void	fireIssueDataDownloadedEvent()
BugInstance	getBugByHash(java.lang.String hash)
BugCollection	getBugCollection()
boolean	getBugIsUnassigned(BugInstance b) does the issue have an unassigned issue in the bug tracker
java.net.URL	getBugLink(BugInstance b) Get link for bug, either to file one or to view it
Cloud.BugFilingStatus	getBugLinkStatus(BugInstance b) get the bug filing status for a bug instance
java.lang.String	getBugLinkType(BugInstance instance)
java.lang.String	getBugStatus(BugInstance b) A textual description of the bug status (e.g., FIX_LATER, ASSIGNED, OBSOLETE, WILL_NOT_FIX)
double	getClassificationDisagreement(BugInstance b)
double	getClassificationScore(BugInstance b)
double	getClassificationVariance(BugInstance b)
java.lang.String	getCloudName()
protected java.lang.String	getCloudProperty(java.lang.String propertyName)
java.lang.String	getCloudReport(BugInstance b)
java.lang.String	getCloudReportWithoutMe(BugInstance b)
Cloud.UserDesignation	getConsensusDesignation(BugInstance b)
long	getFirstSeen(BugInstance b)
IGuiCallback	getGuiCallback()
boolean	getIWillFix(BugInstance b) has the user said they will fix this bug
protected abstract java.lang.Iterable<BugDesignation>	getLatestDesignationFromEachUser(BugInstance bd)
long	getLocalFirstSeen(BugInstance b)
Cloud.Mode	getMode() Get voting mode
int	getNumberReviewers(BugInstance b)
CloudPlugin	getPlugin()
double	getPortionObsoleteClassifications(BugInstance b)
java.util.Set<java.lang.String>	getReviewers(BugInstance b)
Cloud.SigninState	getSigninState()
java.net.URL	getSourceLink(BugInstance b) URL to view the source for a bug instance
java.lang.String	getSourceLinkToolTip(BugInstance b) Tool tip text for "view source" button
java.lang.String	getStatusMsg() Get a status message for the cloud; information about any errors, and information about database synchronization
java.util.Date	getUserDate(BugInstance b)
Cloud.UserDesignation	getUserDesignation(BugInstance b) Get the user's designation for the bug
java.lang.String	getUserEvaluation(BugInstance b) Get free text evaluation of the bug
protected NameLookup	getUsernameLookup()
long	getUserTimestamp(BugInstance b) Return the time the user last changed their evaluation of this bug
boolean	getWillNotBeFixed(BugInstance b) has the issue been marked "will not be fixed" in a bug tracker
boolean	hasVoted(BugInstance bug)
boolean	initialize() Attempt to initialize the cloud
boolean	isInitialized() Return true if the cloud has been successfully initialized
protected boolean	issueDataHasBeenDownloaded()
java.lang.String	notInCloudMsg(BugInstance b)
boolean	overallClassificationIsNotAProblem(BugInstance b)
void	printCloudSummary(java.io.PrintWriter w, java.lang.Iterable<BugInstance> bugs, java.lang.String[] packagePrefixes)
static void	printLeaderBoard2(java.io.PrintWriter w, Multiset<java.lang.String> evaluations, int maxRows, java.lang.String alwaysPrint, java.lang.String format, java.lang.String title)
void	removeListener(Cloud.CloudListener listener)
void	removeStatusListener(Cloud.CloudStatusListener listener)
void	setBugLinkOnCloudAndStoreIssueDetails(BugInstance b, java.lang.String viewUrl, java.lang.String linkType)
void	setMode(Cloud.Mode mode) Set voting mode
void	setSigninState(Cloud.SigninState state)
void	setStatusMsg(java.lang.String newMsg)
void	shutdown() Shutdown the cloud, note termination of session, close connections
boolean	supportsBugLinks() Supports links to a bug database
boolean	supportsClaims() Supports allowing users to claim a bug
boolean	supportsCloudReports() Supports textual summaries about the status of a bug
boolean	supportsCloudSummaries()
boolean	supportsSourceLinks() Does the cloud support source lines (e.g., to FishEye)
void	updateBugStatusCache(BugInstance b, java.lang.String status) Updates the local cache of bug reporting status.
void	updatedIssue(BugInstance bug)
protected void	updatedStatus()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface edu.umd.cs.findbugs.cloud.Cloud

availableForInitialization, bugFiled, getPrimaryDesignation, getProjects, getUser, initiateCommunication, isInCloud, isOnlineCloud, isSavingSignInInformationEnabled, setSaveSignInInformation, signIn, signOut, storeUserAnnotation, waitUntilIssueDataDownloaded, waitUntilIssueDataDownloaded, waitUntilNewIssuesUploaded, waitUntilNewIssuesUploaded

Field Detail

MIN_TIMESTAMP

public static long MIN_TIMESTAMP

THROW_EXCEPTION_IF_CANT_CONNECT

protected static final boolean THROW_EXCEPTION_IF_CANT_CONNECT

See Also:

Constant Field Values

plugin

protected final CloudPlugin plugin

bugCollection

protected final BugCollection bugCollection

properties

protected final PropertyBundle properties

Constructor Detail

AbstractCloud

protected AbstractCloud(CloudPlugin plugin,
             BugCollection bugs,
             java.util.Properties properties)

Method Detail

isInitialized

public boolean isInitialized()

Description copied from interface: Cloud

Return true if the cloud has been successfully initialized

Specified by:

isInitialized in interface Cloud

initialize

@OverridingMethodsMustInvokeSuper
public boolean initialize()
                   throws java.io.IOException

Description copied from interface: Cloud

Attempt to initialize the cloud

Specified by:

initialize in interface Cloud

Returns:

true if successful

Throws:

java.io.IOException

getMode

public Cloud.Mode getMode()

Description copied from interface: Cloud

Get voting mode

Specified by:

getMode in interface Cloud

setMode

public void setMode(Cloud.Mode mode)

Description copied from interface: Cloud

Set voting mode

Specified by:

setMode in interface Cloud

getPlugin

public CloudPlugin getPlugin()

Specified by:

getPlugin in interface Cloud

getBugCollection

public BugCollection getBugCollection()

Specified by:

getBugCollection in interface Cloud

supportsBugLinks

public boolean supportsBugLinks()

Description copied from interface: Cloud

Supports links to a bug database

Specified by:

supportsBugLinks in interface Cloud

setBugLinkOnCloudAndStoreIssueDetails

public void setBugLinkOnCloudAndStoreIssueDetails(BugInstance b,
                                         java.lang.String viewUrl,
                                         java.lang.String linkType)
                                           throws java.io.IOException,
                                                  SignInCancelledException

Specified by:

setBugLinkOnCloudAndStoreIssueDetails in interface Cloud

Throws:

java.io.IOException

SignInCancelledException

updateBugStatusCache

public void updateBugStatusCache(BugInstance b,
                        java.lang.String status)

Description copied from interface: Cloud

Updates the local cache of bug reporting status. Does not modify server code.

Specified by:

updateBugStatusCache in interface Cloud

supportsClaims

public boolean supportsClaims()

Description copied from interface: Cloud

Supports allowing users to claim a bug

Specified by:

supportsClaims in interface Cloud

supportsCloudReports

public boolean supportsCloudReports()

Description copied from interface: Cloud

Supports textual summaries about the status of a bug

Specified by:

supportsCloudReports in interface Cloud

claimedBy

public java.lang.String claimedBy(BugInstance b)

Description copied from interface: Cloud

Get the user who has claimed a bug; null if no one has

Specified by:

claimedBy in interface Cloud

claim

public boolean claim(BugInstance b)

Description copied from interface: Cloud

Claim the bug

Specified by:

claim in interface Cloud

Returns:

true if no one else has already done so

getBugLink

public java.net.URL getBugLink(BugInstance b)

Description copied from interface: Cloud

Get link for bug, either to file one or to view it

Specified by:

getBugLink in interface Cloud

getBugLinkType

public java.lang.String getBugLinkType(BugInstance instance)

Specified by:

getBugLinkType in interface Cloud

fileBug

public java.net.URL fileBug(BugInstance bug)

Specified by:

fileBug in interface Cloud

getBugLinkStatus

public Cloud.BugFilingStatus getBugLinkStatus(BugInstance b)

Description copied from interface: Cloud

get the bug filing status for a bug instance

Specified by:

getBugLinkStatus in interface Cloud

canSeeCommentsByOthers

public boolean canSeeCommentsByOthers(BugInstance bug)

hasVoted

public boolean hasVoted(BugInstance bug)

notInCloudMsg

public java.lang.String notInCloudMsg(BugInstance b)

getCloudReport

public java.lang.String getCloudReport(BugInstance b)

Specified by:

getCloudReport in interface Cloud

getCloudReportWithoutMe

public java.lang.String getCloudReportWithoutMe(BugInstance b)

Specified by:

getCloudReportWithoutMe in interface Cloud

bugsPopulated

public void bugsPopulated()

Description copied from interface: Cloud

Called after the bugs in the bug collection are loaded; bugs should not be synchronized before this method is called

Specified by:

bugsPopulated in interface Cloud

issueDataHasBeenDownloaded

protected boolean issueDataHasBeenDownloaded()

getBugStatus

public java.lang.String getBugStatus(BugInstance b)

Description copied from interface: Cloud

A textual description of the bug status (e.g., FIX_LATER, ASSIGNED, OBSOLETE, WILL_NOT_FIX)

Specified by:

getBugStatus in interface Cloud

getLatestDesignationFromEachUser

protected abstract java.lang.Iterable<BugDesignation> getLatestDesignationFromEachUser(BugInstance bd)

getUserDate

public java.util.Date getUserDate(BugInstance b)

Specified by:

getUserDate in interface Cloud

addListener

public void addListener(Cloud.CloudListener listener)

Specified by:

addListener in interface Cloud

removeListener

public void removeListener(Cloud.CloudListener listener)

Specified by:

removeListener in interface Cloud

addStatusListener

public void addStatusListener(Cloud.CloudStatusListener listener)

Specified by:

addStatusListener in interface Cloud

removeStatusListener

public void removeStatusListener(Cloud.CloudStatusListener listener)

Specified by:

removeStatusListener in interface Cloud

getStatusMsg

public java.lang.String getStatusMsg()

Description copied from interface: Cloud

Get a status message for the cloud; information about any errors, and information about database synchronization

Specified by:

getStatusMsg in interface Cloud

shutdown

public void shutdown()

Description copied from interface: Cloud

Shutdown the cloud, note termination of session, close connections

Specified by:

shutdown in interface Cloud

getIWillFix

public boolean getIWillFix(BugInstance b)

Description copied from interface: Cloud

has the user said they will fix this bug

Specified by:

getIWillFix in interface Cloud

getConsensusDesignation

public Cloud.UserDesignation getConsensusDesignation(BugInstance b)

Specified by:

getConsensusDesignation in interface Cloud

Returns:

Cloud.UserDesignation.UNCLASSIFIED if no consensus has been reached

overallClassificationIsNotAProblem

public boolean overallClassificationIsNotAProblem(BugInstance b)

Specified by:

overallClassificationIsNotAProblem in interface Cloud

getClassificationScore

public double getClassificationScore(BugInstance b)

Specified by:

getClassificationScore in interface Cloud

getClassificationVariance

public double getClassificationVariance(BugInstance b)

Specified by:

getClassificationVariance in interface Cloud

getPortionObsoleteClassifications

public double getPortionObsoleteClassifications(BugInstance b)

Specified by:

getPortionObsoleteClassifications in interface Cloud

getNumberReviewers

public int getNumberReviewers(BugInstance b)

Specified by:

getNumberReviewers in interface Cloud

printCloudSummary

public void printCloudSummary(java.io.PrintWriter w,
                     java.lang.Iterable<BugInstance> bugs,
                     java.lang.String[] packagePrefixes)

Specified by:

printCloudSummary in interface Cloud

printLeaderBoard2

public static void printLeaderBoard2(java.io.PrintWriter w,
                     Multiset<java.lang.String> evaluations,
                     int maxRows,
                     java.lang.String alwaysPrint,
                     java.lang.String format,
                     java.lang.String title)

supportsCloudSummaries

public boolean supportsCloudSummaries()

Specified by:

supportsCloudSummaries in interface Cloud

canStoreUserAnnotation

public boolean canStoreUserAnnotation(BugInstance bugInstance)

Description copied from interface: Cloud

Is this bug one that gets persisted to the cloud? We may decide that we don't persist low confidence issues to the database to avoid overloading it

Specified by:

canStoreUserAnnotation in interface Cloud

getClassificationDisagreement

public double getClassificationDisagreement(BugInstance b)

Specified by:

getClassificationDisagreement in interface Cloud

getUserDesignation

public Cloud.UserDesignation getUserDesignation(BugInstance b)

Description copied from interface: Cloud

Get the user's designation for the bug

Specified by:

getUserDesignation in interface Cloud

getUserEvaluation

public java.lang.String getUserEvaluation(BugInstance b)

Description copied from interface: Cloud

Get free text evaluation of the bug

Specified by:

getUserEvaluation in interface Cloud

getUserTimestamp

public long getUserTimestamp(BugInstance b)

Description copied from interface: Cloud

Return the time the user last changed their evaluation of this bug

Specified by:

getUserTimestamp in interface Cloud

getFirstSeen

public long getFirstSeen(BugInstance b)

Specified by:

getFirstSeen in interface Cloud

addDateSeen

public void addDateSeen(BugInstance b,
               long when)

Specified by:

addDateSeen in interface Cloud

updatedStatus

protected void updatedStatus()

updatedIssue

public void updatedIssue(BugInstance bug)

fireIssueDataDownloadedEvent

protected void fireIssueDataDownloadedEvent()

getSigninState

public Cloud.SigninState getSigninState()

Specified by:

getSigninState in interface Cloud

setSigninState

public void setSigninState(Cloud.SigninState state)

getBugByHash

public BugInstance getBugByHash(java.lang.String hash)

getUsernameLookup

protected NameLookup getUsernameLookup()
                                throws java.io.IOException

Throws:

java.io.IOException

createTask

public MutableCloudTask createTask(java.lang.String name)

setStatusMsg

public void setStatusMsg(java.lang.String newMsg)

getCloudProperty

protected java.lang.String getCloudProperty(java.lang.String propertyName)

supportsSourceLinks

public boolean supportsSourceLinks()

Description copied from interface: Cloud

Does the cloud support source lines (e.g., to FishEye)

Specified by:

supportsSourceLinks in interface Cloud

getSourceLink

@CheckForNull
public java.net.URL getSourceLink(BugInstance b)

Description copied from interface: Cloud

URL to view the source for a bug instance

Specified by:

getSourceLink in interface Cloud

getSourceLinkToolTip

public java.lang.String getSourceLinkToolTip(BugInstance b)

Description copied from interface: Cloud

Tool tip text for "view source" button

Specified by:

getSourceLinkToolTip in interface Cloud

getBugIsUnassigned

public boolean getBugIsUnassigned(BugInstance b)

Description copied from interface: Cloud

does the issue have an unassigned issue in the bug tracker

Specified by:

getBugIsUnassigned in interface Cloud

getWillNotBeFixed

public boolean getWillNotBeFixed(BugInstance b)

Description copied from interface: Cloud

has the issue been marked "will not be fixed" in a bug tracker

Specified by:

getWillNotBeFixed in interface Cloud

getReviewers

public java.util.Set<java.lang.String> getReviewers(BugInstance b)

Specified by:

getReviewers in interface Cloud

getGuiCallback

public IGuiCallback getGuiCallback()

Specified by:

getGuiCallback in interface Cloud

getCloudName

public java.lang.String getCloudName()

Specified by:

getCloudName in interface Cloud

communicationInitiated

public boolean communicationInitiated()

Description copied from interface: Cloud

Returns true if communication has already been initiated (and perhaps completed).

Specified by:

communicationInitiated in interface Cloud

getLocalFirstSeen

public long getLocalFirstSeen(BugInstance b)