public class AuthorizableJSONWriter extends java.lang.Object implements PropConstants
PropConstants.TYPE
: with value "group" or "user" depending on
the type of authorizable.PropConstants.AUTHORIZABLE_ID
: the authorizable ID.PropConstants.DISPLAY_NAME
: the default display name.PropConstants.HOME
: The path to the home directory.PropConstants.IS_IMPERSONATED
: this property is only included
if the serialized authorizable is the same as the one associated with the
editing session. The flag is 'true' if the session has been obtained
through impersonation.PropConstants.PRINCIPAL
: The principal name.PropConstants.MEMBER_OF
: Includes the serialization of the
groups this authorizable is member of (as visible to the editing session).PropConstants.DECLARED_MEMBER_OF
: Includes the serialization
of those groups this authorizable is declared member of (as visible to the
editing session).PropConstants.IMAGE
: The image information.PropConstants.MODIFICATION
: Modification information.PropConstants.REPLICATION
: Replication data.PropConstants.WILDCARD
: Includes all of the above properties
plus the user and group specific properties listed below (except the
*Total properties).PropConstants.IMPERSONATORS
: The serialization of those
users that can impersonate the target user (as visible to the
editing session).PropConstants.DISABLED
: The disabled text in case this
user is disabled.PropConstants.MEMBERS
: The serialization of the members
of this group (as visible to the editing session).PropConstants.DECLARED_MEMBERS
: The serialization of the
declared members of this group (as visible to the editing session).setLimit(String, long)
where the
'key' is the name of the output property.
AuthorizableJSONWriter
.- outputprop-keys should be relative paths - removed old backwards compatibility lookup from user-prop to profile - jcr:created and jcr:createdBy must be listed explicitly - rep:userId omitted as this properties no longer exists and is identical to "authorizableId" - the "id" key has been renamed to "authorizableId" - the "groupName" key has been omitted as it seems wrong to have "name" and "id" and in addition a "groupName" which essential was the "id". - basic option removed as this is covered by outputprops being empty. - the cq specific 'table' view has been removed
AUTHORIZABLE_ID, AUTHORIZABLES, CNT, DECLARED_MEMBER_OF, DECLARED_MEMBERS, DISABLED, DISPLAY_NAME, HOME, IMAGE, IMPERSONATORS, IS_IMPERSONATED, MEMBER_OF, MEMBERS, MODIFICATION, OFFSET, PRINCIPAL, REPLICATION, TYPE, TYPE_GROUP, TYPE_USER, WILDCARD
Constructor and Description |
---|
AuthorizableJSONWriter(UserPropertiesManager userPropertiesMgr,
ResourceResolver resourceResolver,
Session session,
java.util.Set<java.lang.String> outputProps,
XSSFilter xss) |
Modifier and Type | Method and Description |
---|---|
void |
setFilterPredicates(java.lang.String[] filters)
Creates a predicate list based of the given filters array containing only the non blank filters and merges all of them in a single resulting authorizable predicate.
|
void |
setLimit(java.lang.String key,
long limit)
Sets the limit for the number of authorizables included in the object
with the specified key.
|
void |
write(JSONWriter writer,
Authorizable authorizable)
Write the data of the specified
authorizable to the given
writer . |
public AuthorizableJSONWriter(UserPropertiesManager userPropertiesMgr, ResourceResolver resourceResolver, Session session, java.util.Set<java.lang.String> outputProps, XSSFilter xss)
userPropertiesMgr
- the manager to access the profile.resourceResolver
- the resource resolversession
- the sessionoutputProps
- the output propertiesxss
- the XSS protection servicepublic void setLimit(java.lang.String key, long limit)
key
- The key as present in the output props.limit
- The maximal number of entries to be created for the
given key.public void setFilterPredicates(java.lang.String[] filters)
resultingAuthorizablePredicate
will validate an authorizable if any of the predicates from the list are valid.filters
- an array of given filters to use for creating a predicate list and a resulting predicate from that listpublic void write(JSONWriter writer, Authorizable authorizable) throws JSONException
authorizable
to the given
writer
.writer
- The JSONWriter to be used.authorizable
- The target authorizable.JSONException
- If an exception occurs.Copyright © 2010 - 2020 Adobe. All Rights Reserved