All Superinterfaces:

IConfigKeyChecker

All Known Implementing Classes:

ServiceManager
```
@StableMinor(version="16.1",
             sinceVersion="4.0")
public interface IServiceManager
extends IConfigKeyChecker
```
Defines the methods available in a service manager.

Since:

4.0.0

Version:

$Revision: 26156 $ $Date: 2024-01-13 10:26:46 -0300 (Sat, 13 Jan 2024) $

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`clearCache()`	Clear the manager cache entries for Services, Service Configs and Service Types.
`ServiceConfig`	`get(SessionConfig sessionConfig, java.lang.String serviceId, ITransaction transaction)`	Get the configuration of the service.
`java.util.Collection<java.lang.String>`	`getPreBuiltChannelFiles(SessionConfig sessionConfig, java.lang.String serviceId, ITransaction transaction)`	Returns a collection of paths to the pre built channel files for the specified service.
`IService`	`getService(SessionConfig sessionConfig, java.lang.String serviceId, ITransaction transaction)`	Get the service.
`java.util.Collection<ServiceConfig>`	`getServices(SessionConfig sessionConfig, boolean getInstantiableServicesOnly, ITransaction transaction)`	Get services.
`void`	`register(SessionConfig sessionConfig, java.lang.String serviceConfigPath, ITransaction transaction)`	Register the service.
`void`	`registerServiceTypes(SessionConfig sessionConfig, java.lang.String serviceTypesConfigPath, ITransaction transaction)`	Register the types of service.
`void`	`unregister(SessionConfig sessionConfig, java.lang.String serviceId, ITransaction transaction)`	Unregister a service.
`void`	`unregisterServiceType(SessionConfig sessionConfig, java.lang.String typeId, ITransaction transaction)`	Unregister the service´s type.

Methods inherited from interface lumis.portal.serialization.operation.IConfigKeyChecker
keyExists

Method Detail

register

void register(SessionConfig sessionConfig,
              java.lang.String serviceConfigPath,
              ITransaction transaction)
       throws ManagerException,
              PortalException

Register the service.

Parameters:: sessionConfig -; serviceConfigPath -; transaction -
Throws:: ManagerException; PortalException

unregister

void unregister(SessionConfig sessionConfig,
                java.lang.String serviceId,
                ITransaction transaction)
         throws ManagerException,
                PortalException

Unregister a service.

Parameters:: sessionConfig - identifier for the session.; serviceId - the id of the service.; transaction - the transaction for persistence access.
Throws:: ManagerException; PortalException

get

ServiceConfig get(SessionConfig sessionConfig,
                  java.lang.String serviceId,
                  ITransaction transaction)
           throws ManagerException,
                  PortalException

Get the configuration of the service.

Parameters:: serviceId -; transaction -
Returns:: Returns the ServiceConfig.
Throws:: ManagerException; PortalException

getService

IService getService(SessionConfig sessionConfig,
                    java.lang.String serviceId,
                    ITransaction transaction)
             throws ManagerException,
                    PortalException

Get the service.

Parameters:: serviceId -; transaction -
Returns:: an IService.
Throws:: ManagerException; PortalException

getServices

java.util.Collection<ServiceConfig> getServices(SessionConfig sessionConfig,
                                                boolean getInstantiableServicesOnly,
                                                ITransaction transaction)
                                         throws ManagerException,
                                                PortalException

Get services.

Parameters:: sessionConfig -; transaction -
Returns:: a ServiceConfig array.
Throws:: ManagerException; PortalException

registerServiceTypes

void registerServiceTypes(SessionConfig sessionConfig,
                          java.lang.String serviceTypesConfigPath,
                          ITransaction transaction)
                   throws ManagerException,
                          PortalException

Register the types of service.

Parameters:: sessionConfig -; serviceTypesConfigPath -; transaction -
Throws:: ManagerException; PortalException

unregisterServiceType

void unregisterServiceType(SessionConfig sessionConfig,
                           java.lang.String typeId,
                           ITransaction transaction)
                    throws ManagerException,
                           PortalException

Unregister the service´s type.

Parameters:: typeId -; transaction -
Throws:: ManagerException; PortalException

getPreBuiltChannelFiles

java.util.Collection<java.lang.String> getPreBuiltChannelFiles(SessionConfig sessionConfig,
                                                               java.lang.String serviceId,
                                                               ITransaction transaction)
                                                        throws PortalException

Returns a collection of paths to the pre built channel files for the specified service. The paths are all relative to the definition path.

Parameters:: sessionConfig - the user session information.; serviceId - the service id.; transaction - the transaction for persistence access.
Returns:: a collection of paths to the pre built channel files for the specified service.
Throws:: PortalException
Since:: 4.0.6

clearCache
```
void clearCache()
         throws PortalException
```
Clear the manager cache entries for Services, Service Configs and Service Types.

Throws:

PortalException

Since:

4.0.6

Interface IServiceManager