com.jalios.jcms

Class RightPolicyManager

java.lang.Object

com.jalios.jcms.policy.AbstractPolicyManager<RightPolicyFilter>

com.jalios.jcms.RightPolicyManager

public class RightPolicyManager
extends AbstractPolicyManager<RightPolicyFilter>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MEMBER_READ_RIGHT_ENABLED_PROPERTY

Method Summary

Modifier and Type	Method and Description
boolean	callCanBeReadBy(PublicationCriteria pubCriteria)
boolean	canBeReadBy(boolean isAuthorized, Category cat, Group grp, boolean checkAncestors)
boolean	canBeReadBy(boolean isAuthorized, Category cat, Member mbr, boolean searchInGroups, boolean checkAncestors)
boolean	canBeReadBy(boolean isAuthorized, Group grp, Member mbr)
boolean	canBeReadBy(boolean isAuthorized, Member mbrToRead, Member mbrReading, RightInfo rightInfo) Checks if a member can read the specified Member.
boolean	canBeReadBy(boolean isAuthorized, Publication pub, Group grp, RightInfo rightInfo)
boolean	canBeReadBy(boolean isAuthorized, Publication pub, Member mbr, boolean searchInGroups, RightInfo rightInfo)
boolean	canCreateContact(boolean isAuthorized, Member mbr)
boolean	canCreateWorkspace(boolean isAuthorized, Member mbr, Workspace model)
boolean	canDeleteOther(boolean isAuthorized, Member mbr, java.lang.Class<? extends Publication> clazz, Workspace ws)
boolean	canDeleteOther(boolean isAuthorized, Member mbr, Data data, RightInfo rightInfo)
boolean	canManageCategory(boolean isAuthorized, Member mbr, Category cat, boolean searchInGroups, boolean searchInParent)
boolean	canPublish(boolean isAuthorized, Member mbr, java.lang.Class<? extends Publication> clazz, java.util.Set<? extends Workspace> wsSet)
boolean	canUpdateOther(boolean isAuthorized, Member mbr, java.lang.Class<? extends Publication> clazz, Workspace ws)
boolean	canUpdateOther(boolean isAuthorized, Member mbr, Data data, RightInfo rightInfo)
boolean	canUseCategory(boolean isAuthorized, Member mbr, Category cat, boolean searchInGroups, boolean searchInParent)
boolean	canWorkOn(boolean isAuthorized, Publication pub, Member member, RightInfo rightInfo)
ControllerStatus	canWorkOn(ControllerStatus status, int op, Member mbr, Member member)
java.lang.Boolean	checkAccess(Member member, java.lang.String resource, java.util.Map<java.lang.String,java.lang.Object> context)
boolean	checkAfterUpload(DocUploadInfo info)
boolean	checkBeforeUpload(java.lang.String fieldName, java.lang.String contentType, java.lang.String fileName)
ControllerStatus	checkHtml(java.lang.String str, java.lang.String field)
static RightPolicyManager	getInstance()
protected java.lang.String	getStatusXmlTagName()
java.util.Set<Workspace>	getWorkspaceSet(java.util.Set<Workspace> workspaceSet, Member mbr)
boolean	isAdmin(boolean isAdmin, Member member, Workspace workspace)
boolean	isMemberReadRightEnabled() Check if member read right is enabled.
boolean	isWorker(boolean isWorker, Member member, Workspace ws)
void	setMemberReadRightEnabled(java.lang.Boolean isMemberReadRightEnabled) Set whether member read right is enabled or not.

Methods inherited from class com.jalios.jcms.policy.AbstractPolicyManager

addPolicyFilter, getPolicyFilters, getPolicyFiltersMap, handleException, removePolicyFilter

Methods inherited from class java.lang.Object

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

Field Detail

MEMBER_READ_RIGHT_ENABLED_PROPERTY

public static final java.lang.String MEMBER_READ_RIGHT_ENABLED_PROPERTY

See Also:

Constant Field Values

Method Detail

getInstance

public static final RightPolicyManager getInstance()

getStatusXmlTagName

protected java.lang.String getStatusXmlTagName()

Specified by:

getStatusXmlTagName in class AbstractPolicyManager<RightPolicyFilter>

