org.xwiki.job.api

Class AbstractCheckRightsRequest

java.lang.Object

org.xwiki.job.AbstractRequest

org.xwiki.job.api.AbstractCheckRightsRequest

All Implemented Interfaces:

Serializable, org.xwiki.job.Request

@Unstable
public abstract class AbstractCheckRightsRequest
extends org.xwiki.job.AbstractRequest

Define a request that have rights to check.

Since:

10.10RC1, 10.8.2, 9.11.9

Version:

$Id: 0b5e4b1271e071807b318f5330c9e54d5c821d2e $

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.xwiki.job.Request

PROPERTY_CONTEXT, PROPERTY_INTERACTIVE, PROPERTY_REMOTE

Constructor Summary

Constructors

Constructor and Description
AbstractCheckRightsRequest()

Method Summary

Modifier and Type	Method and Description
DocumentReference	getAuthorReference()
DocumentReference	getUserReference()
boolean	isCheckAuthorRights()
boolean	isCheckRights()
void	setAuthorReference(DocumentReference authorReference) Sets the author of the script which is performing the request.
void	setCheckAuthorRights(boolean checkAuthorRights) Sets whether the job should check or not if the user specified by getAuthorReference() is authorized to perform the actions implied by this request.
void	setCheckRights(boolean checkRights) Sets whether the job should check or not if the user specified by getUserReference() is authorized to perform the actions implied by this request.
void	setUserReference(DocumentReference userReference) Sets the user that should be used to perform this request.

Methods inherited from class org.xwiki.job.AbstractRequest

containsProperty, getContext, getId, getProperties, getProperty, getProperty, getPropertyNames, isInteractive, isRemote, isStatusLogIsolated, isStatusSerialized, isVerbose, removeProperty, setContext, setId, setId, setId, setInteractive, setProperty, setRemote, setStatusLogIsolated, setStatusSerialized, setVerbose

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCheckRightsRequest

public AbstractCheckRightsRequest()

Method Detail

isCheckAuthorRights

public boolean isCheckAuthorRights()

Returns:

true in case the job should check if the author specified by getAuthorReference() is authorized to perform the actions implied by this request, false otherwise

setCheckAuthorRights

public void setCheckAuthorRights(boolean checkAuthorRights)

Sets whether the job should check or not if the user specified by getAuthorReference() is authorized to perform the actions implied by this request.

Parameters:

checkAuthorRights - true to check if getAuthorReference() is authorized to perform this request, false to perform this request without checking rights

isCheckRights

public boolean isCheckRights()

Returns:

true in case the job should check if the user specified by getUserReference() is authorized to perform the actions implied by this request, false otherwise

setCheckRights

public void setCheckRights(boolean checkRights)

Sets whether the job should check or not if the user specified by getUserReference() is authorized to perform the actions implied by this request.

Parameters:

checkRights - true to check if getUserReference() is authorized to perform this request, false to perform this request without checking rights

getUserReference

public DocumentReference getUserReference()

Returns:

the user that should be used to perform this request; this user must be authorized to perform the actions implied by this request if isCheckRights() is true.

setUserReference

public void setUserReference(DocumentReference userReference)

Sets the user that should be used to perform this request. This user must be authorized to perform the actions implied by this request if isCheckRights() is true.

Parameters:

userReference - the user reference

getAuthorReference

public DocumentReference getAuthorReference()

Returns:

the author of the script which is performing the request; this user must be authorized to perform the actions implied by this request if isCheckRights() is true.

setAuthorReference

public void setAuthorReference(DocumentReference authorReference)

Sets the author of the script which is performing the request. This user must be authorized to perform the actions implied by this request if isCheckRights() is true.

Parameters:

authorReference - the author reference