atg.userprofiling
Class PropertyManager

java.lang.Object
  atg.nucleus.logging.ApplicationLoggingImpl
      atg.userprofiling.PropertyManager

All Implemented Interfaces:

ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging

Direct Known Subclasses:

ScenarioPropertyManager

public class PropertyManager
extends ApplicationLoggingImpl

A service which keeps track of information about important properties for the Dynamo Personalization System. Includes system wide functionality that manages "well known" properties that the personalization engine expects.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
java.lang.String	mContactInfoPropertyName

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

PropertyManager()
Constructs an instanceof PropertyManager

Method Summary

java.lang.String	generatePassword(java.lang.String pClearTextPassword) Returns the "password string" which should be used to represent the user's password, as returned by the encryptPassword() function of the current PasswordHasher.
java.lang.String	generatePassword(java.lang.String pLogin, java.lang.String pClearTextPassword) Returns the "password string" which should be used to represent the user's password, as returned by the encryptPassword() function of the current PasswordHasher.
java.lang.String	generatePasswordHash(java.lang.String pClearTextPassword) Returns a hash representation of the password as returned by the encryptPassword() function of the current PasswordHasher.
java.lang.String	getAccessRightsPropertyName()
java.lang.String	getAncestorOrganizationsPropertyName()
java.lang.String	getAutoLoginPropertyName() Returns property AutoLoginPropertyName
java.lang.String	getContactInfoPropertyName() Get property ContactInfoPropertyName
java.lang.String	getEmailAddressPropertyName() Returns property EmailAddressPropertyName.
java.lang.String	getEmailStatusPropertyName() Returns property EmailStatusPropertyName.
java.lang.String	getFirstNamePropertyName() Returns property FirstNamePropertyName.
java.lang.String	getFullNamePropertyName() Gets the fullNamePropertyName property.
java.lang.String	getGeneratedPasswordPropertyName() Get the generated password property name.
java.lang.String	getLastEmailedPropertyName() Get the last email property name.
java.lang.String	getLastNamePropertyName() Returns property LastNamePropertyName.
java.lang.String	getLastPasswordUpdatePropertyName() Get the last password update property name.
java.lang.String	getLocalePropertyName()
java.lang.String	getLoggingIdentifier() Returns property LoggingIdentifier
java.lang.String	getLoginPropertyName() Returns property LoginPropertyName.
java.lang.String	getMiddleNamePropertyName() Returns property MiddleNamePropertyName.
java.lang.String	getOrganizationPropertyName()
PasswordHasher	getPasswordHasher() Returns the current password hasher that's used to encrypt passwords.
java.lang.String	getPasswordPropertyName() Returns property PasswordPropertyName.
java.lang.String	getPreviousPasswordsPropertyName() Get the previous passwords property name.
java.lang.String	getReceiveEmailPropertyName() Returns property ReceiveEmailPropertyName.
java.lang.String	getRegistrationDatePropertyName()
java.lang.String	getRolesPropertyName()
java.lang.String	getSecondaryOrganizationsPropertyName()
java.lang.String	getSecureProtocolName()
int	getSecurityStatusAnonymous()
int	getSecurityStatusBasicAuth()
int	getSecurityStatusCertificate()
int	getSecurityStatusCookie()
int	getSecurityStatusLogin()
java.lang.String	getSecurityStatusPropertyName()
int	getSecurityStatusSecureLogin()
int	getSecurityStatusUrl()
boolean	hasProperty(java.lang.String pPropertyName, RepositoryItem pItem) Returns true if the supplied profile supports the named property.
boolean	hasProperty(java.lang.String pPropertyName, RepositoryItemDescriptor pItemDescriptor) Returns true if the supplied repository item descriptor supports the named property.
void	setAccessRightsPropertyName(java.lang.String pAccessRightsPropertyName)
void	setAncestorOrganizationsPropertyName(java.lang.String pAncestorOrganizationsPropertyName)
void	setAutoLoginPropertyName(java.lang.String pAutoLoginPropertyName) Sets property AutoLoginPropertyName
void	setContactInfoPropertyName(java.lang.String pContactInfoPropertyName) Set property ContactInfoPropertyName
void	setEmailAddressPropertyName(java.lang.String pEmailAddressPropertyName) Sets property EmailAddressPropertyName
void	setEmailStatusPropertyName(java.lang.String pEmailStatusPropertyName) Sets property EmailStatusPropertyName
void	setFirstNamePropertyName(java.lang.String pFirstNamePropertyName) Sets property FirstNamePropertyName
void	setFullNamePropertyName(java.lang.String pFullNamePropertyName) Sets the fullNamePropertyName property
void	setGeneratedPasswordPropertyName(java.lang.String pGeneratedPasswordPropertyName) Set the generated password property name.
void	setLastEmailedPropertyName(java.lang.String pLastEmailedPropertyName) Set the last email property name.
void	setLastNamePropertyName(java.lang.String pLastNamePropertyName) Sets property LastNamePropertyName
void	setLastPasswordUpdatePropertyName(java.lang.String pLastPasswordUpdatePropertyName) Set the last password update property name.
void	setLocalePropertyName(java.lang.String pLocalePropertyName)
void	setLoginPropertyName(java.lang.String pLoginPropertyName) Sets property LoginPropertyName
void	setMiddleNamePropertyName(java.lang.String pMiddleNamePropertyName) Sets property MiddleNamePropertyName
void	setOrganizationPropertyName(java.lang.String pOrganizationPropertyName)
void	setPasswordHasher(PasswordHasher pHasher) Changes the password hasher used for encrypting passwords.
void	setPasswordPropertyName(java.lang.String pPasswordPropertyName) Sets property PasswordPropertyName
void	setPreviousPasswordsPropertyName(java.lang.String pPreviousPasswordsPropertyName) Set the previous passwords property name.
void	setReceiveEmailPropertyName(java.lang.String pReceiveEmailPropertyName) Sets property ReceiveEmailPropertyName
void	setRegistrationDatePropertyName(java.lang.String pRegistrationDatePropertyName)
void	setRolesPropertyName(java.lang.String pRolesPropertyName)
void	setSecondaryOrganizationsPropertyName(java.lang.String pSecondaryOrganizationsPropertyName)
void	setSecureProtocolName(java.lang.String pSecureProtocolName)
void	setSecurityStatusAnonymous(int pSecurityStatusAnonymous)
void	setSecurityStatusBasicAuth(int pSecurityStatusBasicAuth)
void	setSecurityStatusCertificate(int pSecurityStatusCertificate)
void	setSecurityStatusCookie(int pSecurityStatusCookie)
void	setSecurityStatusLogin(int pSecurityStatusLogin)
void	setSecurityStatusPropertyName(java.lang.String pSecurityStatusPropertyName)
void	setSecurityStatusSecureLogin(int pSecurityStatusSecureLogin)
void	setSecurityStatusUrl(int pSecurityStatusUrl)

