lumis.portal.service
Interface IService

Package class diagram package IService
All Known Subinterfaces:
IDouiService
All Known Implementing Classes:
ChatRoomService, ColService, CommentService, ContentService, DouiService, GenericService, HtmlService, MicroblogService, NavigationService, PagePersonalizationService, PortletService, ProducerService, ReportService, RssService, SocialNetworkIntegrationService, WikiService, WSRPConsumerService

@StableMinor(version="6.2",
             sinceVersion="4.0")
public interface IService

Defines methods all portal services must implement.

Since:
4.0.0
See Also:
GenericService

Method Summary
 void autoAddDependencies(SessionConfig sessionConfig, ServiceInstanceConfig config, ITransaction transaction)
          Adds service specific dependencies.
 void deserializeContent(ServiceInstanceDeserializationContext serviceInstanceDeserializationContext)
          Deserializes service instance Content.
 void instanceAdded(SessionConfig sessionConfig, ServiceInstanceConfig config, 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(ServiceInstanceDeserializationContext serviceInstanceDeserializationContext)
          Called after an service instance is deserialized.
 void instanceDeserialized(SessionConfig sessionConfig, String serviceInstanceId, DeserializationConfig deserializationConfig, Node accessControlListNode, ITransaction transaction)
          Called after an service instance is deserialized.
 void instanceLoaded(ServiceInstanceConfig config)
          Called by the service container to indicate that a service instance has been loaded
 void instanceMoved(SessionConfig sessionConfig, ServiceInstanceConfig serviceInstance, IPortalBaseFolder oldWebRootFolder, IPortalBaseFolder newWebRootFolder, ITransaction transaction)
          Called to indicate the given service instance has been moved from a web root base folder to another one.
 void instanceMoved(SessionConfig sessionConfig, ServiceInstanceConfig serviceInstance, IWebsite oldWebsite, IWebsite newWebsite, ITransaction transaction)
          Called to indicate the given service instance has been moved from a website to another one.
 void instanceSerialized(ServiceInstanceSerializationContext serviceInstanceSerializationContext)
          Called after the serialization of a service instance.
 void instanceSerialized(SessionConfig sessionConfig, String serviceInstanceId, OutputStream outputStream, ITransaction transaction)
          Called after the serialization of a service instance.
 void instanceUnloaded(ServiceInstanceConfig config)
          Called by the service container to indicate that a service instance is about to be unloaded
 void load(ServiceConfig config)
          Called by the service container to indicate to a service that the service is being activated.
 void postRegister(SessionConfig sessionConfig, ServiceConfig serviceConfig, ITransaction transaction)
          Called by the service manager after a service definition is registered.
 void postUnregister(SessionConfig sessionConfig, ITransaction transaction)
          Called by the service manager after a service has been unregistered.
 void preRegister(SessionConfig sessionConfig, Node serviceXmlNode, ITransaction transaction)
          Called by the service manager when a service definition is about to be registered.
 void preUnregister(SessionConfig sessionConfig, ITransaction transaction)
          Called by the service manager when a service is about to be unregistered.
 void unload(ServiceConfig config)
          Called by the service container to indicate to a service that the it is being de-activated.
 

Method Detail

preRegister

void preRegister(SessionConfig sessionConfig,
                 Node serviceXmlNode,
                 ITransaction transaction)
                 throws PortalException
Called by the service manager when a service definition is about to be registered. This method allows the Service implementation to set its default values into the service definition xml.

Parameters:
sessionConfig - TODO
serviceXmlNode -
transaction - TODO
Throws:
PortalException

postRegister

void postRegister(SessionConfig sessionConfig,
                  ServiceConfig serviceConfig,
                  ITransaction transaction)
                  throws PortalException
Called by the service manager after a service definition is registered. This method allows the Service implementation to perform any custom registration that the service may require.

Parameters:
serviceXmlNode -
Throws:
PortalException

preUnregister

void preUnregister(SessionConfig sessionConfig,
                   ITransaction transaction)
                   throws PortalException
Called by the service manager when a service is about to be unregistered.

Parameters:
sessionConfig - the user session information.
transaction - transaction for persistence access.
Throws:
PortalException

postUnregister

void postUnregister(SessionConfig sessionConfig,
                    ITransaction transaction)
                    throws PortalException
Called by the service manager after a service has been unregistered.

Parameters:
sessionConfig - the user session information.
transaction - transaction for persistence access.
Throws:
PortalException

load

void load(ServiceConfig config)
          throws ServiceException,
                 PortalException
Called by the service container to indicate to a service that the service is being activated.

The service container calls the init method exactly once after instantiating the service. The init method must complete successfully before any interfaces are created.

The service container cannot place the service into service if the init method

  1. Throws a ServiceException
  2. Does not return within a time period defined by the service container.

Parameters:
config - a ServiceConfig object containing the service's configuration and initialization parameters
Throws:
ServiceException - if an exception has occurred that interferes with the service interface's normal operation.
PortalException

unload

void unload(ServiceConfig config)
            throws ServiceException,
                   PortalException
Called by the service container to indicate to a service that the it is being de-activated.

Before the service container calls the destroy method, it should allow any threads that are currently processing requests within the service object to complete execution. To avoid waiting forever, the service container can optionally wait for a predefined time before destroying the service object.

This method enables the service to do the following:

Parameters:
config - a ServiceConfig object containing the service's configuration
Throws:
ServiceException
PortalException

instanceLoaded

void instanceLoaded(ServiceInstanceConfig config)
                    throws ServiceException,
                           PortalException
Called by the service container to indicate that a service instance has been loaded

Parameters:
config - a ServiceInstanceConfig object containing the service's configuration
Throws:
ServiceException
PortalException

instanceUnloaded

void instanceUnloaded(ServiceInstanceConfig config)
                      throws ServiceException,
                             PortalException
Called by the service container to indicate that a service instance is about to be unloaded

Parameters:
config - a ServiceInstanceConfig object containing the service's configuration
Throws:
ServiceException
PortalException

instanceAdded

void instanceAdded(SessionConfig sessionConfig,
                   ServiceInstanceConfig config,
                   ITransaction transaction)
                   throws ServiceException,
                          PortalException
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 autoAddDependencies(lumis.portal.authentication.SessionConfig, lumis.portal.serviceinstance.ServiceInstanceConfig, lumis.util.ITransaction) method.

Parameters:
config - a ServiceInstanceConfig object containing the service's configuration
Throws:
ServiceException
PortalException

instanceDeleted

void instanceDeleted(SessionConfig sessionConfig,
                     ServiceInstanceConfig config,
                     ITransaction transaction)
                     throws ServiceException,
                            PortalException
Called by the service container to indicate that a service instance is about to be deleted.

Parameters:
config - a ServiceInstanceConfig object containing the service's configuration
Throws:
ServiceException
PortalException

instanceMoved

void instanceMoved(SessionConfig sessionConfig,
                   ServiceInstanceConfig serviceInstance,
                   IWebsite oldWebsite,
                   IWebsite newWebsite,
                   ITransaction transaction)
                   throws ServiceException,
                          PortalException
Called to indicate the given service instance has been moved from a website to another one. The websites are, necessarily, different and they may be null, but not both.

Parameters:
sessionConfig - the user's session.
serviceInstance - the service instance.
oldWebsite - the old website.
newWebsite - the new website.
transaction - the transaction.
Throws:
ServiceException
PortalException
Since:
6.2.0

instanceMoved

void instanceMoved(SessionConfig sessionConfig,
                   ServiceInstanceConfig serviceInstance,
                   IPortalBaseFolder oldWebRootFolder,
                   IPortalBaseFolder newWebRootFolder,
                   ITransaction transaction)
                   throws ServiceException,
                          PortalException
Called to indicate the given service instance has been moved from a web root base folder to another one. Both folders are necessarily not null.

Parameters:
sessionConfig - the user's session.
serviceInstance - the service instance.
oldWebRootFolder - the old web root folder.
newWebRootFolder - the new web root folder.
transaction - the transaction.
Throws:
ServiceException
PortalException
Since:
6.2.0

autoAddDependencies

void autoAddDependencies(SessionConfig sessionConfig,
                         ServiceInstanceConfig config,
                         ITransaction transaction)
                         throws ServiceException,
                                PortalException
Adds service specific dependencies. This is usually called when an instance of the service is created.

Parameters:
sessionConfig -
config -
transaction -
Throws:
ServiceException
PortalException
Since:
4.0.3

instanceSerialized

void instanceSerialized(SessionConfig sessionConfig,
                        String serviceInstanceId,
                        OutputStream outputStream,
                        ITransaction transaction)
                        throws PortalException
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.

Parameters:
sessionConfig - user session information.
serviceInstanceId - the service instance id.
outputStream - the serialization outputStream.
transaction - the transaction for persistence access.
Throws:
PortalException
Since:
4.0.6
See Also:
instanceDeserialized(SessionConfig, String, DeserializationConfig, Node, ITransaction)

instanceDeserialized

void instanceDeserialized(SessionConfig sessionConfig,
                          String serviceInstanceId,
                          DeserializationConfig deserializationConfig,
                          Node accessControlListNode,
                          ITransaction transaction)
                          throws PortalException
Called after an service instance is deserialized.

Parameters:
sessionConfig - user session information.
serviceInstanceId - the service instance id.
deserializationConfig - the deserialization configuration.
accessControlListNode - the deserialized acl node.
transaction - the transaction for persistence access.
Throws:
PortalException
Since:
4.0.6
See Also:
instanceSerialized(SessionConfig, String, OutputStream, ITransaction)

instanceSerialized

void instanceSerialized(ServiceInstanceSerializationContext serviceInstanceSerializationContext)
                        throws PortalException
Called after the serialization of a service instance. The service may serialize additional structure or data

Parameters:
sessionConfig -
serviceInstanceSerializationContext -
transaction -
Throws:
PortalException

instanceDeserialized

void instanceDeserialized(ServiceInstanceDeserializationContext serviceInstanceDeserializationContext)
                          throws PortalException
Called after an service instance is deserialized.

Parameters:
sessionConfig -
serviceInstanceDeserializationContext -
transaction -
Throws:
PortalException

deserializeContent

void deserializeContent(ServiceInstanceDeserializationContext serviceInstanceDeserializationContext)
                        throws PortalException
Deserializes service instance Content.

Parameters:
sessionConfig -
serviceInstanceDeserializationContext -
transaction -
Throws:
PortalException


Lumisportal  6.2.0.120405 - Copyright © 2006–2012 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.