Class Index

A C D E F G H I L M N O P R S T U V W

A

AbstractFishEyeAuthenticator A super class for all Custom FishEye Authenticators. 
AbstractFisheyeCondition Base class for FishEye and Crucible conditions. 
AbstractLinker  
ActionData Contains available Crucible action name and presentation text. 
Actions Collection of available actions for user  
AdvancedLinker  
AllReviewersCompletedEvent Emitted when all reviewers for a review have completed. 
AllReviewersNoLongerCompletedEvent Emitted when all reviewers of a review are no longer complete. 
AnchorData Pojo for patch anchor data. 
AuthenticationData  
AuthenticationStyle  
AuthorizationException  
AuthToken A token representing a successful login. 

C

CaseAwarePath A case aware path. 
CaseAwarePathGlob A case aware path glob based on the ant glob syntax. 
ChangelogBrowser Provides information on the changesets in an SCM implementation  
ChangelogBrowser.ChangeSets  
ChangeSet  
ChangesetData  
ChangesetDataFE Data object representing a fisheye changeset  
ChangesetDataFE.ChangesetDataFEBuilder  
ChangesetEvent Base interface for events which relate to a changeset  
ChangesetMetricsService Provides an API for efficiently retrieving repository metrics such as changeset, revision and LOC counts  
ChangesetMetricsService.QueryParameters  
ChangesetMetricsService.QueryParameters.Builder  
ChangesetsData Data object representing a list of changeset ids and  
ClearCaseRepositoryData  
ClearCaseRepositoryData  
ClearCaseRepositoryData Holds additional properties specific to a ClearCase repository 
CommentCreatedEvent The creation of a comment  
CommentData Common attributes of comments on items and general comments on reviews. 
CommentData.Status  
CommentDataImpl An abstract class (should be abstract - see note below) containing fields common to all comment data objects

NoteThis class is not declared abstract because otherwise the current JSON deserialier does not know how to handle the list of comments in some of the REST api objects. 

CommentDataImpl.CommentDataBuilder<M extends CommentDataBuilder, T extends CommentDataImpl>  
CommentDeletedEvent The deletion of a comment  
Comments  
CommentStats Holds the comment statistics on a particular review. 
CommentUpdatedEvent A comment is updated. 
CommitEvent An event thrown whenever a changeset is committed. 
CommitMessageSyntaxSettings  
CommitMessageSyntaxSettings.SyntaxType  
CommitterData  
Configurable<T> To be implemented by clients of the SimpleConfigurationServlet  
ConfigurableSCMModule<T extends SimpleConfiguration> An SCMSource which supports a simple configuration  
ContentService Provides an API for retreving the content of files stored in the repository  
CrucibleRevisionData A pojo to represent crucible revision data for use in the rest API calls  
CsCommentCreatedEvent A Changeset Comment has been created. 
CsCommentData Attributes of a Changeset Comment  
CsCommentDeletedEvent A Changeset Comment has been deleted. 
CsCommentEvent Interface for all events relating to Changeset Comments  
CsCommentUpdatedEvent A Changeset Comment has been created. 
CustomAuthSettings  
CustomFieldData Contains the attributes of a custom field, excluding the name, which is present as the key of the Map containing the field  
CustomFieldDefData Contains the attributes of a custom field, excluding the name, which is present as the key of the Map containing the field  
CustomFieldValue  
CustomFieldValueType The set of types a custom field can have  
CustomFilterData  
CvsRepositoryData Holds CVS specific attributes  
CvsRepositoryData FishEye repository data object for CVS repositories. 
CvsRepositoryData Holds additional properties specific to a CVS repository 
CvsRepositoryIndexer  

D

