com.sap.netweaver.bc.uwl.admin

Interface IPropertiesManager

public interface IPropertiesManager

Nested Class Summary

static class

IPropertiesManager.SystemProperty Class that represents one entry for the System Configuration.

Method Summary

void	addListener(IConfigChangeListener listener) Method by which a listener can be set to poll for UWL systems registration events.
void	deactivateSystem(String connectorId, String systemAlias, String originalAlias) For backward compatibility with older registrations.
void	deleteConfiguration(String id, IWebflowConfigurationAdmin.R3System system, UWLContext context) Deletes the system configuration in the database
boolean	displaySupportInfo()
boolean	filterDuplicateAtt_Obj() Rare: Backend system may return duplicate attachments or objects id
Map	getConfigurations()
Properties	getDefaultProperties()
String	getIViewFolderPath()
String	getOriginalSystemAlias(IWebflowConfigurationAdmin.R3System system, String connector) returns system alias of already active connection for the given R3System and connector (For GABAP connector is GenericAbapConnector@FM)
List	getSystemAliases(String r3name, String r3client) Get all system aliases defined in the Portal System Landscape for a given R3 system and R3 client.
String	getSystemIdentifier() Get the system alias required by the CRM Object Link generation service
List	getSystemProperties(String connector, String system) returns the properties set for a particular system,connector combination.
String[]	getSystemsForConnector(IUser user, String configGroupName, String connector)
String[]	getSystemsInGroup(IUser user, String configGroupName)
String	getWebflowUserFormat() Get the webflow user format
boolean	hideInvalidBackendUserId() Backend system may return non-standard value as user id that cannot be mapped to portal user id
void	removeListener(IConfigChangeListener listener) Method by which a listener can be set to poll for UWL systems registration events.
void	setSystemAliasePerConnector(Hashtable newAliaseMap) Set the system aliase per connector HashMap in the cache
void	setSystemAliases(Hashtable tableOfSystemToAliasList) Set the system aliases HashMap in the cache
boolean	supportsOptimizedPull(String system, String connector) Check if optimized pull should be used for a given system and a connector
void	updateConfig(Properties xproperties, Map kmProperties) internal use - change for 640.
void	updateConfiguration(String id, Map properties, IWebflowConfigurationAdmin.R3System system, boolean activate, UWLContext context) Updates the configuration in the database

Method Detail

getConfigurations

Map getConfigurations()

getDefaultProperties

Properties getDefaultProperties()

Returns:

default properties for the UWL Service

See Also:

for generic UWL properties

updateConfiguration

void updateConfiguration(String id,
                         Map properties,
                         IWebflowConfigurationAdmin.R3System system,
                         boolean activate,
                         UWLContext context)
                         throws UWLException

Updates the configuration in the database

Parameters:

id - can be com.sap.netweaver.bc.uwl.admin.ConfigurationProperties.DEFAULT_UWL_ID for the UWL Service configuration or systemalias@connector (systemAlias@connector@ABAPClass for Generic ABAP connectors) for UWL system configuration

properties - a Map of properites to be updated for the UWL service configuration or for the system (@see com.sap.netweaver.bc.uwl.admin.ConfigurationProperties for the list of possible propery names)

system - R3system info for the updated system, encapsulating the R3 system id and the client for systems being registered for WebFlowConnector, AlertConnector and GenericABAPConnector, null otherwise

activate - true if this is activate/deactivate or add action, which requires updating of systemAliases in the Cache

context - the UWLContext of the updating client

Throws:

UWLException

See Also:

for supported properites

deleteConfiguration

void deleteConfiguration(String id,
                         IWebflowConfigurationAdmin.R3System system,
                         UWLContext context)
                         throws UWLException

Deletes the system configuration in the database

Parameters:

id - - systemalias@connector of the configuration to be deleted (For GABAP connector is GenericAbapConnector@FM)

system - R3system info for the deleted active system, null if the system was inactive or not relevant for the R3

context - the UWLContext of the updating client

Throws:

UWLException

updateConfig

void updateConfig(Properties xproperties,
                  Map kmProperties)
                  throws UWLException

internal use - change for 640. Updates the configuration DB upon receiving a KMConfigEvent

Parameters:

xproperties - - generic UWL properties; kmProperties - UWL systems

Throws:

UWLException

deactivateSystem

void deactivateSystem(String connectorId,
                      String systemAlias,
                      String originalAlias)
                      throws UWLException

For backward compatibility with older registrations. If the system was registered before there was a check for multiple system aliases pointing to the same backend system, then during start-up of the UWL service if this condition is detected, then all the system connections with duplicate system aliases will be de-activated.