canUpdateOther

public boolean canUpdateOther(boolean isAuthorized,
                              Member mbr,
                              Data data,
                              RightInfo rightInfo)

Since:

jcms-5.7.1

See Also:

RightPolicyFilter.canUpdateOther(boolean, Member, Data)

canDeleteOther

public boolean canDeleteOther(boolean isAuthorized,
                              Member mbr,
                              Data data,
                              RightInfo rightInfo)

Since:

jcms-5.7.1

See Also:

RightPolicyFilter.canDeleteOther(boolean, Member, Data)

callCanBeReadBy

public boolean callCanBeReadBy(PublicationCriteria pubCriteria)

Since:

jcms-7.0.0

See Also:

RightPolicyFilter.canBeReadBy(boolean, Publication, Member, boolean)

canBeReadBy

public boolean canBeReadBy(boolean isAuthorized,
                           Publication pub,
                           Member mbr,
                           boolean searchInGroups,
                           RightInfo rightInfo)

Since:

jcms-5.7.0

See Also:

RightPolicyFilter.canBeReadBy(boolean, Publication, Member, boolean)

canBeReadBy

public boolean canBeReadBy(boolean isAuthorized,
                           Publication pub,
                           Group grp,
                           RightInfo rightInfo)

Since:

jcms-5.7.0

See Also:

RightPolicyFilter.canBeReadBy(boolean, Publication, Group)

canWorkOn

public boolean canWorkOn(boolean isAuthorized,
                         Publication pub,
                         Member member,
                         RightInfo rightInfo)

Since:

jcms-5.7.0

See Also:

RightPolicyFilter.canWorkOn(boolean, Publication, Member)

canWorkOn

public ControllerStatus canWorkOn(ControllerStatus status,
                                  int op,
                                  Member mbr,
                                  Member member)

Since:

jcms-6.1.0

See Also:

RightPolicyFilter.canWorkOn(ControllerStatus, int, Member, Member)

isWorker

public boolean isWorker(boolean isWorker,
                        Member member,
                        Workspace ws)

Since:

jcms-5.7.1

See Also:

RightPolicyFilter.isWorker(boolean, Member, Workspace)

canPublish

public boolean canPublish(boolean isAuthorized,
                          Member mbr,
                          java.lang.Class<? extends Publication> clazz,
                          java.util.Set<? extends Workspace> wsSet)

Since:

jcms-5.7.1

See Also:

RightPolicyFilter.canPublish(boolean, Member, Class, Set)

canUpdateOther

public boolean canUpdateOther(boolean isAuthorized,
                              Member mbr,
                              java.lang.Class<? extends Publication> clazz,
                              Workspace ws)

Since:

jcms-5.7.1

See Also:

RightPolicyFilter.canUpdateOther(boolean, Member, Class, Workspace)

canDeleteOther

public boolean canDeleteOther(boolean isAuthorized,
                              Member mbr,
                              java.lang.Class<? extends Publication> clazz,
                              Workspace ws)

Since:

jcms-5.7.1

See Also:

RightPolicyFilter.canDeleteOther(boolean, Member, Class, Workspace)

canBeReadBy

public boolean canBeReadBy(boolean isAuthorized,
                           Category cat,
                           Member mbr,
                           boolean searchInGroups,
                           boolean checkAncestors)

Since:

jcms-5.7.0

See Also:

RightPolicyFilter.canBeReadBy(boolean, Category, Member, boolean, boolean)

canBeReadBy

public boolean canBeReadBy(boolean isAuthorized,
                           Category cat,
                           Group grp,
                           boolean checkAncestors)

Since:

jcms-5.7.0

See Also:

RightPolicyFilter.canBeReadBy(boolean, Category, Group, boolean)

canUseCategory

public boolean canUseCategory(boolean isAuthorized,
                              Member mbr,
                              Category cat,
                              boolean searchInGroups,
                              boolean searchInParent)

Since:

jcms-5.7.1

See Also:

RightPolicyFilter.canUseCategory(boolean, Member, Category, boolean, boolean)

canManageCategory

