Package lumis.service.analytics

Class AnalyticsService

java.lang.Object

lumis.portal.service.GenericService

lumis.doui.service.DouiService

lumis.content.service.ContentService

lumis.service.analytics.AnalyticsService

All Implemented Interfaces:

IDouiService, IHyperLinkResolver, IService, IServiceClockDefinitionProvider

public class AnalyticsService
extends ContentService

Service class for Analytics.

Since:

11.0.0

Version:

$Revision: 25577 $ $Date: 2023-04-25 12:11:15 -0300 (Tue, 25 Apr 2023) $

Field Summary

Fields inherited from class lumis.doui.service.DouiService

EVENT_REST_CALL

Fields inherited from class lumis.portal.service.GenericService

serviceConfig

Constructor Summary

Constructors

Constructor	Description
AnalyticsService()

Method Summary

Modifier and Type	Method	Description
void	deserializeContent(ServiceInstanceDeserializationContext serviceInstanceDeserializationContext)	Deserializes service instance Content.
boolean	hasHtmlField(ITransaction transaction)	Indicates if this service has an html field.
void	instanceAdded(SessionConfig sessionConfig, ServiceInstanceConfig serviceInstanceConfig, ITransaction transaction)	Called by the service container to indicate that a service instance has been added.
void	instanceDeleted(SessionConfig sessionConfig, ServiceInstanceConfig config, ITransaction transaction)	Called by the service container to indicate that a service instance is about to be deleted.
void	instanceDeserialized(SessionConfig sessionConfig, java.lang.String serviceInstanceId, DeserializationConfig deserializationConfig, org.w3c.dom.Node node, ITransaction transaction)	Called after an service instance is deserialized.
void	instanceDeserialized(ServiceInstanceDeserializationContext serviceInstanceDeserializationContext)	Called after an service instance is deserialized.
void	instanceMoved(SessionConfig sessionConfig, ServiceInstanceConfig serviceInstance, ChannelConfig oldChannel, ChannelConfig newChannel, ITransaction transaction)	Called to indicate the given service instance was moved from a channel to the other channel.
void	instanceSerialized(SessionConfig sessionConfig, java.lang.String serviceInstanceId, java.io.OutputStream outputStream, ITransaction transaction)	Called after the serialization of a service instance.
void	instanceSerialized(ServiceInstanceSerializationContext serviceInstanceSerializationContext)	Called after the serialization of a service instance.
boolean	usesDocumentService(ITransaction transaction)	Indicates if this service uses a document service (as repository, for example).
boolean	usesMediaRepository(ITransaction transaction)	Indicates if this service may use a media repository.

Methods inherited from class lumis.content.service.ContentService

checkFileAccess, deleteContent, getClocks, getDefaultServiceInstanceMenu, getResourceClassName, postRegister, preUnregister, registerActivityObjectTypes, resolveHyperLink, restLumGetContent, setMetaDataField, setMetaDataField, setMetaDataFieldIfRequested, setMetaDataFields, setSourceFieldAttributes, unregisterActivityObjectTypes

Methods inherited from class lumis.doui.service.DouiService

addDefaultDouiDefinitionValues, autoAddDependencies, getReturnType, restCallProcessAction, restDoProcessAction, restDoProcessActionWithActionId, restGetProcessActionRestHelp, restLumGetDataGet, restLumGetDataPost, setDataTypeAttributes, setDisplayAttributes, setIncludeAlwaysAttributes, setLookupAttributes, setPositionAttributes, setPriorityOptions, setValidationAttributes, usesFileManager, usesImageService, usesWidgetRepository

Methods inherited from class lumis.portal.service.GenericService

instanceLoaded, instanceMoved, instanceMoved, instanceUnloaded, load, postUnregister, preRegister, unload

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.portal.service.IService

instanceLoaded, instanceMoved, instanceMoved, instanceUnloaded, load, postUnregister, preRegister, unload

Constructor Detail

AnalyticsService

public AnalyticsService()

Method Detail

instanceAdded

public void instanceAdded(SessionConfig sessionConfig,
                          ServiceInstanceConfig serviceInstanceConfig,
                          ITransaction transaction)
                   throws ServiceException,
                          PortalException

Description copied from interface: IService

Called by the service container to indicate that a service instance has been added. Dependencies between services must never be created inside this method. Dependencies must be created in the IService.autoAddDependencies(lumis.portal.authentication.SessionConfig, lumis.portal.serviceinstance.ServiceInstanceConfig, lumis.util.ITransaction) method.

Specified by:

instanceAdded in interface IService

Overrides:

instanceAdded in class ContentService

serviceInstanceConfig - a ServiceInstanceConfig object containing the service's configuration

Throws:

ServiceException

PortalException

instanceDeleted

