org.xwiki.security.authorization

Interface AuthorExecutor

@Role
public interface AuthorExecutor

Allow executing some code with the right of a provided user.

Since:

8.3RC1

Version:

$Id: c6d190f0c75c327429b7cd920a393fd2d50c4946 $

Method Summary

Modifier and Type	Method and Description
void	after(AutoCloseable context) Restore the context to it's previous state as defined by the provided AutoCloseable.
AutoCloseable	before(DocumentReference authorReference) Deprecated. since 10.11RC1, use before(DocumentReference, DocumentReference) instead
default AutoCloseable	before(DocumentReference authorReference, DocumentReference sourceReference) Setup the context so that following code is executed with provided user rights.
<V> V	call(Callable<V> callable, DocumentReference authorReference) Deprecated. since 10.11RC1, use call(Callable, DocumentReference, DocumentReference) instead
default <V> V	call(Callable<V> callable, DocumentReference authorReference, DocumentReference sourceReference) Execute the passed Callable with the rights of the passed user.

Method Detail

call

@Deprecated
<V> V call(Callable<V> callable,
                       DocumentReference authorReference)
                throws Exception

Deprecated. since 10.11RC1, use call(Callable, DocumentReference, DocumentReference) instead

Execute the passed Callable with the rights of the passed user.

Type Parameters:

V - the result type of method call

Parameters:

callable - the task to execute

authorReference - the user to check rights on

Returns:

computed result

Throws:

Exception - if unable to compute a result

call

@Unstable
default <V> V call(Callable<V> callable,
                             DocumentReference authorReference,
                             DocumentReference sourceReference)
                      throws Exception

Execute the passed Callable with the rights of the passed user.

Type Parameters:

V - the result type of method call

Parameters:

callable - the task to execute

authorReference - the user to check rights on

sourceReference - the reference of the document associated with the Callable (which will be used to test the author right)

Returns:

computed result

Throws:

Exception - if unable to compute a result

Since:

10.11RC1

before

@Deprecated
AutoCloseable before(DocumentReference authorReference)

Deprecated. since 10.11RC1, use before(DocumentReference, DocumentReference) instead

Setup the context so that following code is executed with provided user rights.

 
 try (AutoCloseable context = this.executor.before(author)) {
   ...
 }
 
 

Parameters:

authorReference - the user to check rights on

Returns:

the context to restore

See Also:

after(AutoCloseable)

before

@Unstable
default AutoCloseable before(DocumentReference authorReference,
                                       DocumentReference sourceReference)

Setup the context so that following code is executed with provided user rights.

 
 try (AutoCloseable context = this.executor.before(author, sourceDocument)) {
   ...
 }
 
 

Parameters:

authorReference - the user to check rights on

sourceReference - the reference of the document associated with the Callable (which will be used to test the author right)

Returns:

the context to restore

Since:

10.11RC1

See Also:

after(AutoCloseable)

after

void after(AutoCloseable context)

Restore the context to it's previous state as defined by the provided AutoCloseable.

Parameters:

context - the context to restore

See Also:

before(DocumentReference)