public boolean canManageCategory(boolean isAuthorized,
                                 Member mbr,
                                 Category cat,
                                 boolean searchInGroups,
                                 boolean searchInParent)

Since:

jcms-5.7.1

See Also:

RightPolicyFilter.canManageCategory(boolean, Member, Category, boolean, boolean)

canCreateWorkspace

public boolean canCreateWorkspace(boolean isAuthorized,
                                  Member mbr,
                                  Workspace model)

Since:

jcms-5.7.3

See Also:

RightPolicyFilter.canCreateWorkspace(boolean, Member, Workspace)

getWorkspaceSet

public java.util.Set<Workspace> getWorkspaceSet(java.util.Set<Workspace> workspaceSet,
                                                Member mbr)

Since:

jcms-7.0.2

See Also:

RightPolicyFilter.getWorkspaceSet(Set, Member)

isAdmin

public boolean isAdmin(boolean isAdmin,
                       Member member,
                       Workspace workspace)

Since:

jcms-7.1 jcms-7.0.4

See Also:

RightPolicyFilter.isAdmin(boolean, Member, Workspace)

canCreateContact

public boolean canCreateContact(boolean isAuthorized,
                                Member mbr)

Since:

jcms-8.0.0

See Also:

RightPolicyFilter.canCreateContact(boolean, Member)

canBeReadBy

public boolean canBeReadBy(boolean isAuthorized,
                           Group grp,
                           Member mbr)

Since:

jcms-5.7.0

See Also:

RightPolicyFilter.canBeReadBy(boolean, Group, Member)

isMemberReadRightEnabled

public boolean isMemberReadRightEnabled()

Check if member read right is enabled.

Read rights on member were introduce in JCMS 10.0.1 as an experimental feature, disabled by default :

• when disabled, the legacy behavior is applied; all member are allowed to see each other.
• when enabled, Data.canBeReadBy(Member) performs a first level of control to always authorize admin and user themself, then the right policy is invoked with canBeReadBy(boolean, Member, Member, RightInfo).

It can be configured with the following property (requires a restart) :
member.read-right.enabled: true|false

Returns:

true if read rights on member are enabled, false otherwise

Since:

jcms-10.0.1 / JCMS-4784

See Also:

canBeReadBy(boolean, Member, Member, RightInfo)

setMemberReadRightEnabled

public void setMemberReadRightEnabled(java.lang.Boolean isMemberReadRightEnabled)

Set whether member read right is enabled or not.

Parameters:

isMemberReadRightEnabled - true to enable, false otherwise

See Also:

isMemberReadRightEnabled()

canBeReadBy

public boolean canBeReadBy(boolean isAuthorized,
                           Member mbrToRead,
                           Member mbrReading,
                           RightInfo rightInfo)

Checks if a member can read the specified Member.

Invoked by internal implementation of Data.canBeReadBy(Member).

Parameters:

isAuthorized - true if internal JCMS control authorized the member to perform this action

mbrToRead - the Member that would be read

mbrReading - the Member performing the read operation

rightInfo - an optionnal RightInfo in which the RightPolicyFilter changing the default behavior will be indicated

Returns:

true if the member can read the Member, false otherwise

Since:

jcms-10.0.1 / JCMS-4784

See Also:

RightPolicyFilter.canBeReadBy(boolean, Member, Member)

checkBeforeUpload

public boolean checkBeforeUpload(java.lang.String fieldName,
                                 java.lang.String contentType,
                                 java.lang.String fileName)

Since:

jcms-5.7.0

See Also:

RightPolicyFilter.checkBeforeUpload(String, String, String)

checkAfterUpload

public boolean checkAfterUpload(DocUploadInfo info)

Since:

jcms-5.7.0

See Also:

RightPolicyFilter.checkAfterUpload(DocUploadInfo)

checkHtml

public ControllerStatus checkHtml(java.lang.String str,
                                  java.lang.String field)

See Also:

RightPolicyFilter.checkHtml(String, String)

checkAccess

public java.lang.Boolean checkAccess(Member member,
                                     java.lang.String resource,
                                     java.util.Map<java.lang.String,java.lang.Object> context)

Since:

jcms-7.0.0

See Also:

RightPolicyFilter.checkAccess(Member, String, Map)