DefaultRepositoryOptions Default repository options for FishEye. 
DetailConstants Custom fields should be fq names like "com.company.myfield". 
DetailedReviewData  
DetailedReviewData.Builder Use this class when instantiating DetailedReviewData
DiffLineDecorator Provides decorations for the rendering lines of a diff. 
DiffType  
Direction The direction to search for graph data. 
DirectoryBrowser  
DirectorySummary  
DvcsCommitEvent An event thrown when a Distributed Version Control System repository (i.e. 

E

ExampleFishEyeAuthenticator An example authenticator. 
ExampleFishEyeAuthenticator.ExampleAuthToken  
ExampleFishEyeHttpAuthenticator An authenticator that accepts requests coming from a list (comma seperated) of preconfigured remote addresses. 
ExternalActivityItem  
ExternalActivityItemProvider An external provider of activity. 
ExternalActivityItemSearchParams Search parameters to constrain requests for activity from an ExternalActivityItemProvider
ExternalActivityItemSearchParams.SearchDirection A chronological direction to search for activity items. 
ExternalAuthSettings  

F

FieldValidator Utility class for validating field. 
FileData This interface is used by SPI users to feed a file to Crucible. 
FileHistory Details of the history of the file at a particular path. 
FileRevisionData Data object encapsulating information about a filerevision in the repository  
FileRevisionData.FileRevisionState  
FileRevisionKeyData Data Object for storing the path and revision identifying a filerevision  
FileSummary A summary of a file within a directory listing. 
FishEyeAuthenticator The authentication/authorisation plugin interface for FishEye. 
FisheyePluginUtilities Provides access to FishEye specific data required by plugins  
FisheyeReviewItemAttibutes  
FisheyeReviewItemData A bean containing the attributes of a change in a review  
FisheyeReviewItemData.CommitType  
FisheyeReviewItemData.FileType  

G

GeneralCommentData Holds the attributes of a general comment on a Review  
GeneralCommentData.Builder This class is deprecated. Use GeneralCommentData.GeneralCommentBuilder instead.  
GeneralCommentData.GeneralCommentBuilder Call build() to create an instance of GeneralCommentData
GitRepositoryData  
GitRepositoryData FishEye repository data object for Git repositories. 
GitRepositoryData Holds additional properties specific to a Git repository 
GitRepositoryIndexer  
GlobalHelper Global context data available to webfragments  
GutterRenderer A Plugin point for gutter-decorating the display of revisions or diffs between revisions. 
GutterRenderResult  

H

HasAuthenticationData  
HasChangelogBrowser An SCMRepository which provides access to a changelog sould implement this interface. 
HasDirectoryBrowser An SCMRepository which provides access to a directory tree should implement this interface. 
HasMaybeDetails  
Helper Interface providing access to helper classes. 
HgRepositoryData  
HgRepositoryData FishEye repository data object for Hg repositories. 
HgRepositoryData Holds additional properties specific to a Mercurial repository 
HostAuthSettings  

I

IllegalRepositoryStateException  
ImpersonationService Plugins may wish to perform operations as particular users. 
ISO8601DateAdapter  

L

LdapAuthSettings  
LdapAuthSettings.MatchType  
LineDecorator Provides gutter decorations for the rendering of lines in a file. 
LinkService Provides links to various parts of the running Fisheye/Crucible instance  
LocMetricsService  
LocMetricsService.QueryParameters  
LocMetricsService.QueryParameters.Builder  

M

MailMessageData Encapsulation of a mail message. 
MailService A service used by plugins to send email messages. 
ModuleConfigurationStore Configuration data store for plugin modules. 

N

NotFoundException Thrown by the spi services when a requested entity cannot be located. 
NotificationData  
NotificationData.Builder  
NotificationService  
NotPermittedException Raised by the api methods when a user attempts to access a resource he/she has no access. 
NullFishEyeAuthenticator Does not permit any access. 

O

Operation<T, E extends Throwable> Interface for operations carried out by services on behalf of plugins  

P

P4RepositoryData Holds Perforce specific attributes  
P4RepositoryData FishEye repository data object for Perforce repositories. 
P4RepositoryData Holds additional properties specific to a Perforce repository 
P4RepositoryIndexer  
PasswordAuthenticatedRepositoryData  
PatchAnchorFailedException Thrown when patch cannot be anchored to the repository. 
PathInfoData Data object for information about a file or directory in the fisheye index  
PermId<T> Holds a permId in a type-safe way PermIds are used to identify instances in the Crucible domain model. 
PluginId Opaque object given to plugin modules to allow them to identify themselves to services. 
PluginIdAware Plugin modules should implement this interface if they want to be injected with a PluginId  
PluginRepositoryData Contains information on a repository provided by a Crucibe SCM plugin module. 
Principal A Principal in Security terms is an entity that can be (and has been) authenticated. 
Principal.Anonymous  
Principal.SuperUser  
ProjectData Holds the attributes of a Project  
ProjectData.ProjectDataBuilder  
ProjectService Provides an API for working with Projects  

R

RecentChangesetsService Provides an API for searching and retrieving recently added changesets based on various criteria. 
RecentChangesetsService.QueryParameters  
RecentChangesetsService.QueryParameters.Builder  
RepositoryAdminService API for adminstration of FishEye repositories. 
RepositoryConfigException  
RepositoryData Holds the attributes of a repository  
RepositoryData A detached data object representing a FishEye repository. 
RepositoryData.Type  
RepositoryData.Type.Visitor<T>  
RepositoryDataFE Data object for information about a fisheye repository  
RepositoryDataFE.RepositoryState Enumeration listing the possible states of the repository  
RepositoryDeletedEvent Sent when a repository is deleted. 
RepositoryEvent Base interface for events involving a repository  
RepositoryHelper  
RepositoryIndexer An interface to the indexing actions on a repository. 
RepositoryIndexingStatus A snapshot of the status of a repository's indexer. 
RepositoryIndexingStatus.Builder  
RepositoryOptions Repository options for a specific FishEye repository. 
RepositoryService Provides an API for working with repositories  
RepositoryService Provides an API for retrieving information about the repositories in fisheye  
RepositoryState An enum that SCM implementations can use to internally track their repository state  
RepositoryState  
RepositoryUpdateResult Result of modifying a repository, indicating whether a restart and/or reindex is requried for the changes to take effect. 
ReviewCommentEvent An event regarding a Comment  
ReviewCompletionEvent Implementations of this event type are emitted each time a review's completion status changes (e.g. 
ReviewCreatedEvent A review has been created. 
ReviewData Holds the attributes of a review  
ReviewData.Builder Use this class when instantiating ReviewData
ReviewData.ReviewType  
ReviewData.State States of a review. 
ReviewDeletedEvent A review has been deleted. 
ReviewerCompletedEvent  
ReviewerData Holds user specific attributes  
Reviewers  
ReviewerUncompletedEvent  
ReviewEvent An Event occuring to a Review  
ReviewItemData Contains the attributes of an item in a review  
ReviewItemData.ParticipantStatus  
ReviewItemRevisionData  
ReviewItemRevisionDataChangedEvent  
ReviewItems  
ReviewService Provides an API for working with reviews. 
ReviewService.Action The actions which can be performed on a review, changing its state. 
ReviewStateChangedEvent A review has changed state. 
ReviewUpdatedEvent A change to a review which doesn't involve a state change or a change in review revision items  
RevisionData  
RevisionDataService Provides an API for getting information about changesets and filerevisions indexed by fisheye  
RevisionGraphSliceData  
RevisionKey A version of a file is uniquely identified by a path and a revision string  

S

SCMModule A type of repository -- a number of repositories of this type belong to this module Repositories in this module must have distinct names. 
SCMRepository A single Crucible plugin-based SCM repository. 
SearchService Provides an API for searching reviews. 
SearchService Provides an API for searching the fisheye repositories  
ServerException Thrown when something unexpected and serious has happened in the Fisheye/Crucible instance  
ServerInfoService  
SimpleConfiguration Interface for configuration ob jects which are used to configure plugins which are clients of the SimpleConfigurationServlet  
SimpleConfigurationServlet<T extends SimpleConfiguration> A base class for SCM configuration servlets which can treat their configuration objects as beans with String properties. 
SimpleLinker  
SvnRepositoryData Holds SVN specific attributes  
SvnRepositoryData FishEye repository data object for Subversion repositories. 
SvnRepositoryData Holds additional properties specific to a Subversion repository 
SvnRepositoryData.SymbolicRule Data object for patterns to match and extract repository structure from Subversion paths. 
SvnRepositoryIndexer  
SvnRepositoryService Provides an API for retrieving information about SVN repositories in fisheye  
SvnRepositoryService.BranchDetails  

T

TabularQueryResultData A data object representing the result of tabular eyeql query  
TabularQueryResultData.SearchResultColumnType  
TarballSettings  
TarballSettings.Exclude  
Transitions  
TrustedAppsService Supports making requests which have trusted application headers authenticating the current user. 

U

UserData Holds user specific attributes  
UserProfileData  
UserProfileData.PREFERENCE_KEYS collection of static fields that enumerate the String keys of the map returned by getPreferences(). 
UserProfileData.PREFERENCE_VALUES collection of static fields that enumerate possible String values in the map returned by getPreferences(). 
UserService Provides an API for working with Users. 

V

VelocityHelper  
VersionedCommentData An abstract base class for beans containing the attributes of comments  
VersionedLineCommentData Contains the attributes of a comment on an item in a review. 
VersionedLineCommentData.LineRangeDetail  
VersionedLineCommentData.VersionedLineCommentBuilder Creates VersionedLineCommentData instances. 
VersionInfo Crucible version info  

W

WikiRenderer A wiki renderer interface for plugins.