Package com.day.cq.security.profile

Interface Profile

All Superinterfaces:

LabeledResource, java.util.Map<java.lang.String,java.lang.Object>, PersistableValueMap, ValueMap

public interface Profile
extends LabeledResource, PersistableValueMap

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:

Authorizable, ProfileManager

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Field Summary

Fields inherited from interface org.apache.sling.api.resource.ValueMap

EMPTY

Method Summary

Modifier and Type	Method	Description
java.util.Iterator<Resource>	getAccounts()	Deprecated. getAccounts.
java.util.Iterator<Resource>	getAddresses()	Deprecated. getAddresses.
Authorizable	getAuthorizable()	Deprecated. getAuthorizable.
java.lang.String	getAvatarURL(java.lang.String suffix, java.lang.String defaultValue)	Deprecated. Returns the avatar URL of the profile.
Resource	getCurrentLocation()	Deprecated. getCurrentLocation.
java.lang.String	getFamilyName()	Deprecated. getFamilyName.
java.lang.String	getFormattedName()	Deprecated. getFormattedName.
java.lang.String	getGivenName()	Deprecated. getGivenName.
java.lang.String	getHonoricPrefix()	Deprecated. getHonoricPrefix.
java.lang.String	getHonoricSuffix()	Deprecated. getHonoricSuffix.
java.util.Iterator<Resource>	getMails()	Deprecated. A Profile may contain mulitple E-Mail addresses.
java.lang.String	getMiddleName()	Deprecated. getMiddleName.
java.util.Iterator<Resource>	getOrganizations()	Deprecated. getOrganizations.
java.lang.String	getPath()	Deprecated. getPath.
java.util.Iterator<Resource>	getPhoneNumbers()	Deprecated. A Profile may contain mulitple Phone numbers addresses.
java.util.Iterator<Resource>	getPhotos()	Deprecated. getPhotos.
java.lang.String	getPrimaryMail()	Deprecated. getPrimaryMail.
java.lang.String	getPrimaryPhone()	Deprecated. getPrimaryPhone.
java.util.Iterator<Resource>	getURLs()	Deprecated. getURLs.

Methods inherited from interface com.day.cq.commons.LabeledResource

getDescription, getName, getTitle

Methods 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, values

Methods inherited from interface org.apache.sling.api.resource.PersistableValueMap

reset, save

Methods inherited from interface org.apache.sling.api.resource.ValueMap

get, get

Method Detail

getAuthorizable

Authorizable getAuthorizable()

Deprecated.

getAuthorizable.

Returns:

this Profile belongs to

getPath

java.lang.String getPath()

Deprecated.

getPath.

Specified by:

getPath in interface LabeledResource

Returns:

Path of the Resource containing the profile data

getFamilyName

java.lang.String getFamilyName()

Deprecated.

getFamilyName.

Returns:

Family or Last Name or null if none

getGivenName

java.lang.String getGivenName()

Deprecated.

getGivenName.

Returns:

Given or First Name null if none

getMiddleName

java.lang.String getMiddleName()

Deprecated.

getMiddleName.

Returns:

Given or First Name null if none

getHonoricPrefix

java.lang.String getHonoricPrefix()

Deprecated.

getHonoricPrefix.

Returns:

Honric Prefix like Ph.D null if none

getHonoricSuffix

java.lang.String getHonoricSuffix()

Deprecated.

getHonoricSuffix.

Returns:

Honric Suffix or null if none

getFormattedName

java.lang.String getFormattedName()

Deprecated.

getFormattedName.

Returns:

formatted name of the profile

getPrimaryMail

java.lang.String getPrimaryMail()

Deprecated.

getPrimaryMail.

Returns:

e-mail address marked to be primary or null if none

getMails

java.util.Iterator<Resource> 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 the primary E-Mail is contained in one of the Resources contained in this result

Returns:

all Resources containing detailed properties about mail addresses.

See Also:

getPrimaryMail()

getPrimaryPhone

java.lang.String getPrimaryPhone()

Deprecated.

getPrimaryPhone.

Returns:

address marked to be primary or null if none

getPhoneNumbers

java.util.Iterator<Resource> 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 the primary phone number is contained in one of the Resources contained in this result

Returns:

all Resources containing detailed properties about phone numbers.

See Also:

getPrimaryPhone()

getCurrentLocation

Resource getCurrentLocation()

Deprecated.

getCurrentLocation.

Returns:

a Resource object.

getAddresses

java.util.Iterator<Resource> getAddresses()

Deprecated.

getAddresses.

Returns:

a Iterator object.

getURLs

java.util.Iterator<Resource> getURLs()

Deprecated.

getURLs.

Returns:

a Iterator object.

getPhotos

java.util.Iterator<Resource> getPhotos()

Deprecated.

getPhotos.

Returns:

a Iterator object.

getOrganizations

java.util.Iterator<Resource> getOrganizations()

Deprecated.

getOrganizations.

Returns:

a Iterator object.

getAccounts

java.util.Iterator<Resource> getAccounts()

Deprecated.

getAccounts.

Returns:

a Iterator object.

getAvatarURL

java.lang.String getAvatarURL(java.lang.String suffix,
                              java.lang.String defaultValue)

Deprecated.

Returns the avatar URL of the profile.

Parameters:

suffix - Suffix to append to the avatar URL

defaultValue - Default value if Profile has no avatar

Returns:

avatar URL or the default value