atg.userprofiling

Class Profile

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.userprofiling.Profile

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, DisplayableItem, MutableRepositoryItem, RepositoryItem, ProfileRepositoryItem, java.util.EventListener

public class Profile
extends GenericService
implements MutableRepositoryItem, ProfileRepositoryItem, ApplicationLogging, AdminableService

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Constructor Summary

Constructors

Constructor and Description
Profile() Constructs an instanceof Profile

Method Summary

Methods

Modifier and Type	Method and Description
void	addLogListener(LogListener pListener) Adds a listener to the list of log listeners
protected javax.servlet.Servlet	createAdminServlet() Creates and returns a new Servlet that will administer this service.
javax.servlet.Servlet	getAdminServlet() Returns the Servlet that will handle admin requests directed at this service.
java.util.Collection<java.lang.String>	getContextMemberships() Repository items can be associated with arbitrary contexts.
RepositoryItem	getDataSource() Returns property DataSource
RepositoryItemDescriptor	getItemDescriptor() Returns the RepositoryItemDescriptor property, which describes the known properties for the item
java.lang.String	getItemDisplayName() The name of this item which can be used in a UI.
int	getLogListenerCount() Returns the number of log listeners
ProfileTools	getProfileTools() Returns property ProfileTools
java.lang.Object	getPropertyValue(java.lang.String pPropertyName) Returns the property of the given name
Repository	getRepository() Returns the Repository which contains this item
java.lang.String	getRepositoryId() Returns the unique profile id
boolean	isLoggingDebug() This method returns whether or not an debug log event should be broadcast.
boolean	isLoggingError() This method returns whether or not an error log event should be broadcast.
boolean	isLoggingInfo() This method returns whether or not an info log event should be broadcast.
boolean	isLoggingWarning() This method returns whether or not an warning log event should be broadcast.
boolean	isTransient() Returns true if the profile is backed by an "anonymous" non-persistent profile which cannot be reloaded on subsequent sessions.
void	logDebug(java.lang.String pMessage) Logs an debug event with the specified message
void	logDebug(java.lang.String pMessage, java.lang.Throwable pThrowable) Logs an debug event with the specified message and Throwable
void	logDebug(java.lang.Throwable pThrowable) Logs an debug event with the specified Throwable
void	logError(java.lang.String pMessage) Logs an error event with the specified message
void	logError(java.lang.String pMessage, java.lang.Throwable pThrowable) Logs an error event with the specified message and Throwable
void	logError(java.lang.Throwable pThrowable) Logs an error event with the specified Throwable
void	logInfo(java.lang.String pMessage) Logs an info event with the specified message
void	logInfo(java.lang.String pMessage, java.lang.Throwable pThrowable) Logs an info event with the specified message and Throwable
void	logInfo(java.lang.Throwable pThrowable) Logs an info event with the specified Throwable
void	logWarning(java.lang.String pMessage) Logs an warning event with the specified message
void	logWarning(java.lang.String pMessage, java.lang.Throwable pThrowable) Logs an warning event with the specified message and Throwable
void	logWarning(java.lang.Throwable pThrowable) Logs an warning event with the specified Throwable
void	removeLogListener(LogListener pListener) Removes a listener from the list of log listeners
void	sendLogEvent(LogEvent pLogEvent) Sends a LogEvent to all of the listeners
void	setDataSource(RepositoryItem pDataSource) Sets property DataSource
void	setDataSourceLocal(RepositoryItem pDataSource) Sets property DataSource
void	setLoggingDebug(boolean pLogging) Sets whether or not error log events should be logged.
void	setLoggingError(boolean pLogging) Sets whether or not error log events should be logged.
void	setLoggingInfo(boolean pLogging) Sets whether or not info log events should be logged.
void	setLoggingWarning(boolean pLogging) Sets whether or not warning log events should be logged.
void	setProfileTools(ProfileTools pProfileTools) Sets property ProfileTools
void	setPropertyValue(java.lang.String pPropertyName, java.lang.Object pPropertyValue) Sets the property of the given name, to the specified value
java.lang.String	toString() Returns the String representation of this profile

Methods inherited from class atg.nucleus.GenericService

doStartService, doStopService, getAbsoluteName, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingTrace, isRunning, logTrace, logTrace, logTrace, nameContextElementBound, nameContextElementUnbound, reResolveThis, resolveName, resolveName, resolveName, resolveName, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingTrace, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

Profile

public Profile()

Constructs an instanceof Profile

Method Detail

isTransient

public boolean isTransient()

Returns true if the profile is backed by an "anonymous" non-persistent profile which cannot be reloaded on subsequent sessions.

Specified by:

isTransient in interface RepositoryItem

getContextMemberships

