Package com.day.cq.security.profile
Interface Profile
- All Superinterfaces:
LabeledResource,Map<String,,Object> PersistableValueMap,ValueMap
Deprecated.
cq 5.5
The Profile is an Extension of the
User Properties.
While the Authorizable is a Unique entity it may have multiple Profiles.
A Profile may be specific for an Application of the CQ-Platform.
It is therefore modelled via this Object and not maintained directly on the
Authorizable.
The relation to an Authorizable and
the persistance handling is done by the
ProfileManager- See Also:
-
Nested Class Summary
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.getAccounts.Deprecated.getAddresses.Deprecated.getAuthorizable.getAvatarURL(String suffix, String defaultValue) Deprecated.Returns the avatar URL of the profile.Deprecated.getCurrentLocation.Deprecated.getFamilyName.Deprecated.getFormattedName.Deprecated.getGivenName.Deprecated.getHonoricPrefix.Deprecated.getHonoricSuffix.getMails()Deprecated.A Profile may contain mulitple E-Mail addresses.Deprecated.getMiddleName.Deprecated.getOrganizations.getPath()Deprecated.getPath.Deprecated.A Profile may contain mulitple Phone numbers addresses.Deprecated.getPhotos.Deprecated.getPrimaryMail.Deprecated.getPrimaryPhone.getURLs()Deprecated.getURLs.Methods inherited from interface com.day.cq.commons.LabeledResource
getDescription, getName, getTitleMethods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, valuesMethods inherited from interface org.apache.sling.api.resource.PersistableValueMap
reset, save
-
Method Details
-
getAuthorizable
Authorizable getAuthorizable()Deprecated.getAuthorizable.
- Returns:
- this Profile belongs to
-
getPath
String getPath()Deprecated.getPath.
- Specified by:
getPathin interfaceLabeledResource- Returns:
- Path of the Resource containing the profile data
-
getFamilyName
String getFamilyName()Deprecated.getFamilyName.
- Returns:
- Family or Last Name or
nullif none
-
getGivenName
String getGivenName()Deprecated.getGivenName.
- Returns:
- Given or First Name
nullif none
-
getMiddleName
String getMiddleName()Deprecated.getMiddleName.
- Returns:
- Given or First Name
nullif none
-
getHonoricPrefix
String getHonoricPrefix()Deprecated.getHonoricPrefix.
- Returns:
- Honric Prefix like Ph.D
nullif none
-
getHonoricSuffix
String getHonoricSuffix()Deprecated.getHonoricSuffix.
- Returns:
- Honric Suffix or
nullif none
-
getFormattedName
String getFormattedName()Deprecated.getFormattedName.
- Returns:
- formatted name of the profile
-
getPrimaryMail
String getPrimaryMail()Deprecated.getPrimaryMail.
- Returns:
- e-mail address marked to be primary or
nullif none
-
getMails
Deprecated.A Profile may contain mulitple E-Mail addresses. These multiple addresses are stored in dedicated resources, containing the e-mail address and descriptive data. It is not mandated, that theprimary E-Mailis contained in one of theResourcescontained in this result- Returns:
- all Resources containing detailed properties about mail addresses.
- See Also:
-
getPrimaryPhone
String getPrimaryPhone()Deprecated.getPrimaryPhone.
- Returns:
- address marked to be primary or
nullif none
-
getPhoneNumbers
Deprecated.A Profile may contain mulitple Phone numbers addresses. These multiple phone numbers are stored in dedicated resources, containing the number and descriptive data. It is not mandated, that theprimary phone numberis contained in one of theResourcescontained in this result- Returns:
- all Resources containing detailed properties about phone numbers.
- See Also:
-
getCurrentLocation
Resource getCurrentLocation()Deprecated.getCurrentLocation.
- Returns:
- a
Resourceobject.
-
getAddresses
Deprecated.getAddresses.
- Returns:
- a
Iteratorobject.
-
getURLs
Deprecated.getURLs.
- Returns:
- a
Iteratorobject.
-
getPhotos
Deprecated.getPhotos.
- Returns:
- a
Iteratorobject.
-
getOrganizations
Deprecated.getOrganizations.
- Returns:
- a
Iteratorobject.
-
getAccounts
Deprecated.getAccounts.
- Returns:
- a
Iteratorobject.
-
getAvatarURL
Deprecated.Returns the avatar URL of the profile.- Parameters:
suffix- Suffix to append to the avatar URLdefaultValue- Default value if Profile has no avatar- Returns:
- avatar URL or the default value
-