lumis.doui.service

Class DouiService

java.lang.Object

lumis.portal.service.GenericService

lumis.doui.service.DouiService

All Implemented Interfaces:

IDouiService, IHyperLinkResolver, IService

Direct Known Subclasses:

ActivityStreamService, AutoAdministrationService, ContentService, HtmlService, MicroblogService, ProducerService, SocialNetworkIntegrationService, WSRPConsumerService

@StableMinor(version="10.1",
             sinceVersion="4.0")
public class DouiService
extends GenericService
implements IDouiService, IHyperLinkResolver

Implements a DOUI Service.

Since:

4.0.0

Version:

$Revision: 19961 $ $Date: 2017-02-21 21:39:20 +0000 (Tue, 21 Feb 2017) $

Field Summary

Fields inherited from class lumis.portal.service.GenericService

serviceConfig

Constructor Summary

Constructors

Constructor and Description
DouiService()

Method Summary

Modifier and Type	Method and Description
void	addDefaultDouiDefinitionValues(SessionConfig sessionConfig, ServiceConfig serviceConfig, Node douiDefinitionNode, ITransaction transaction)
void	autoAddDependencies(SessionConfig sessionConfig, ServiceInstanceConfig config, ITransaction transaction) Adds service specific dependencies.
Element	getDefaultServiceInstanceMenu(ServiceInstanceConfig serviceInstance) Returns the default service instance menu definition to use for a service instance.
protected String	getResourceClassName()
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	postRegister(SessionConfig sessionConfig, ServiceConfig serviceConfig, ITransaction transaction) Called by the service manager after a service definition is registered.
void	preUnregister(SessionConfig sessionConfig, ITransaction transaction) Called by the service manager when a service is about to be unregistered.
IServiceInterfaceUrl	resolveHyperLink(SessionConfig sessionConfig, HyperLinkConfig hyperLinkConfig, ITransaction transaction) Resolves an hyperlink to the corresponding URL.
Response	restLumGetDataGet(String restShortName, String restInterfaceName, HttpServletRequest servletRequest) Sub-resource to treats request on GET HTTP method.
Response	restLumGetDataPost(String restShortName, String restInterfaceName, HttpServletRequest servletRequest) Sub-resource to treats request on POST HTTP method.
protected void	setDataTypeAttributes(Node douiDefinitionNode, ITransaction transaction) Replace number data type for integer data type, for backward compatibility.
protected void	setDisplayAttributes(Node douiDefinitionNode, ITransaction transaction)
protected void	setIncludeAlwaysAttributes(Node douiDefinitionNode, ITransaction transaction)
protected void	setLookupAttributes(Node douiDefinitionNode, ITransaction transaction)
protected void	setPriorityOptions(Node douiDefinitionNode, ITransaction transaction)
protected void	setSourceFieldAttributes(SessionConfig sessionConfig, ServiceConfig serviceConfig, Node douiDefinitionNode, ITransaction transaction)
protected void	setValidationAttributes(Node douiDefinitionNode, ITransaction transaction)
boolean	usesDocumentService(ITransaction transaction) Indicates if this service uses a document service (as repository, for example).
boolean	usesFileManager(ITransaction transaction) Indicates if this service uses the FileManager file storage API.
boolean	usesImageService(ITransaction transaction) Deprecated.
boolean	usesMediaRepository(ITransaction transaction) Indicates if this service may use a media repository.

Methods inherited from class lumis.portal.service.GenericService

deserializeContent, instanceDeserialized, instanceLoaded, instanceMoved, instanceMoved, instanceSerialized, instanceSerialized, 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

checkFileAccess, deserializeContent, instanceDeserialized, instanceLoaded, instanceMoved, instanceMoved, instanceSerialized, instanceSerialized, instanceUnloaded, load, postUnregister, preRegister, unload

Constructor Detail

DouiService

public DouiService()

Method Detail

restLumGetDataPost

@Path(value="/lumgetdata/{restInterfaceName}")
 @POST
 @Produces(value={"application/json","application/xml"})
public final Response restLumGetDataPost(@PathParam(value="restShortName")
                                                                                                                                                        String restShortName,
                                                                                                                                                        @PathParam(value="restInterfaceName")
                                                                                                                                                        String restInterfaceName,
                                                                                                                                                        @Context
                                                                                                                                                        HttpServletRequest servletRequest)

Sub-resource to treats request on POST HTTP method. This sub-resource is responsible for load a REST interface and return the information as JSON or XML format.

Parameters:

restShortName - instance of service target that the information will be loaded.

restInterfaceName - name of the rest interface that will be loaded, optionally including an extension (.json or .xml) used to choose the response format.

servletRequest - request object that contains all information that was sent by user.

Returns:

returns the information loaded from rest interface as JSON or XML format.

Since:

6.1.0

restLumGetDataGet

@Path(value="/lumgetdata/{restInterfaceName}")
 @GET
 @Produces(value={"application/json","application/xml"})
public final Response restLumGetDataGet(@PathParam(value="restShortName")
                                                                                                                                                      String restShortName,
                                                                                                                                                      @PathParam(value="restInterfaceName")
                                                                                                                                                      String restInterfaceName,
                                                                                                                                                      @Context
                                                                                                                                                      HttpServletRequest servletRequest)

Sub-resource to treats request on GET HTTP method. This sub-resource is responsible for load a REST interface and return the information as JSON or XML format.

Parameters:

restShortName - instance of service target that the information will be loaded.

restInterfaceName - name of the rest interface that will be loaded, optionally including an extension (.json or .xml) used to choose the response format.