Parameters:

connectorId - connector id of the system to be deactivated (For GABAP connectorId is GenericAbapConnector@FM)

systemAlias - system alias of the system to be deactivated

originalAlias - system alias of the system pointing to the same backend

Throws:

UWLException

getOriginalSystemAlias

String getOriginalSystemAlias(IWebflowConfigurationAdmin.R3System system,
                              String connector)

returns system alias of already active connection for the given R3System and connector (For GABAP connector is GenericAbapConnector@FM)

getSystemsInGroup

String[] getSystemsInGroup(IUser user,
                           String configGroupName)

Parameters:

user - - if not null check the roles for user, if null ignore user.

configGroupName - - if not null return systems, defined for the group; otherwise return all the systems

Returns:

array of Strings, containg system aliases

supportsOptimizedPull

boolean supportsOptimizedPull(String system,
                              String connector)

Check if optimized pull should be used for a given system and a connector

Parameters:

system - - system alias

connector - - connector id as defined in com.sap.netweaver.bc.uwl.connect.IProviderConnector; GenericAbapConnector should be passed as "GenericAbapConnector@MM_GET_ITEMS"

Returns:

true, if ConfigurationProperties.REFRESH_PERIOD is positive

getWebflowUserFormat

String getWebflowUserFormat()

Get the webflow user format

Returns:

one of the following: fullName|userId|empty

hideInvalidBackendUserId

boolean hideInvalidBackendUserId()

Backend system may return non-standard value as user id that cannot be mapped to portal user id

Returns:

Return true if the value should be hidden (eg. "USxx" and replaced by predefined value eg. "Workflow System", otherwise, return false, value "USxx" will not be replaced

filterDuplicateAtt_Obj

boolean filterDuplicateAtt_Obj()

Rare: Backend system may return duplicate attachments or objects id

Returns:

Return true if the value should be hidden (eg. "USxx" and replaced by predefined value eg. "Workflow System", otherwise, return false, value "USxx" will not be replaced

setSystemAliases

void setSystemAliases(Hashtable tableOfSystemToAliasList)

Set the system aliases HashMap in the cache

Parameters:

tableOfSystemToAliasList - - map of key=r3client+system to List of aliases.

setSystemAliasePerConnector

void setSystemAliasePerConnector(Hashtable newAliaseMap)

Set the system aliase per connector HashMap in the cache

Parameters:

newAliaseMap - - map of key=connector + r3client+system to the string of the active alias (For GABAP connector is GenericAbapConnector@FM)

getSystemIdentifier

String getSystemIdentifier()

Get the system alias required by the CRM Object Link generation service

Returns:

system alias

getSystemsForConnector

String[] getSystemsForConnector(IUser user,
                                String configGroupName,
                                String connector)

Parameters:

user - - if not null check the roles for user, if null ignore user.

configGroupName - - if not null return systems, defined for the group; otherwise return all the systems

connector - - connector could be id as defined in com.sap.netweaver.bc.uwl.connect.IProviderConnector, e.g., "WebFlowConnector","GenericAbapConnector" or "GenericAbapConnector@MM_GET_ITEMS"

getIViewFolderPath

String getIViewFolderPath()

Returns:

folder in the Portal Content, containing iview wrappers for the UWL launchers. Default is "portal_content/every_user/general/uwl/".

displaySupportInfo

boolean displaySupportInfo()

Returns:

boolean flag indicating if support information should be displayed for all UWL iViews

getSystemAliases

List getSystemAliases(String r3name,
                      String r3client)

Get all system aliases defined in the Portal System Landscape for a given R3 system and R3 client.

Parameters:

r3name -

r3client - - can be null, in which case all aliases defined for the system are returned

Returns:

List of system aliases

addListener

void addListener(IConfigChangeListener listener)

Method by which a listener can be set to poll for UWL systems registration events.

Parameters:

listener -

removeListener

void removeListener(IConfigChangeListener listener)

Method by which a listener can be set to poll for UWL systems registration events.

Parameters:

listener -

getSystemProperties

List getSystemProperties(String connector,
                         String system)

returns the properties set for a particular system,connector combination.

Parameters:

connector - -connector could be id as defined in com.sap.netweaver.bc.uwl.connect.IProviderConnector, e.g., "WebFlowConnector","GenericAbapConnector" or "GenericAbapConnector@MM_GET_ITEMS"; For all connectors except "GenericAbapConnector" only one entry will be returned

system -

Returns:

null if there is no entry for the connector and system specified, otherwise a List of SystemPropery objects