Package com.atlassian.confluence.rest.client.impl

Class RemoteRelationServiceImpl

java.lang.Object

com.atlassian.confluence.rest.client.AbstractRemoteService<RelationService>

com.atlassian.confluence.rest.client.impl.RemoteRelationServiceImpl

All Implemented Interfaces:

RemoteRelationService

public class RemoteRelationServiceImpl
extends AbstractRemoteService<RelationService>
implements RemoteRelationService

RelationService implementation that communicates with Confluence remotely using the Confluence REST API.

Field Summary

Fields inherited from class com.atlassian.confluence.rest.client.AbstractRemoteService

provider

Constructor Summary

Constructors

Constructor	Description
RemoteRelationServiceImpl(AuthenticatedWebResourceProvider provider, ExecutorService executor)

Method Summary

Modifier and Type	Method	Description
<S extends Relatable, T extends Relatable> CompletionStage<Void>	createCompletionStage(RelationInstance<S,T> relationInstance)	Creates a directed relation between two relatable entities.
<S extends Relatable, T extends Relatable> CompletionStage<Void>	deleteCompletionStage(RelationInstance<S,T> relationInstance)	Remove a relation if it exists between a source and a target relatable entity
<S extends Relatable, T extends Relatable> CompletionStage<Boolean>	isRelatedCompletionStage(S source, RelationDescriptor<S,T> relationDescriptor, T target)	Determine whether a given source and target are related by the given relation

Methods inherited from class com.atlassian.confluence.rest.client.AbstractRemoteService

addExpansions, addPageRequest, addPageRequestParams, deleteCompletionStage, deleteCompletionStage, getCompletionStage, getCompletionStageGenericCollection, getCompletionStageMap, getCompletionStageMapOfGenericListResponse, getCompletionStageMapOfPageResponses, getCompletionStageOptional, getCompletionStagePageResponseList, getCompletionStageSearchPageResponseList, getExecutor, newExperimentalRestWebTarget, newWebTarget, postCompletionStage, postCompletionStage, postCompletionStage, postCompletionStageToPageResponse, postVoidCompletionStage, putCompletionStage, putVoidCompletionStage

Methods inherited from class java.lang.Object

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

Constructor Details

RemoteRelationServiceImpl

public RemoteRelationServiceImpl(AuthenticatedWebResourceProvider provider,
 ExecutorService executor)

Since:

9.0

Method Details

createCompletionStage

public <S extends Relatable,
T extends Relatable>
CompletionStage<Void> createCompletionStage(RelationInstance<S,T> relationInstance)
                                     throws ServiceException

Description copied from interface: RemoteRelationService

Creates a directed relation between two relatable entities.

For example, when a user favourites a space a SpaceFavouriteRelation is created from the user to the space:

     relationService.create(RelationInstance.builder(user, new SpaceFavouriteRelation(), space).build));
 

Specified by:

createCompletionStage in interface RemoteRelationService

Type Parameters:

S - type of the source entity

T - type of the target entity

Parameters:

relationInstance - the relation to create

Returns:

the newly created relationInstance

Throws:

ServiceException - if validation fails

deleteCompletionStage

public <S extends Relatable,
T extends Relatable>
CompletionStage<Void> deleteCompletionStage(RelationInstance<S,T> relationInstance)
                                     throws ServiceException

Description copied from interface: RemoteRelationService

Remove a relation if it exists between a source and a target relatable entity

Specified by:

deleteCompletionStage in interface RemoteRelationService

Type Parameters:

S - type of the source entity

T - type of the target entity

Parameters:

relationInstance - relation to be deleted

Throws:

ServiceException - if validation fails

isRelatedCompletionStage

public <S extends Relatable,
T extends Relatable>
CompletionStage<Boolean> isRelatedCompletionStage(S source,
 RelationDescriptor<S,T> relationDescriptor,
 T target)

Description copied from interface: RemoteRelationService

Determine whether a given source and target are related by the given relation

Specified by:

isRelatedCompletionStage in interface RemoteRelationService

Type Parameters:

S - type of the source entity

T - type of the target entity

Returns:

true if the relation exists between the given source and target