com.sap.netweaver.kmc.expimp

Interface IExportImportService

All Known Subinterfaces:

IPrivateExportImportService

public interface IExportImportService

KM global service providing export/import functionality for KM content.

NOTE: This interface should be used by applications that need this functionality. It must NOT be implemented by other applications.

KM content that can be exported comprises:

• Resource content
• Resource properties (standard and custom)
• Resource ACLs

The workflow looks as follows:

• Export: KM content is exported from KM repositories to KMC content modules (files with extension .kmc)
• Transport: KMC content modules are transported to the target system (either manually or by means of CTS)
• Import: KM content contained in KMC content modules is imported to KM repositories of target system

Copyright 2007 SAP AG

Field Summary

static String

KEY identifier that can be used to lookup this KM global service

Method Summary

IExportPackage	createExportPackage(String name, IResourceContext ctx) Creates a new export package.
IImportPackage	createImportPackage(File file, IResourceContext ctx) Creates a new import package.
void	retransmitExport(IExportPackage ep, IResourceContext ctx, boolean async) Retransmits the already exported package ep to OTO/CTS server.
void	startExport(IExportPackage ep, IResourceContext ctx, boolean async) Exports the package ep to the filesystem.
void	startImport(IImportPackage ip, IImportPackage.ImportMode mode, IResourceContext ctx, boolean async) Imports the package ip from the filesystem.

Field Detail

KEY

static final String KEY

identifier that can be used to lookup this KM global service

See Also:

Constant Field Values

Method Detail

createExportPackage

IExportPackage createExportPackage(String name,
                                   IResourceContext ctx)

Creates a new export package.

Parameters:

name - the name of the package

ctx - the resource context for authorization

Returns:

the newly created export package

createImportPackage

IImportPackage createImportPackage(File file,
                                   IResourceContext ctx)

Creates a new import package.

Parameters:

file - the file representing the import package

ctx - the resource context for authorization

Returns:

the newly created import package

startExport

void startExport(IExportPackage ep,
                 IResourceContext ctx,
                 boolean async)
                 throws TransportException

Exports the package ep to the filesystem.

Parameters:

ep - the transport package to be exported

ctx - the resource context for authorization

async - true if the export should be processed asynchronously in another thread, false otherwise

Throws:

TransportException - on error

retransmitExport

void retransmitExport(IExportPackage ep,
                      IResourceContext ctx,
                      boolean async)
                      throws TransportException

Retransmits the already exported package ep to OTO/CTS server.

Parameters:

ep - the transport package to be retransmitted

ctx - the resource context for authorization

async - true if the retransmit should be processed asynchronously in another thread, false otherwise

Throws:

TransportException - on error

startImport

void startImport(IImportPackage ip,
                 IImportPackage.ImportMode mode,
                 IResourceContext ctx,
                 boolean async)
                 throws TransportException

Imports the package ip from the filesystem.

Parameters:

ip - the transport package to be imported

mode - the import mode specifying how to deal with collisions

ctx - the resource context for authorization

async - true if the export should be processed asynchronously in another thread, false otherwise

Throws:

TransportException - on error

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