public java.util.Collection<java.lang.String> getContextMemberships()
                                                             throws RepositoryException

Description copied from interface: RepositoryItem

Repository items can be associated with arbitrary contexts. These contexts are usually stored in a property on the item itself. This method returns all the contexts that this item is associated with.

Specified by:

getContextMemberships in interface RepositoryItem

Returns:

Collection of java.lang.String. Empty, if this item does not have any context memberships or does not support context memberships.

Throws:

RepositoryException

setDataSource

public void setDataSource(RepositoryItem pDataSource)

Sets property DataSource

setDataSourceLocal

public void setDataSourceLocal(RepositoryItem pDataSource)

Sets property DataSource

getDataSource

public RepositoryItem getDataSource()

Returns property DataSource

setProfileTools

public void setProfileTools(ProfileTools pProfileTools)

Sets property ProfileTools

getProfileTools

public ProfileTools getProfileTools()

Returns property ProfileTools

getRepositoryId

public java.lang.String getRepositoryId()

Returns the unique profile id

Specified by:

getRepositoryId in interface RepositoryItem

getItemDisplayName

public java.lang.String getItemDisplayName()

The name of this item which can be used in a UI.

Specified by:

getItemDisplayName in interface DisplayableItem

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String pPropertyName)

Returns the property of the given name

Specified by:

getPropertyValue in interface RepositoryItem

setPropertyValue

public void setPropertyValue(java.lang.String pPropertyName,
                    java.lang.Object pPropertyValue)

Sets the property of the given name, to the specified value

Specified by:

setPropertyValue in interface MutableRepositoryItem

getRepository

public Repository getRepository()

Returns the Repository which contains this item

Specified by:

getRepository in interface RepositoryItem

getItemDescriptor

public RepositoryItemDescriptor getItemDescriptor()
                                           throws RepositoryException

Returns the RepositoryItemDescriptor property, which describes the known properties for the item

Specified by:

getItemDescriptor in interface RepositoryItem

Throws:

RepositoryException

toString

public java.lang.String toString()

Returns the String representation of this profile

Overrides:

toString in class java.lang.Object

getAdminServlet

public javax.servlet.Servlet getAdminServlet()

Returns the Servlet that will handle admin requests directed at this service. This will first check to see if the servlet is already created, and if not it will create it by calling createAdminServlet.

Specified by:

getAdminServlet in interface AdminableService

Overrides:

getAdminServlet in class GenericService

See Also:

createAdminServlet()

createAdminServlet

protected javax.servlet.Servlet createAdminServlet()

Creates and returns a new Servlet that will administer this service.

Overrides:

createAdminServlet in class GenericService

addLogListener

public void addLogListener(LogListener pListener)

Adds a listener to the list of log listeners

Specified by:

addLogListener in interface atg.nucleus.logging.ApplicationLoggingSender

Overrides:

addLogListener in class GenericService

removeLogListener

public void removeLogListener(LogListener pListener)

Removes a listener from the list of log listeners

Specified by:

removeLogListener in interface atg.nucleus.logging.ApplicationLoggingSender

Overrides:

removeLogListener in class GenericService

getLogListenerCount

public int getLogListenerCount()

Returns the number of log listeners

Specified by:

getLogListenerCount in interface atg.nucleus.logging.ApplicationLoggingSender

Overrides:

getLogListenerCount in class GenericService

sendLogEvent

public void sendLogEvent(LogEvent pLogEvent)

Sends a LogEvent to all of the listeners

Overrides:

sendLogEvent in class GenericService

isLoggingInfo

public boolean isLoggingInfo()

This method returns whether or not an info log event should be broadcast.

Specified by:

isLoggingInfo in interface atg.core.logging.Logging

Specified by:

isLoggingInfo in interface ApplicationLogging

Overrides:

isLoggingInfo in class GenericService

Returns:

boolean true if info log events should be logged
false if info log events should not be logged

setLoggingInfo

public void setLoggingInfo(boolean pLogging)

Sets whether or not info log events should be logged.

Specified by:

setLoggingInfo in interface atg.core.logging.Logging

Specified by:

setLoggingInfo in interface ApplicationLogging

Overrides:

setLoggingInfo in class GenericService

isLoggingWarning

public boolean isLoggingWarning()

This method returns whether or not an warning log event should be broadcast.

Specified by:

isLoggingWarning in interface atg.core.logging.Logging

Specified by:

isLoggingWarning in interface ApplicationLogging

Overrides:

isLoggingWarning in class GenericService

Returns:

boolean true if warning log events should be logged
false if warning log events should not be logged

setLoggingWarning

public void setLoggingWarning(boolean pLogging)

Sets whether or not warning log events should be logged.

Specified by:

