AuthenticatedUserRelationDescriptor (Atlassian Confluence 8.1.0-beta1 API)

java.lang.Object
- com.atlassian.confluence.api.impl.service.relation.DefaultValidatingRelationDescriptor<S,T>
- - com.atlassian.confluence.api.impl.service.relation.AuthenticatedUserRelationDescriptor<S,T>

All Implemented Interfaces:

RelationDescriptor<S,T>, ValidatingRelationDescriptor<S,T>
```
public class AuthenticatedUserRelationDescriptor<S extends User,T extends Relatable>
extends DefaultValidatingRelationDescriptor<S,T>
```
A ValidatingRelationDescriptor which checks that the User for which the relation is being created is also the currently authenticated user. Used to validate relations where users can only create relations for themselves.

Since:

5.11

Constructor Summary

Constructors
Modifier Constructor Description

protected AuthenticatedUserRelationDescriptor(RelationDescriptor relationDescriptor)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ValidationResult`	`canRelate(S source, T target)`	Returns `ValidationResult`, which indicates if two given entities may form a relation, described by this `RelationDescriptor` object

Methods inherited from class com.atlassian.confluence.api.impl.service.relation.DefaultValidatingRelationDescriptor
getRelationName, getSourceClass, getTargetClass

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AuthenticatedUserRelationDescriptor
```
protected AuthenticatedUserRelationDescriptor(RelationDescriptor relationDescriptor)
```
- Method Detail
  - canRelate
```
public ValidationResult canRelate(S source,
                                  T target)
```
    Description copied from interface: ValidatingRelationDescriptor
    
    Returns ValidationResult, which indicates if two given entities may form a relation, described by this RelationDescriptor object
    
    Specified by:
    
    canRelate in interface ValidatingRelationDescriptor<S extends User,T extends Relatable>
    
    Overrides:
    
    canRelate in class DefaultValidatingRelationDescriptor<S extends User,T extends Relatable>
    
    Parameters:
    
    source - entity
    
    target - entity
    
    Returns:
    
    validation result