public void instanceDeleted(SessionConfig sessionConfig,
                            ServiceInstanceConfig config,
                            ITransaction transaction)
                     throws ServiceException,
                            PortalException

Description copied from interface: IService

Called by the service container to indicate that a service instance is about to be deleted.

Specified by:

instanceDeleted in interface IService

Overrides:

instanceDeleted in class ContentService

config - a ServiceInstanceConfig object containing the service's configuration

Throws:

ServiceException

PortalException

instanceMoved

public void instanceMoved(SessionConfig sessionConfig,
                          ServiceInstanceConfig serviceInstance,
                          ChannelConfig oldChannel,
                          ChannelConfig newChannel,
                          ITransaction transaction)
                   throws ServiceException,
                          PortalException

Description copied from interface: IService

Called to indicate the given service instance was moved from a channel to the other channel.

Parameters:

sessionConfig - the user's session

serviceInstance - the service instance

oldChannel - the old channel

newChannel - the new channel

Throws:

ServiceException

PortalException

deserializeContent

public void deserializeContent(ServiceInstanceDeserializationContext serviceInstanceDeserializationContext)
                        throws PortalException

Description copied from interface: IService

Deserializes service instance Content.

Specified by:

deserializeContent in interface IService

Overrides:

deserializeContent in class ContentService

Throws:

PortalException

instanceSerialized

public void instanceSerialized(ServiceInstanceSerializationContext serviceInstanceSerializationContext)
                        throws PortalException

Description copied from interface: IService

Called after the serialization of a service instance. The service may serialize additional structure or data

Specified by:

instanceSerialized in interface IService

Overrides:

instanceSerialized in class ContentService

Throws:

PortalException

instanceSerialized

public void instanceSerialized(SessionConfig sessionConfig,
                               java.lang.String serviceInstanceId,
                               java.io.OutputStream outputStream,
                               ITransaction transaction)
                        throws PortalException

Description copied from interface: IService

Called after the serialization of a service instance. The service may add custom information on the output stream, and they will be available during #aclDeserialized.

Specified by:

instanceSerialized in interface IService

Overrides:

instanceSerialized in class ContentService

Parameters:

sessionConfig - user session information.

serviceInstanceId - the service instance id.

outputStream - the serialization outputStream.

transaction - the transaction for persistence access.

Throws:

PortalException

See Also:

IService.instanceDeserialized(SessionConfig, String, DeserializationConfig, Node, ITransaction)

instanceDeserialized

public void instanceDeserialized(ServiceInstanceDeserializationContext serviceInstanceDeserializationContext)
                          throws PortalException

Description copied from interface: IService

Called after an service instance is deserialized.

Specified by:

instanceDeserialized in interface IService

Overrides:

instanceDeserialized in class ContentService

Throws:

PortalException

instanceDeserialized

public void instanceDeserialized(SessionConfig sessionConfig,
                                 java.lang.String serviceInstanceId,
                                 DeserializationConfig deserializationConfig,
                                 org.w3c.dom.Node node,
                                 ITransaction transaction)
                          throws PortalException

Description copied from interface: IService

Called after an service instance is deserialized.

Specified by:

instanceDeserialized in interface IService

Overrides:

instanceDeserialized in class ContentService

Parameters:

sessionConfig - user session information.

serviceInstanceId - the service instance id.

deserializationConfig - the deserialization configuration.

node - the deserialized acl node.

transaction - the transaction for persistence access.

Throws:

PortalException

See Also:

IService.instanceSerialized(SessionConfig, String, OutputStream, ITransaction)

hasHtmlField

public boolean hasHtmlField(ITransaction transaction)
                     throws PortalException

Description copied from interface: IDouiService

Indicates if this service has an html field.

Specified by:

hasHtmlField in interface IDouiService

Overrides:

hasHtmlField in class DouiService

Parameters:

transaction - the transaction for persistence access.

Returns:

true if this service has an html field, false otherwise.

Throws:

PortalException

usesMediaRepository

public boolean usesMediaRepository(ITransaction transaction)
                            throws PortalException

Description copied from interface: IDouiService

Indicates if this service may use a media repository.

Specified by:

usesMediaRepository in interface IDouiService

Overrides:

usesMediaRepository in class DouiService

Parameters:

transaction - the transaction for persistence access.

Returns:

true if this service may use a media service, false otherwise.

Throws:

PortalException

usesDocumentService

public boolean usesDocumentService(ITransaction transaction)
                            throws PortalException

Description copied from interface: IDouiService

Indicates if this service uses a document service (as repository, for example).

Specified by:

usesDocumentService in interface IDouiService

Overrides:

usesDocumentService in class DouiService

Parameters:

transaction - the transaction for persistence access.

Returns:

true if this service uses a document service, false otherwise.

Throws:

PortalException