Class ViewContentBean
- java.lang.Object
-
- com.atlassian.confluence.it.content.ViewContentBean
-
public class ViewContentBean extends Object
Represents a View page for a Page or News.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ViewContentBean.Builder
-
Field Summary
Fields Modifier and Type Field Description static String
REMOVE_CONTENT_MENU_LINK
static String
SHOW_COMMENTS_ID
static String
VIEW_PAGE_INFO_LINK_ID
static String
VIEW_SOURCE_LINK_ID
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description EditContentBean
addComment()
ViewContentBean
addTextComment(String comment)
void
assertCanAddComment()
void
assertCanEdit()
void
assertHasNoViewPermission()
void
assertHasViewPermission()
static ViewContentBean.Builder
builder()
static ViewContentBean.Builder
builder(net.sourceforge.jwebunit.junit.WebTester tester)
boolean
canAddAttachment()
Deprecated.since 5.9.0.boolean
canAddBlogPost()
Deprecated.since 5.9.0.boolean
canAddComment()
Returns true if the Add Comment link is present.boolean
canAddPage()
Deprecated.since 5.9.0.boolean
canEdit()
boolean
canRemoveComment(String commentId)
boolean
canRequestAccess()
Returns true if the request access button link is present.boolean
containsLinkTo(String spaceKey, String pageTitle)
EditContentBean
copy()
EditContentBean
createBlogPost()
Deprecated.since 5.9.0 useEditContentBean.CreateByUrlBuilder
instead.EditContentBean
createPage()
Deprecated.since 5.9.0 useEditContentBean.CreateByUrlBuilder
instead.EditContentBean
edit()
EditContentBean
editBlogPost()
EditContentBean
editComment(String commentId)
void
ensureCommentsAreShown()
List<String>
getChildren()
Returns the first 20 child page titles (if any) on the current page in the order they appear.List<CommentBean>
getComments()
Gets the first 20 top-level comments (if any) on the current page.String
getContent()
CommentBean
getFocusedComment()
long
getPageId()
PageMetadata
getPageMetadata()
Date
getRequestTime()
String
getTitle()
boolean
hasLabel(String label)
boolean
hasNoPermission()
Deprecated.Since 5.6 UseassertHasViewPermission()
orassertHasNoViewPermission()
boolean
isFavourite()
Returns true if the unfavourite link is present, and false if the favourite link is present.boolean
isNotPermitted()
boolean
isRestricted()
Returns true if the page restrictions link is present.boolean
isViewable()
Deprecated.since 5.6 UseassertHasNoViewPermission()
orassertHasViewPermission()
boolean
pageNotFound()
Returns true if the "Page Not Found" screen is presented.void
remove()
void
removeComment(String commentId)
EditContentBean
replyToComment(String commentId)
void
setAsFavourite()
Marks this page as a favourite.ViewAttachmentsBean
viewAttachments()
static ViewContentBean
viewBlogPost()
Factory method to return a ViewContentBean pointing at the current location of the web tester.static ViewContentBean
viewBlogPost(long contentId)
Factory method to return a ViewContentBean for the blog post with the given content ID.static ViewContentBean
viewBlogPost(long contentId, net.sourceforge.jwebunit.junit.WebTester webTester)
Factory method to return a ViewContentBean for the blog post with the given content ID.static ViewContentBean
viewBlogPost(BlogPost blogPost)
static ViewContentBean
viewBlogPost(BlogPost blogPost, net.sourceforge.jwebunit.junit.WebTester webTester)
static ViewContentBean
viewBlogPost(String spaceKey, String postTitle)
Deprecated.Since 5.6.static ViewContentBean
viewBlogPost(String spaceKey, String postTitle, Date postDate)
Factory method to return a ViewContentBean for the given post and space.static ViewContentBean
viewBlogPost(String spaceKey, String postTitle, Date postDate, net.sourceforge.jwebunit.junit.WebTester webTester)
Factory method to return a ViewContentBean for the given post and space.static ViewContentBean
viewBlogPost(String spaceKey, String postTitle, net.sourceforge.jwebunit.junit.WebTester webTester)
Deprecated.Since 5.6.static ViewContentBean
viewBlogPost(net.sourceforge.jwebunit.junit.WebTester webTester)
static ViewContentBean
viewBlogPostRespectingDate(BlogPost blogPost)
When viewing the blog actually respect the date set on the blog.static ViewContentBean
viewBlogPostRespectingDate(BlogPost blogPost, net.sourceforge.jwebunit.junit.WebTester webTester)
When viewing the blog actually respect the date set on the blog.ContentInfoBean
viewInfo()
static ViewContentBean
viewPage()
Factory method to return a ViewContentBean pointing at the current location of the web tester.static ViewContentBean
viewPage(long contentId)
Factory method to return a ViewContentBean for the page with the given content ID.static ViewContentBean
viewPage(long contentId, net.sourceforge.jwebunit.junit.WebTester webTester)
Factory method to return a ViewContentBean for the page with the given content ID.static ViewContentBean
viewPage(Page page)
static ViewContentBean
viewPage(Page page, net.sourceforge.jwebunit.junit.WebTester tester)
static ViewContentBean
viewPage(Space space)
View the home page of the given space.static ViewContentBean
viewPage(Space space, String pageTitle)
Factory method to return a ViewContentBean for the given page and space.static ViewContentBean
viewPage(Space space, String pageTitle, net.sourceforge.jwebunit.junit.WebTester tester)
static ViewContentBean
viewPage(Space space, net.sourceforge.jwebunit.junit.WebTester tester)
static ViewContentBean
viewPage(String spaceKey)
Factory method to return a ViewContentBean for the homepage of the given space.static ViewContentBean
viewPage(String spaceKey, String pageTitle)
Factory method to return a ViewContentBean for the given page and space.static ViewContentBean
viewPage(String spaceKey, String pageTitle, boolean commentsOn)
Factory method to return a ViewContentBean for the given page and space, with comments specifically requested on or off.static ViewContentBean
viewPage(String spaceKey, String pageTitle, boolean commentsOn, net.sourceforge.jwebunit.junit.WebTester webTester)
Factory method to return a ViewContentBean for the given page and space, with comments specifically requested on or off.static ViewContentBean
viewPage(String spaceKey, String pageTitle, net.sourceforge.jwebunit.junit.WebTester webTester)
static ViewContentBean
viewPage(String spaceKey, net.sourceforge.jwebunit.junit.WebTester webTester)
Factory method to return a ViewContentBean for the homepage of the given space.static ViewContentBean
viewPage(net.sourceforge.jwebunit.junit.WebTester webTester)
static ViewContentBean
viewPersonalSpace(String username)
static ViewContentBean
viewPersonalSpace(String username, net.sourceforge.jwebunit.junit.WebTester webTester)
static ViewContentBean
viewSpaceHomePage(Space space)
static ViewContentBean
viewSpaceHomePage(Space space, net.sourceforge.jwebunit.junit.WebTester webTester)
static ViewContentBean
viewUrl(String url)
static ViewContentBean
viewUrl(String url, net.sourceforge.jwebunit.junit.WebTester webTester)
void
viewWikiMarkup()
-
-
-
Field Detail
-
VIEW_SOURCE_LINK_ID
public static final String VIEW_SOURCE_LINK_ID
- See Also:
- Constant Field Values
-
SHOW_COMMENTS_ID
public static final String SHOW_COMMENTS_ID
- See Also:
- Constant Field Values
-
REMOVE_CONTENT_MENU_LINK
public static final String REMOVE_CONTENT_MENU_LINK
- See Also:
- Constant Field Values
-
VIEW_PAGE_INFO_LINK_ID
public static final String VIEW_PAGE_INFO_LINK_ID
- See Also:
- Constant Field Values
-
-
Method Detail
-
viewPage
public static ViewContentBean viewPage()
Factory method to return a ViewContentBean pointing at the current location of the web tester.
-
viewPage
public static ViewContentBean viewPage(net.sourceforge.jwebunit.junit.WebTester webTester)
-
viewBlogPost
public static ViewContentBean viewBlogPost()
Factory method to return a ViewContentBean pointing at the current location of the web tester.
-
viewBlogPost
public static ViewContentBean viewBlogPost(net.sourceforge.jwebunit.junit.WebTester webTester)
-
viewBlogPost
@Deprecated public static ViewContentBean viewBlogPost(String spaceKey, String postTitle)
Deprecated.Since 5.6. This method is flaky as dates can change during test runs. UseviewBlogPost(com.atlassian.confluence.it.BlogPost)
instead.Factory method to return a ViewContentBean for the given post and space. The post is assumed to be posted today.
-
viewBlogPost
@Deprecated public static ViewContentBean viewBlogPost(String spaceKey, String postTitle, net.sourceforge.jwebunit.junit.WebTester webTester)
Deprecated.Since 5.6. This method is flaky as dates can change during test runs. UseviewBlogPost(com.atlassian.confluence.it.BlogPost)
instead.Factory method to return a ViewContentBean for the given post and space. The post is assumed to be posted today.
-
viewBlogPost
public static ViewContentBean viewBlogPost(String spaceKey, String postTitle, Date postDate)
Factory method to return a ViewContentBean for the given post and space. The date in the post is used.
-
viewBlogPost
public static ViewContentBean viewBlogPost(String spaceKey, String postTitle, Date postDate, net.sourceforge.jwebunit.junit.WebTester webTester)
Factory method to return a ViewContentBean for the given post and space. The date in the post is used.
-
viewBlogPost
public static ViewContentBean viewBlogPost(long contentId)
Factory method to return a ViewContentBean for the blog post with the given content ID.
-
viewBlogPost
public static ViewContentBean viewBlogPost(long contentId, net.sourceforge.jwebunit.junit.WebTester webTester)
Factory method to return a ViewContentBean for the blog post with the given content ID.
-
viewBlogPost
public static ViewContentBean viewBlogPost(BlogPost blogPost)
-
viewBlogPost
public static ViewContentBean viewBlogPost(BlogPost blogPost, net.sourceforge.jwebunit.junit.WebTester webTester)
-
viewBlogPostRespectingDate
public static ViewContentBean viewBlogPostRespectingDate(BlogPost blogPost)
When viewing the blog actually respect the date set on the blog.
-
viewBlogPostRespectingDate
public static ViewContentBean viewBlogPostRespectingDate(BlogPost blogPost, net.sourceforge.jwebunit.junit.WebTester webTester)
When viewing the blog actually respect the date set on the blog.
-
viewPage
public static ViewContentBean viewPage(long contentId)
Factory method to return a ViewContentBean for the page with the given content ID.
-
viewPage
public static ViewContentBean viewPage(long contentId, net.sourceforge.jwebunit.junit.WebTester webTester)
Factory method to return a ViewContentBean for the page with the given content ID.
-
viewPage
public static ViewContentBean viewPage(String spaceKey, net.sourceforge.jwebunit.junit.WebTester webTester)
Factory method to return a ViewContentBean for the homepage of the given space.
-
viewPage
public static ViewContentBean viewPage(String spaceKey)
Factory method to return a ViewContentBean for the homepage of the given space.
-
viewPage
public static ViewContentBean viewPage(Space space, String pageTitle)
Factory method to return a ViewContentBean for the given page and space.
-
viewPage
public static ViewContentBean viewPage(Space space, String pageTitle, net.sourceforge.jwebunit.junit.WebTester tester)
-
viewPage
public static ViewContentBean viewPage(String spaceKey, String pageTitle, net.sourceforge.jwebunit.junit.WebTester webTester)
-
viewPage
public static ViewContentBean viewPage(String spaceKey, String pageTitle)
Factory method to return a ViewContentBean for the given page and space.
-
viewPage
public static ViewContentBean viewPage(Page page)
-
viewPage
public static ViewContentBean viewPage(Page page, net.sourceforge.jwebunit.junit.WebTester tester)
-
viewPage
public static ViewContentBean viewPage(Space space)
View the home page of the given space.- Parameters:
space
- of which the home page will be visited- Returns:
- a
ViewContentBean
viewing the home page of the space.
-
viewPage
public static ViewContentBean viewPage(Space space, net.sourceforge.jwebunit.junit.WebTester tester)
-
viewPage
public static ViewContentBean viewPage(String spaceKey, String pageTitle, boolean commentsOn)
Factory method to return a ViewContentBean for the given page and space, with comments specifically requested on or off.- Parameters:
commentsOn
- specifies value of the showComments parameter
-
viewPage
public static ViewContentBean viewPage(String spaceKey, String pageTitle, boolean commentsOn, net.sourceforge.jwebunit.junit.WebTester webTester)
Factory method to return a ViewContentBean for the given page and space, with comments specifically requested on or off.- Parameters:
commentsOn
- specifies value of the showComments parameter
-
viewPersonalSpace
public static ViewContentBean viewPersonalSpace(String username)
-
viewPersonalSpace
public static ViewContentBean viewPersonalSpace(String username, net.sourceforge.jwebunit.junit.WebTester webTester)
-
viewSpaceHomePage
public static ViewContentBean viewSpaceHomePage(Space space)
-
viewSpaceHomePage
public static ViewContentBean viewSpaceHomePage(Space space, net.sourceforge.jwebunit.junit.WebTester webTester)
-
viewUrl
public static ViewContentBean viewUrl(String url)
-
viewUrl
public static ViewContentBean viewUrl(String url, net.sourceforge.jwebunit.junit.WebTester webTester)
-
builder
public static ViewContentBean.Builder builder()
-
builder
public static ViewContentBean.Builder builder(net.sourceforge.jwebunit.junit.WebTester tester)
-
getTitle
public String getTitle()
-
getContent
public String getContent()
-
createPage
@Deprecated public EditContentBean createPage()
Deprecated.since 5.9.0 useEditContentBean.CreateByUrlBuilder
instead.
-
createBlogPost
@Deprecated public EditContentBean createBlogPost()
Deprecated.since 5.9.0 useEditContentBean.CreateByUrlBuilder
instead.
-
edit
public EditContentBean edit()
-
editBlogPost
public EditContentBean editBlogPost()
-
remove
public void remove()
-
addTextComment
public ViewContentBean addTextComment(String comment)
-
addComment
public EditContentBean addComment()
-
getComments
public List<CommentBean> getComments()
Gets the first 20 top-level comments (if any) on the current page.Ensures the comments are shown before trying to retrieve anything, so may result in a page reload.
- See Also:
TODO threading.
-
replyToComment
public EditContentBean replyToComment(String commentId)
-
editComment
public EditContentBean editComment(String commentId)
-
removeComment
public void removeComment(String commentId)
-
viewAttachments
public ViewAttachmentsBean viewAttachments()
-
viewInfo
public ContentInfoBean viewInfo()
-
ensureCommentsAreShown
public void ensureCommentsAreShown()
-
getChildren
public List<String> getChildren()
Returns the first 20 child page titles (if any) on the current page in the order they appear. Relies on the child page section being already expanded. If you want to test showing/hiding the children, you will need to use Selenium as this is done with javascript as of CONFDEV-1005As of CONFDEV-22698 the default sidebar setting will be pagetree, which will not play nicely with this method as-is. The following can be used as a temporary workaround to switch spaces to use the old child pages view:
rpc.executeAuthPluginXmlRpc("space-sidebar", "setOption", TEST_SPACE.getKey(), "nav-type", "pages");
-
viewWikiMarkup
public void viewWikiMarkup()
-
getPageId
public long getPageId()
-
isFavourite
public boolean isFavourite()
Returns true if the unfavourite link is present, and false if the favourite link is present.- Throws:
AssertionError
- if neither link is present.
-
setAsFavourite
public void setAsFavourite()
Marks this page as a favourite.
-
isRestricted
public boolean isRestricted()
Returns true if the page restrictions link is present.- Returns:
- true if there are page restrictions on the current page
-
canRequestAccess
public boolean canRequestAccess()
Returns true if the request access button link is present.- Returns:
- true if there are page restrictions on the current page
-
canAddPage
@Deprecated public boolean canAddPage()
Deprecated.since 5.9.0.
-
canAddBlogPost
@Deprecated public boolean canAddBlogPost()
Deprecated.since 5.9.0.
-
canAddComment
public boolean canAddComment()
Returns true if the Add Comment link is present.
-
canRemoveComment
public boolean canRemoveComment(String commentId)
-
canAddAttachment
@Deprecated public boolean canAddAttachment()
Deprecated.since 5.9.0.
-
canEdit
public boolean canEdit()
-
pageNotFound
public boolean pageNotFound()
Returns true if the "Page Not Found" screen is presented.
-
hasNoPermission
@Deprecated public boolean hasNoPermission()
Deprecated.Since 5.6 UseassertHasViewPermission()
orassertHasNoViewPermission()
-
assertHasNoViewPermission
public void assertHasNoViewPermission()
-
assertHasViewPermission
public void assertHasViewPermission()
-
assertCanEdit
public void assertCanEdit()
-
assertCanAddComment
public void assertCanAddComment()
-
isNotPermitted
public boolean isNotPermitted()
-
getRequestTime
public Date getRequestTime()
-
getFocusedComment
public CommentBean getFocusedComment()
-
isViewable
@Deprecated public boolean isViewable()
Deprecated.since 5.6 UseassertHasNoViewPermission()
orassertHasViewPermission()
-
copy
public EditContentBean copy()
-
hasLabel
public boolean hasLabel(String label)
-
getPageMetadata
public PageMetadata getPageMetadata()
-
-