servletRequest - request object that contains all information that was sent by user.

Returns:

returns the information loaded from rest interface as JSON or XML format.

Since:

6.1.0

preUnregister

public void preUnregister(SessionConfig sessionConfig,
                          ITransaction transaction)
                   throws PortalException

Description copied from interface: IService

Called by the service manager when a service is about to be unregistered.

Specified by:

preUnregister in interface IService

Overrides:

preUnregister in class GenericService

Parameters:

sessionConfig - the user session information.

transaction - transaction for persistence access.

Throws:

PortalException

postRegister

public void postRegister(SessionConfig sessionConfig,
                         ServiceConfig serviceConfig,
                         ITransaction transaction)
                  throws PortalException

Description copied from interface: IService

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.

Specified by:

postRegister in interface IService

Overrides:

postRegister in class GenericService

Throws:

PortalException

getResourceClassName

protected String getResourceClassName()

Overrides:

getResourceClassName in class GenericService

usesFileManager

public boolean usesFileManager(ITransaction transaction)
                        throws PortalException

Description copied from interface: IDouiService

Indicates if this service uses the FileManager file storage API.

Specified by:

usesFileManager in interface IDouiService

Parameters:

transaction - the transaction for persistence access.

Returns:

true if this service uses the FileManager, false otherwise.

Throws:

PortalException

usesImageService

@Deprecated
public boolean usesImageService(ITransaction transaction)
                                     throws PortalException

Deprecated.

Description copied from interface: IDouiService

Indicates if this service uses an image service (as repository, for example).

Specified by:

usesImageService in interface IDouiService

Parameters:

transaction - the transaction for persistence access.

Returns:

true if this service uses a image service, 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

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

Parameters:

transaction - the transaction for persistence access.

Returns:

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

Throws:

PortalException

getDefaultServiceInstanceMenu

public Element getDefaultServiceInstanceMenu(ServiceInstanceConfig serviceInstance)
                                      throws PortalException

Description copied from interface: IService

Returns the default service instance menu definition to use for a service instance.

This default is used if this service does not have a explicit menu definition in its servicedefinition.xml.

Specified by:

getDefaultServiceInstanceMenu in interface IService

Overrides:

getDefaultServiceInstanceMenu in class GenericService

Parameters:

serviceInstance - the service instance.

Returns:

the menu definition.

Throws:

PortalException - if the menu could not be generated.

instanceAdded

public void instanceAdded(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 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 GenericService

config - a ServiceInstanceConfig object containing the service's configuration

Throws:

ServiceException

PortalException

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 GenericService

Throws:

PortalException

instanceDeleted

public void instanceDeleted(SessionConfig sessionConfig,
                            ServiceInstanceConfig config,
                            ITransaction transaction)
                     throws 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 GenericService

config - a ServiceInstanceConfig object containing the service's configuration

Throws:

ServiceException

PortalException

addDefaultDouiDefinitionValues

public void addDefaultDouiDefinitionValues(SessionConfig sessionConfig,
                                           ServiceConfig serviceConfig,
                                           Node douiDefinitionNode,
                                           ITransaction transaction)
                                    throws PortalException

Specified by:

addDefaultDouiDefinitionValues in interface IDouiService

Throws:

PortalException

setSourceFieldAttributes

protected void setSourceFieldAttributes(SessionConfig sessionConfig,
                                        ServiceConfig serviceConfig,
                                        Node douiDefinitionNode,
                                        ITransaction transaction)
                                 throws PortalException

Throws:

PortalException

setDataTypeAttributes

protected void setDataTypeAttributes(Node douiDefinitionNode,
                                     ITransaction transaction)
                              throws PortalException

Replace number data type for integer data type, for backward compatibility.

Parameters:

douiDefinitionNode - the doui definition to adjust.

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.0.4

setPriorityOptions

protected void setPriorityOptions(Node douiDefinitionNode,
                                  ITransaction transaction)
                           throws PortalException

Throws:

PortalException

setIncludeAlwaysAttributes

protected void setIncludeAlwaysAttributes(Node douiDefinitionNode,
                                          ITransaction transaction)
                                   throws PortalException

Throws:

PortalException

setDisplayAttributes

protected void setDisplayAttributes(Node douiDefinitionNode,
                                    ITransaction transaction)
                             throws PortalException

Throws:

PortalException

setLookupAttributes

protected void setLookupAttributes(Node douiDefinitionNode,
                                   ITransaction transaction)
                            throws PortalException

Throws:

PortalException

setValidationAttributes

protected void setValidationAttributes(Node douiDefinitionNode,
                                       ITransaction transaction)
                                throws PortalException

Throws:

PortalException

autoAddDependencies

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

Description copied from interface: IService

Adds service specific dependencies. This is usually called when an instance of the service is created.

Specified by:

autoAddDependencies in interface IService

Overrides:

autoAddDependencies in class GenericService

Throws:

ServiceException

PortalException

resolveHyperLink

public IServiceInterfaceUrl resolveHyperLink(SessionConfig sessionConfig,
                                             HyperLinkConfig hyperLinkConfig,
                                             ITransaction transaction)
                                      throws PortalException

Resolves an hyperlink to the corresponding URL.

DouiService delegates this resolution to a DouiHyperLinkResolver.

Specified by:

resolveHyperLink in interface IHyperLinkResolver

Parameters:

sessionConfig - the user session information.

hyperLinkConfig - hyperlink information

transaction - the transaction for persistence access.

Returns:

the url, or null if the hyperlink could not be resolved.

Throws:

PortalException