com.sap.ip.collaboration.core.api.fwk.portal

Class GenericService

java.lang.Object
  com.sap.ip.collaboration.core.api.fwk.portal.GenericService

All Implemented Interfaces:

com.sapportals.portal.prt.service.IService

Direct Known Subclasses:

AttachmentPortalService, CollaborationServiceImpl

public abstract class GenericService
extends Object
implements com.sapportals.portal.prt.service.IService

A Generic Service Implementation The following options are configurable via portalapps.xml

• generic_service_key - specify the name of the service
• generic_classloader_registration - (YES/NO) register the service ClassLoader in km-crt framework
• generic_so_registration - (YES/NO) register the semantic objects in KM Registry

To implement an GenericService, the programmer needs only to extend this class and provide implementation for the registerClassLoader() method.

The service key can be specified overriding the service_key attribute, in this case the service key specified in configuration is ignored. At least one of the service key must be present otherwise a ServiceException is thrown.

This is an example of the service profile that needs to be present in portalapps.xml

Field Summary

protected String	applKey
protected boolean	registerClassloader
protected boolean	registerSemanticObjects
protected String	service_key

Constructor Summary

GenericService()
Constructor for GenericService.

Method Summary

void	afterInit()
void	configure(com.sapportals.portal.prt.service.IServiceConfiguration arg0)
void	destroy()
com.sapportals.portal.prt.service.IServiceContext	getContext()
String	getKey()
void	init(com.sapportals.portal.prt.service.IServiceContext ctxt)
ClassLoader	registerClassLoader()
void	release()

Methods inherited from class java.lang.Object

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

Field Detail

service_key

protected String service_key

registerClassloader

protected boolean registerClassloader

registerSemanticObjects

protected boolean registerSemanticObjects

applKey

protected String applKey

Constructor Detail

GenericService

public GenericService()

Constructor for GenericService.

Method Detail

init

public void init(com.sapportals.portal.prt.service.IServiceContext ctxt)

Specified by:

init in interface com.sapportals.portal.prt.service.IService

registerClassLoader

public ClassLoader registerClassLoader()

configure

public void configure(com.sapportals.portal.prt.service.IServiceConfiguration arg0)

Specified by:

configure in interface com.sapportals.portal.prt.service.IService

destroy

public void destroy()

Specified by:

destroy in interface com.sapportals.portal.prt.service.IService

getContext

public com.sapportals.portal.prt.service.IServiceContext getContext()

Specified by:

getContext in interface com.sapportals.portal.prt.service.IService

getKey

public String getKey()

Specified by:

getKey in interface com.sapportals.portal.prt.service.IService

release

public void release()

Specified by:

release in interface com.sapportals.portal.prt.service.IService

afterInit

public void afterInit()

Specified by:

afterInit in interface com.sapportals.portal.prt.service.IService

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-COLL	[sap.com] tc/kmc/coll/util	api	EP-KM-COL