setLoggingWarning in interface atg.core.logging.Logging

Specified by:

setLoggingWarning in interface ApplicationLogging

Overrides:

setLoggingWarning in class GenericService

isLoggingError

public boolean isLoggingError()

This method returns whether or not an error log event should be broadcast.

Specified by:

isLoggingError in interface atg.core.logging.Logging

Specified by:

isLoggingError in interface ApplicationLogging

Overrides:

isLoggingError in class GenericService

Returns:

boolean true if error log events should be logged
false if error log events should not be logged

setLoggingError

public void setLoggingError(boolean pLogging)

Sets whether or not error log events should be logged.

Specified by:

setLoggingError in interface atg.core.logging.Logging

Specified by:

setLoggingError in interface ApplicationLogging

Overrides:

setLoggingError in class GenericService

isLoggingDebug

public boolean isLoggingDebug()

This method returns whether or not an debug log event should be broadcast.

Specified by:

isLoggingDebug in interface atg.core.logging.Logging

Specified by:

isLoggingDebug in interface ApplicationLogging

Overrides:

isLoggingDebug in class GenericService

Returns:

boolean true if debug log events should be logged
false if debug log events should not be logged

setLoggingDebug

public void setLoggingDebug(boolean pLogging)

Sets whether or not error log events should be logged.

Specified by:

setLoggingDebug in interface atg.core.logging.Logging

Specified by:

setLoggingDebug in interface ApplicationLogging

Overrides:

setLoggingDebug in class GenericService

logInfo

public void logInfo(java.lang.String pMessage)

Logs an info event with the specified message

Specified by:

logInfo in interface atg.core.logging.Logging

Specified by:

logInfo in interface ApplicationLogging

Overrides:

logInfo in class GenericService

logInfo

public void logInfo(java.lang.Throwable pThrowable)

Logs an info event with the specified Throwable

Specified by:

logInfo in interface atg.core.logging.Logging

Specified by:

logInfo in interface ApplicationLogging

Overrides:

logInfo in class GenericService

logInfo

public void logInfo(java.lang.String pMessage,
           java.lang.Throwable pThrowable)

Logs an info event with the specified message and Throwable

Specified by:

logInfo in interface atg.core.logging.Logging

Specified by:

logInfo in interface ApplicationLogging

Overrides:

logInfo in class GenericService

logWarning

public void logWarning(java.lang.String pMessage)

Logs an warning event with the specified message

Specified by:

logWarning in interface atg.core.logging.Logging

Specified by:

logWarning in interface ApplicationLogging

Overrides:

logWarning in class GenericService

logWarning

public void logWarning(java.lang.Throwable pThrowable)

Logs an warning event with the specified Throwable

Specified by:

logWarning in interface atg.core.logging.Logging

Specified by:

logWarning in interface ApplicationLogging

Overrides:

logWarning in class GenericService

logWarning

public void logWarning(java.lang.String pMessage,
              java.lang.Throwable pThrowable)

Logs an warning event with the specified message and Throwable

Specified by:

logWarning in interface atg.core.logging.Logging

Specified by:

logWarning in interface ApplicationLogging

Overrides:

logWarning in class GenericService

logError

public void logError(java.lang.String pMessage)

Logs an error event with the specified message

Specified by:

logError in interface atg.core.logging.Logging

Specified by:

logError in interface ApplicationLogging

Overrides:

logError in class GenericService

logError

public void logError(java.lang.Throwable pThrowable)

Logs an error event with the specified Throwable

Specified by:

logError in interface atg.core.logging.Logging

Specified by:

logError in interface ApplicationLogging

Overrides:

logError in class GenericService

logError

public void logError(java.lang.String pMessage,
            java.lang.Throwable pThrowable)

Logs an error event with the specified message and Throwable

Specified by:

logError in interface atg.core.logging.Logging

Specified by:

logError in interface ApplicationLogging

Overrides:

logError in class GenericService

logDebug

public void logDebug(java.lang.String pMessage)

Logs an debug event with the specified message

Specified by:

logDebug in interface atg.core.logging.Logging

Specified by:

logDebug in interface ApplicationLogging

Overrides:

logDebug in class GenericService

logDebug

public void logDebug(java.lang.Throwable pThrowable)

Logs an debug event with the specified Throwable

Specified by:

logDebug in interface atg.core.logging.Logging

Specified by:

logDebug in interface ApplicationLogging

Overrides:

logDebug in class GenericService

logDebug

public void logDebug(java.lang.String pMessage,
            java.lang.Throwable pThrowable)

Logs an debug event with the specified message and Throwable

Specified by:

logDebug in interface atg.core.logging.Logging

Specified by:

logDebug in interface ApplicationLogging

Overrides:

logDebug in class GenericService