Methods inherited from class atg.nucleus.logging.ApplicationLoggingImpl

addGlobalLogListeners, addLogListener, getLoggingIdentifer, getLogListenerCount, getLogListeners, initializeFromServiceEvent, isAutoInitListeners, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, removeLogListener, sendLogEvent, setAutoInitListeners, setLoggingDebug, setLoggingError, setLoggingIdentifier, setLoggingInfo, setLoggingTrace, setLoggingWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mContactInfoPropertyName

public java.lang.String mContactInfoPropertyName

Constructor Detail

PropertyManager

public PropertyManager()

Constructs an instanceof PropertyManager

Method Detail

setLoginPropertyName

public void setLoginPropertyName(java.lang.String pLoginPropertyName)

Sets property LoginPropertyName

getLoginPropertyName

public java.lang.String getLoginPropertyName()

Returns property LoginPropertyName. Default Login.

setPasswordPropertyName

public void setPasswordPropertyName(java.lang.String pPasswordPropertyName)

Sets property PasswordPropertyName

getPasswordPropertyName

public java.lang.String getPasswordPropertyName()

Returns property PasswordPropertyName. Default Password.

setFirstNamePropertyName

public void setFirstNamePropertyName(java.lang.String pFirstNamePropertyName)

Sets property FirstNamePropertyName

getFirstNamePropertyName

public java.lang.String getFirstNamePropertyName()

Returns property FirstNamePropertyName. Default FirstName.

setMiddleNamePropertyName

public void setMiddleNamePropertyName(java.lang.String pMiddleNamePropertyName)

Sets property MiddleNamePropertyName

getMiddleNamePropertyName

public java.lang.String getMiddleNamePropertyName()

Returns property MiddleNamePropertyName. Default MiddleName.

setLastNamePropertyName

