|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.atlassian.crucible.plugin.export.CrucibleRestClient
public class CrucibleRestClient
Provides helper methods to access the Crucible Web Services API.
Constructor Summary | |
---|---|
CrucibleRestClient()
|
Method Summary | |
---|---|
java.util.List<com.atlassian.crucible.spi.data.GeneralCommentData> |
getGeneralComments(java.lang.String reviewId)
Returns the list of GeneralCommentData instances for the
reviewId. |
com.atlassian.crucible.spi.data.ReviewData |
getReview(java.lang.String reviewId)
Retrieves the ReviewData instance for the reviewId. |
com.atlassian.crucible.spi.data.FisheyeReviewItemData |
getReviewItemData(java.lang.String reviewId,
java.lang.String reviewItemId)
Retrieves the FisheyeReviewItemData instance for the reviewId and
the reviewItemId |
java.lang.String |
getUserName(java.lang.String userId)
Returns the userId (there isn't a mechanism within the Crucible REST API to retrieve the user name). |
java.util.List<com.atlassian.crucible.spi.data.VersionedLineCommentData> |
getVersionedComments(java.lang.String reviewId)
Returns a list of VersionedLineCommentData instances for the
reviewId. |
java.lang.String |
login(java.lang.String userName,
java.lang.String password)
Performs a login action using the username and password. |
void |
setBaseUrl(java.lang.String baseUrl)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CrucibleRestClient()
Method Detail |
---|
public java.lang.String login(java.lang.String userName, java.lang.String password)
login
in interface CrucibleClient
public com.atlassian.crucible.spi.data.ReviewData getReview(java.lang.String reviewId)
ReviewData
instance for the reviewId.
getReview
in interface CrucibleClient
reviewId
-
public java.util.List<com.atlassian.crucible.spi.data.GeneralCommentData> getGeneralComments(java.lang.String reviewId)
GeneralCommentData
instances for the
reviewId.
getGeneralComments
in interface CrucibleClient
token
- reviewId
-
public java.util.List<com.atlassian.crucible.spi.data.VersionedLineCommentData> getVersionedComments(java.lang.String reviewId)
VersionedLineCommentData
instances for the
reviewId.
getVersionedComments
in interface CrucibleClient
token
- reviewId
-
public void setBaseUrl(java.lang.String baseUrl)
baseUrl
- public com.atlassian.crucible.spi.data.FisheyeReviewItemData getReviewItemData(java.lang.String reviewId, java.lang.String reviewItemId)
FisheyeReviewItemData
instance for the reviewId and
the reviewItemId
getReviewItemData
in interface CrucibleClient
reviewId
- reviewItemId
-
public java.lang.String getUserName(java.lang.String userId)
getUserName
in interface CrucibleClient
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |