com.sapportals.portal.prt.service

Interface IService

All Known Subinterfaces:

IAddProviderMessageService, ICacheManager, IClearRepositoryCacheService, IConnectorGatewayService, IConnectorInvestigatorService, IContentTaggingService, IDocumentHookService, IEditorFrameworkService, IEpcfToolbox, IExportalJCOClientService, IGenericCreatorGatewayService, IGenericCreatorRegister, IHTTPService, IJCOClientService, ILicenseService, ILocaleListService, ILocalesConfigService, ILoginMessageProvider, IMessageProviderRegistration, INamingConventionsSrv, INotificationService, IPersonalizationDelivery, IPersonalizationSyncService, IProxyServerService, IPRTCacheService, ISAPAuthTraceService, ISearchProvider, ISearchService, ISecurityService, IServiceFactory, ITextRepositoryService, ITransformerService, IUserManagementEngine, IUserManagementService, IWizardFramework, IWPCContentRegistration

All Known Implementing Classes:

AbstractTransformerHolder, TransformersProvider

public interface IService

Interface implemented by all the classes that want to specify a Service

Method Summary

void	afterInit() Deprecated. This method is no longer executed in a separate phase, but is executed immediately after the init method. Place all initialization code in init(IServiceContext serviceContext). The only case that this method may be necessary is if a service depends on other services that it is not aware of in advance. However, this would be bad design, and it is highly recommended not to use this method at all. For known dependencies, define runtime references (sharing references) in the portalapp.xml deployment descriptor. This ensures that all dependent services are initialized (that is, their init methods are called) before this service is initialized. It is possible to have the portal execute the afterInit method after executing the init method for all services, by modifying the portalapp.xml deployment descriptor. For more information, see SAP note # 960199
void	configure(IServiceConfiguration configuration) Deprecated. Do not use anymore.
void	destroy() Called upon release of the service from the container.
IServiceContext	getContext() get the context of the service
String	getKey() return the key of the service
void	init(IServiceContext serviceContext) generic init of the service
void	release() Deprecated. use destroy instead.

Method Detail

init

void init(IServiceContext serviceContext)

generic init of the service

Parameters:

serviceContext -

afterInit

void afterInit()

Deprecated. This method is no longer executed in a separate phase, but is executed immediately after the init method. Place all initialization code in init(IServiceContext serviceContext). The only case that this method may be necessary is if a service depends on other services that it is not aware of in advance. However, this would be bad design, and it is highly recommended not to use this method at all. For known dependencies, define runtime references (sharing references) in the portalapp.xml deployment descriptor. This ensures that all dependent services are initialized (that is, their init methods are called) before this service is initialized. It is possible to have the portal execute the afterInit method after executing the init method for all services, by modifying the portalapp.xml deployment descriptor. For more information, see SAP note # 960199

If the service is defined as a startup service, this method is called during server startup after all other services have been initialized (that is, after the init methods of all other services have been called). If the service is not defined as a startup service, or is deployed after server startup, this method is executed immediately after the init method. NOTE: If the service is called during server startup, from within the init method of another service, the init and afterInit methods will be executed together, even if the service is defined as a startup service.

configure

void configure(IServiceConfiguration configuration)

Deprecated. Do not use anymore.

configure the service

Parameters:

configuration -

destroy

void destroy()

Called upon release of the service from the container.

release

void release()

Deprecated. use destroy instead.

release the service

getContext

IServiceContext getContext()

get the context of the service

getKey

String getKey()

return the key of the service

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] epbc.prtapi._apideprecated	default	EP-PIN-PRT
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/lib/api	api	EP-PIN