public void setLastNamePropertyName(java.lang.String pLastNamePropertyName)

Sets property LastNamePropertyName

getLastNamePropertyName

public java.lang.String getLastNamePropertyName()

Returns property LastNamePropertyName. Default LastName.

setFullNamePropertyName

public void setFullNamePropertyName(java.lang.String pFullNamePropertyName)

Sets the fullNamePropertyName property

Parameters:

pFullNamePropertyName -

getFullNamePropertyName

public java.lang.String getFullNamePropertyName()

Gets the fullNamePropertyName property. Default is fullName

Returns:

pFullNamePropertyName

setAutoLoginPropertyName

public void setAutoLoginPropertyName(java.lang.String pAutoLoginPropertyName)

Sets property AutoLoginPropertyName

getAutoLoginPropertyName

public java.lang.String getAutoLoginPropertyName()

Returns property AutoLoginPropertyName

getPasswordHasher

public PasswordHasher getPasswordHasher()

Returns the current password hasher that's used to encrypt passwords.

setPasswordHasher

public void setPasswordHasher(PasswordHasher pHasher)

Changes the password hasher used for encrypting passwords.

setReceiveEmailPropertyName

public void setReceiveEmailPropertyName(java.lang.String pReceiveEmailPropertyName)

Sets property ReceiveEmailPropertyName

getReceiveEmailPropertyName

public java.lang.String getReceiveEmailPropertyName()

Returns property ReceiveEmailPropertyName. Default ReceiveEmail.

setEmailStatusPropertyName

public void setEmailStatusPropertyName(java.lang.String pEmailStatusPropertyName)

Sets property EmailStatusPropertyName

getEmailStatusPropertyName

public java.lang.String getEmailStatusPropertyName()

Returns property EmailStatusPropertyName. Default Email.

setEmailAddressPropertyName

public void setEmailAddressPropertyName(java.lang.String pEmailAddressPropertyName)

Sets property EmailAddressPropertyName

getEmailAddressPropertyName

public java.lang.String getEmailAddressPropertyName()

Returns property EmailAddressPropertyName. Default Email.

setContactInfoPropertyName

public void setContactInfoPropertyName(java.lang.String pContactInfoPropertyName)

Set property ContactInfoPropertyName

Parameters:

pContactInfoPropertyName -

getContactInfoPropertyName

public java.lang.String getContactInfoPropertyName()

Get property ContactInfoPropertyName

Returns:

setSecurityStatusAnonymous

public void setSecurityStatusAnonymous(int pSecurityStatusAnonymous)

getSecurityStatusAnonymous

public int getSecurityStatusAnonymous()

setSecurityStatusUrl

public void setSecurityStatusUrl(int pSecurityStatusUrl)

getSecurityStatusUrl

public int getSecurityStatusUrl()

setSecurityStatusCookie

public void setSecurityStatusCookie(int pSecurityStatusCookie)

getSecurityStatusCookie

public int getSecurityStatusCookie()

setSecurityStatusBasicAuth

public void setSecurityStatusBasicAuth(int pSecurityStatusBasicAuth)

getSecurityStatusBasicAuth

public int getSecurityStatusBasicAuth()

setSecurityStatusLogin

public void setSecurityStatusLogin(int pSecurityStatusLogin)

getSecurityStatusLogin

public int getSecurityStatusLogin()

setSecurityStatusSecureLogin

public void setSecurityStatusSecureLogin(int pSecurityStatusSecureLogin)

getSecurityStatusSecureLogin

public int getSecurityStatusSecureLogin()

setSecurityStatusCertificate

public void setSecurityStatusCertificate(int pSecurityStatusCertificate)

getSecurityStatusCertificate

public int getSecurityStatusCertificate()

setSecurityStatusPropertyName

public void setSecurityStatusPropertyName(java.lang.String pSecurityStatusPropertyName)

getSecurityStatusPropertyName

public java.lang.String getSecurityStatusPropertyName()

setSecureProtocolName

public void setSecureProtocolName(java.lang.String pSecureProtocolName)

getSecureProtocolName

public java.lang.String getSecureProtocolName()

setLocalePropertyName

public void setLocalePropertyName(java.lang.String pLocalePropertyName)

getLocalePropertyName

public java.lang.String getLocalePropertyName()

setRolesPropertyName

public void setRolesPropertyName(java.lang.String pRolesPropertyName)

getRolesPropertyName

