Package com.atlassian.confluence.plugins.rest.navigation.v2.impl

Class RestNavigationImpl

java.lang.Object

com.atlassian.confluence.plugins.rest.navigation.v2.impl.RestNavigationImpl

All Implemented Interfaces:

Navigation, RestNavigation

public class RestNavigationImpl
extends Object
implements RestNavigation

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.confluence.api.nav.Navigation

Navigation.Builder, Navigation.ColorSchemeNav, Navigation.ContentNav, Navigation.ContentRestrictionByOperationNav, Navigation.ExperimentalContentNav, Navigation.ExperimentalContentTemplateNav, Navigation.ExperimentalNav, Navigation.ExperimentalSynchronyDataNav, Navigation.GroupNav, Navigation.LongTaskNav, Navigation.RelevantViewRestrictionsNav, Navigation.SpaceContentNav, Navigation.SpaceNav, Navigation.SpacePermissionNav, Navigation.UserNav

Nested classes/interfaces inherited from interface com.atlassian.confluence.rest.v2.api.services.RestNavigation

RestNavigation.RestBuilder

Constructor Summary

Constructors

Constructor	Description
RestNavigationImpl(String baseUrl, String contextPath)

Method Summary

Modifier and Type	Method	Description
com.atlassian.confluence.plugins.rest.navigation.v2.impl.RestNavigationImpl.BaseApiPathBuilder	baseApiPath()	provides a nav builder that knows about the base rest api path.
String	baseUrl()
Navigation.Builder	collection(Content content)	a builder to produce a URL to the collection that the content belongs to.
Navigation.Builder	collection(Space spaceData)	a builder to produce a URL to the collection that the space belongs to.
Navigation.ContentNav	content(Content content)	create a content nav builder to reference a piece of content
Navigation.ContentNav	content(ContentSelector selector)	Create a content nav builder to reference a piece of content with a particular id, status and version.
Navigation.ContentNav	content(ContentId contentId)	create a content nav builder to reference a piece of content
Navigation.ContentNav	content(Reference<Content> contentReference)	create a content nav builder to reference a piece of content
String	contextPath()
Navigation.ExperimentalNav	experimental()
Navigation.Builder	fromReference(Reference reference)
RestNavigation.RestBuilder	fromUriBuilder(javax.ws.rs.core.UriBuilder uriBuilder)
Navigation.GroupNav	group(Group group)	a builder to produce a url to a user group
Navigation.LongTaskNav	longTask(LongTaskId id)
Navigation.SpaceNav	space(Space space)	create a space nav builder to reference the given space
Navigation.SpaceNav	space(Reference<Space> space)	create a space nav builder to reference the given space
Navigation.SpacePermissionNav	spacePermission(Reference<SpacePermissionContainer> spacePermissions)	create a space permission nav builder to reference all the permissions of the given space restriction
Navigation.SpacePermissionNav	spacePermission(String spaceKey)	create a space permission nav builder to reference all the permissions of the given space key
Navigation.UserNav	user(com.atlassian.sal.api.user.UserKey userKey)	create a user nav builder to reference the user with the given user key

Methods inherited from class java.lang.Object

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

Constructor Details

RestNavigationImpl

public RestNavigationImpl(String baseUrl,
 String contextPath)

Method Details

experimental

public Navigation.ExperimentalNav experimental()

Specified by:

experimental in interface Navigation

content

public Navigation.ContentNav content(Content content)

Description copied from interface: Navigation

create a content nav builder to reference a piece of content

Specified by:

content in interface Navigation

content

public Navigation.ContentNav content(Reference<Content> contentReference)

Description copied from interface: Navigation

create a content nav builder to reference a piece of content

Specified by:

content in interface Navigation

content

public Navigation.ContentNav content(ContentId contentId)

Description copied from interface: Navigation

create a content nav builder to reference a piece of content

Specified by:

content in interface Navigation

content

public Navigation.ContentNav content(ContentSelector selector)

Description copied from interface: Navigation

Create a content nav builder to reference a piece of content with a particular id, status and version.

Specified by:

content in interface Navigation

baseApiPath

public com.atlassian.confluence.plugins.rest.navigation.v2.impl.RestNavigationImpl.BaseApiPathBuilder baseApiPath()

provides a nav builder that knows about the base rest api path. Useful for building other builders

Specified by:

baseApiPath in interface Navigation

Returns:

baseUrl

public String baseUrl()

Specified by:

baseUrl in interface Navigation

contextPath

public String contextPath()

Specified by:

contextPath in interface Navigation

fromUriBuilder

public RestNavigation.RestBuilder fromUriBuilder(javax.ws.rs.core.UriBuilder uriBuilder)

Specified by:

fromUriBuilder in interface RestNavigation

fromReference

public Navigation.Builder fromReference(Reference reference)

Specified by:

fromReference in interface Navigation

collection

public Navigation.Builder collection(Content content)

Description copied from interface: Navigation

a builder to produce a URL to the collection that the content belongs to.

Specified by:

collection in interface Navigation

collection

public Navigation.Builder collection(Space spaceData)

Description copied from interface: Navigation

a builder to produce a URL to the collection that the space belongs to.

Specified by:

collection in interface Navigation

space

public Navigation.SpaceNav space(Space space)

Description copied from interface: Navigation

create a space nav builder to reference the given space

Specified by:

space in interface Navigation

space

public Navigation.SpaceNav space(Reference<Space> space)

Description copied from interface: Navigation

create a space nav builder to reference the given space

Specified by:

space in interface Navigation

spacePermission

public Navigation.SpacePermissionNav spacePermission(String spaceKey)

Description copied from interface: Navigation

create a space permission nav builder to reference all the permissions of the given space key

Specified by:

spacePermission in interface Navigation

spacePermission

public Navigation.SpacePermissionNav spacePermission(Reference<SpacePermissionContainer> spacePermissions)

Description copied from interface: Navigation

create a space permission nav builder to reference all the permissions of the given space restriction

Specified by:

spacePermission in interface Navigation

group

public Navigation.GroupNav group(Group group)

Description copied from interface: Navigation

a builder to produce a url to a user group

Specified by:

group in interface Navigation

user

public Navigation.UserNav user(com.atlassian.sal.api.user.UserKey userKey)

Description copied from interface: Navigation

create a user nav builder to reference the user with the given user key

Specified by:

user in interface Navigation

Returns:

longTask

public Navigation.LongTaskNav longTask(LongTaskId id)

Specified by:

longTask in interface Navigation