Package com.jalios.jcms
Class RightPolicyManager
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionbooleancallCanBeReadBy(PublicationCriteria pubCriteria) booleancanBeReadBy(boolean isAuthorized, Category cat, Member mbr, boolean searchInGroups, boolean checkAncestors) booleancanBeReadBy(boolean isAuthorized, Group grp, Member mbr) booleancanBeReadBy(boolean isAuthorized, Member mbrToRead, Member mbrReading, RightInfo rightInfo) Checks if a member can read the specified Member.booleancanBeReadBy(boolean isAuthorized, Publication pub, Member mbr, boolean searchInGroups, RightInfo rightInfo) booleancanBeReadBy(boolean isAuthorized, Workspace ws, Member mbr) booleancanCreateContact(boolean isAuthorized, Member mbr) booleancanCreateWorkspace(boolean isAuthorized, Member mbr, Workspace model) booleancanDeleteOther(boolean isAuthorized, Member mbr, Data data, RightInfo rightInfo) booleancanDeleteOther(boolean isAuthorized, Member mbr, Class<? extends Publication> clazz, Workspace ws) Deprecated.booleancanDeleteOther(boolean isAuthorized, Member mbr, Class<? extends Publication> clazz, Workspace ws, Map<String, ?> contextMap) booleancanManageCategory(boolean isAuthorized, Member mbr, Category cat, boolean searchInGroups, boolean searchInParent) booleancanPublish(boolean isAuthorized, Member mbr, Class<? extends Publication> clazz, Set<? extends Workspace> wsSet) Deprecated.booleancanPublish(boolean isAuthorized, Member mbr, Class<? extends Publication> clazz, Set<? extends Workspace> wsSet, Map<String, ?> contextMap) booleancanUpdateOther(boolean isAuthorized, Member mbr, Data data, RightInfo rightInfo) booleancanUpdateOther(boolean isAuthorized, Member mbr, Class<? extends Publication> clazz, Workspace ws) Deprecated.booleancanUpdateOther(boolean isAuthorized, Member mbr, Class<? extends Publication> clazz, Workspace ws, Map<String, ?> contextMap) booleancanUseCategory(boolean isAuthorized, Member mbr, Category cat, boolean searchInGroups, boolean searchInParent) booleancanWorkOn(boolean isAuthorized, Publication pub, Member member, RightInfo rightInfo) canWorkOn(ControllerStatus status, int op, Member mbr, Member member) booleanbooleancheckBeforeUpload(String fieldName, String contentType, String fileName) Retrieve the current context map instance if any.Retrieve the current RightInfo instance if any.static final RightPolicyManagerprotected StringgetWorkspaceSet(Set<Workspace> workspaceSet, Member mbr) booleanbooleanCheck if member read right is enabled.booleanvoidsetMemberReadRightEnabled(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, replacePolicyFilter
-
Field Details
-
MEMBER_READ_RIGHT_ENABLED_PROPERTY
- See Also:
-
-
Method Details
-
getInstance
-
getStatusXmlTagName
- Specified by:
getStatusXmlTagNamein classAbstractPolicyManager<RightPolicyFilter>
-
canUpdateOther
- Since:
- jcms-5.7.1
- See Also:
-
canDeleteOther
- Since:
- jcms-5.7.1
- See Also:
-
getCurrentRightInfo
Retrieve the current RightInfo instance if any.This method can be used by implementors of one of the following method to retrieve the current RightInfo instance previously computed by JPlatform core or another policy, and thus get/set access to more information on the authorization rational.
Warning: when an authorization was refused for some reason, it could also be refused for another one after.- Returns:
- the current RightInfo instance if any, may return null
- Since:
- jcms-10.0.6 / JCMS-8772
-
getCurrentContextMap
Retrieve the current context map instance if any.This method can be used by implementors of one of the following method to retrieve additional context information provided by caller of the corresponding methods in
Memberclass (*).RightPolicyFilter.canPublish(boolean, Member, Class, Set)RightPolicyFilter.canUpdateOther(boolean, Member, Class, Workspace)RightPolicyFilter.canDeleteOther(boolean, Member, Class, Workspace)
Member.canPublish(Class, Set, Map)Member.canPublish(Class, Workspace, Map)Member.canPublishSome(Class, Workspace, Map)Member.canUpdateOther(Class, Workspace, Map)Member.canDeleteOther(Class, Workspace, Map)
RightPolicyFilter.CTXT_CATEGORIES:Map<String,?> contextMap = Util.getHashMap(RightPolicyFilter.CTXT_CATEGORIES, Util.getHashSet(getCurrentCategory())); if (loggedMember.canPublish(someClass, someWorkspace, contextMap)) { //... }a RightPolicyFilter may access them to check rights :Map<String,?> contextMap = RightPolicyManager.getInstance().getCurrentContextMap(); Set<Category> categorySet = (contextMap != null) ? (Set<Category>) contextMap.get(RightPolicyFilter.CTXT_CATEGORIES) : null;
- Returns:
- the current context map if any, may return null
- Since:
- jcms-10.0.6 / JCMS-8882
-
callCanBeReadBy
- Since:
- jcms-7.0.0
- See Also:
-
canBeReadBy
public boolean canBeReadBy(boolean isAuthorized, Publication pub, Member mbr, boolean searchInGroups, RightInfo rightInfo) - Since:
- jcms-5.7.0
- See Also:
-
canWorkOn
- Since:
- jcms-5.7.0
- See Also:
-
canWorkOn
- Since:
- jcms-6.1.0
- See Also:
-
isWorker
- Since:
- jcms-5.7.1
- See Also:
-
canPublish
public boolean canPublish(boolean isAuthorized, Member mbr, Class<? extends Publication> clazz, Set<? extends Workspace> wsSet, Map<String, ?> contextMap) - Since:
- jcms-10.0.6 / JCMS-8882
- See Also:
-
canPublish
@Deprecated public boolean canPublish(boolean isAuthorized, Member mbr, Class<? extends Publication> clazz, Set<? extends Workspace> wsSet) Deprecated.- Since:
- jcms-5.7.1
- See Also:
-
canUpdateOther
public boolean canUpdateOther(boolean isAuthorized, Member mbr, Class<? extends Publication> clazz, Workspace ws, Map<String, ?> contextMap) - Since:
- jcms-10.0.6 / JCMS-8882
- See Also:
-
canUpdateOther
@Deprecated public boolean canUpdateOther(boolean isAuthorized, Member mbr, Class<? extends Publication> clazz, Workspace ws) Deprecated.- Since:
- jcms-5.7.1
- See Also:
-
canDeleteOther
public boolean canDeleteOther(boolean isAuthorized, Member mbr, Class<? extends Publication> clazz, Workspace ws, Map<String, ?> contextMap) - Since:
- jcms-6.0.0 / JCMS-8882
- See Also:
-
canDeleteOther
@Deprecated public boolean canDeleteOther(boolean isAuthorized, Member mbr, Class<? extends Publication> clazz, Workspace ws) Deprecated.- Since:
- jcms-5.7.1
- See Also:
-
canBeReadBy
public boolean canBeReadBy(boolean isAuthorized, Category cat, Member mbr, boolean searchInGroups, boolean checkAncestors) - Since:
- jcms-5.7.0
- See Also:
-
canUseCategory
public boolean canUseCategory(boolean isAuthorized, Member mbr, Category cat, boolean searchInGroups, boolean searchInParent) - Since:
- jcms-5.7.1
- See Also:
-
canManageCategory
public boolean canManageCategory(boolean isAuthorized, Member mbr, Category cat, boolean searchInGroups, boolean searchInParent) - Since:
- jcms-5.7.1
- See Also:
-
canCreateWorkspace
- Since:
- jcms-5.7.3
- See Also:
-
getWorkspaceSet
- Since:
- jcms-7.0.2
- See Also:
-
isAdmin
- Since:
- jcms-7.1 jcms-7.0.4
- See Also:
-
canCreateContact
- Since:
- jcms-8.0.0
- See Also:
-
canBeReadBy
- Since:
- jcms-5.7.0
- See Also:
-
canBeReadBy
- Since:
- jcms-10.0.4 / JCMS-8011
- See Also:
-
isMemberReadRightEnabled
public boolean isMemberReadRightEnabled()Check if member read right is enabled.- 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 withcanBeReadBy(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:
-
setMemberReadRightEnabled
Set whether member read right is enabled or not.- Parameters:
isMemberReadRightEnabled- true to enable, false otherwise- See Also:
-
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 actionmbrToRead- the Member that would be readmbrReading- the Member performing the read operationrightInfo- an optional 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:
-
checkBeforeUpload
- Since:
- jcms-5.7.0
- See Also:
-
checkAfterUpload
- Since:
- jcms-5.7.0
- See Also:
-
checkHtml
- See Also:
-
checkAccess
- Since:
- jcms-7.0.0
- See Also:
-