public java.lang.String getRolesPropertyName()

setOrganizationPropertyName

public void setOrganizationPropertyName(java.lang.String pOrganizationPropertyName)

getOrganizationPropertyName

public java.lang.String getOrganizationPropertyName()

setAncestorOrganizationsPropertyName

public void setAncestorOrganizationsPropertyName(java.lang.String pAncestorOrganizationsPropertyName)

getAncestorOrganizationsPropertyName

public java.lang.String getAncestorOrganizationsPropertyName()

setSecondaryOrganizationsPropertyName

public void setSecondaryOrganizationsPropertyName(java.lang.String pSecondaryOrganizationsPropertyName)

getSecondaryOrganizationsPropertyName

public java.lang.String getSecondaryOrganizationsPropertyName()

setAccessRightsPropertyName

public void setAccessRightsPropertyName(java.lang.String pAccessRightsPropertyName)

getAccessRightsPropertyName

public java.lang.String getAccessRightsPropertyName()

setRegistrationDatePropertyName

public void setRegistrationDatePropertyName(java.lang.String pRegistrationDatePropertyName)

getRegistrationDatePropertyName

public java.lang.String getRegistrationDatePropertyName()

setLastEmailedPropertyName

public void setLastEmailedPropertyName(java.lang.String pLastEmailedPropertyName)

Set the last email property name.

getLastEmailedPropertyName

public java.lang.String getLastEmailedPropertyName()

Get the last email property name.

setPreviousPasswordsPropertyName

public void setPreviousPasswordsPropertyName(java.lang.String pPreviousPasswordsPropertyName)

Set the previous passwords property name.

getPreviousPasswordsPropertyName

public java.lang.String getPreviousPasswordsPropertyName()

Get the previous passwords property name.

setGeneratedPasswordPropertyName

public void setGeneratedPasswordPropertyName(java.lang.String pGeneratedPasswordPropertyName)

Set the generated password property name.

getGeneratedPasswordPropertyName

public java.lang.String getGeneratedPasswordPropertyName()

Get the generated password property name.

setLastPasswordUpdatePropertyName

public void setLastPasswordUpdatePropertyName(java.lang.String pLastPasswordUpdatePropertyName)

Set the last password update property name.

getLastPasswordUpdatePropertyName

public java.lang.String getLastPasswordUpdatePropertyName()

Get the last password update property name.

hasProperty

public boolean hasProperty(java.lang.String pPropertyName,
                           RepositoryItem pItem)

Returns true if the supplied profile supports the named property. Handles hierarchical properties (e.g., "address.city").

Parameters:

pPropertyName - the name of the property to look for

pItem - the user's profile

hasProperty

public boolean hasProperty(java.lang.String pPropertyName,
                           RepositoryItemDescriptor pItemDescriptor)

Returns true if the supplied repository item descriptor supports the named property. Handles hierarchical properties (e.g., "address.city").

Parameters:

pPropertyName - the name of the property to look for

pItemDescriptor - the item descriptor

generatePassword

public java.lang.String generatePassword(java.lang.String pLogin,
                                         java.lang.String pClearTextPassword)

Returns the "password string" which should be used to represent the user's password, as returned by the encryptPassword() function of the current PasswordHasher.

If PasswordHasher is an instance of PasswordHasher2, then the login is passed on to the encryptPassword call along with the password.

Parameters:

pLogin - the user's login name

pClearTextPassword - the clear-text password to hash

See Also:

PasswordHasher.encryptPassword(java.lang.String)

generatePassword

public java.lang.String generatePassword(java.lang.String pClearTextPassword)

Returns the "password string" which should be used to represent the user's password, as returned by the encryptPassword() function of the current PasswordHasher.

Parameters:

pClearTextPassword - the clear-text password to hash

See Also:

PasswordHasher.encryptPassword(java.lang.String)

generatePasswordHash

public java.lang.String generatePasswordHash(java.lang.String pClearTextPassword)

Returns a hash representation of the password as returned by the encryptPassword() function of the current PasswordHasher.

Parameters:

pClearTextPassword - the clear-text password to hash

See Also:

PasswordHasher.encryptPassword(java.lang.String)

getLoggingIdentifier

public java.lang.String getLoggingIdentifier()

Description copied from class: ApplicationLoggingImpl

Returns property LoggingIdentifier

Overrides:

getLoggingIdentifier in class ApplicationLoggingImpl