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.

Constructor Summary

Constructors

Constructor and Description
RemoteRelationServiceImpl(AuthenticatedWebResourceProvider provider, com.google.common.util.concurrent.ListeningExecutorService executor)

Method Summary

Modifier and Type	Method and Description
<S extends Relatable,T extends Relatable> com.atlassian.util.concurrent.Promise<Void>	create(RelationInstance<S,T> relationInstance) Creates a directed relation between two relatable entities.
<S extends Relatable,T extends Relatable> com.atlassian.util.concurrent.Promise<Void>	delete(RelationInstance<S,T> relationInstance) Remove a relation if it exists between a source and a target relatable entity
<S extends Relatable,T extends Relatable> com.atlassian.util.concurrent.Promise<Boolean>	isRelated(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, deleteFuture, deleteFuture, getFuture, getFutureGenericCollection, getFutureMap, getFutureMapOfPageResponses, getFutureOption, getFuturePageResponseList, newExperimentalRestWebResource, newRestWebResource, postFuture, postFuture, postFuture, postFutureToPageResponse, putFuture

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteRelationServiceImpl

public RemoteRelationServiceImpl(AuthenticatedWebResourceProvider provider,
                                 com.google.common.util.concurrent.ListeningExecutorService executor)

Method Detail

create

public <S extends Relatable,T extends Relatable> com.atlassian.util.concurrent.Promise<Void> create(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:

create 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

delete

public <S extends Relatable,T extends Relatable> com.atlassian.util.concurrent.Promise<Void> delete(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:

delete 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

isRelated

public <S extends Relatable,T extends Relatable> com.atlassian.util.concurrent.Promise<Boolean> isRelated(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:

isRelated 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