com.sap.netweaver.bc.uwl.connect

Interface IAttributeAccessConnector

All Known Subinterfaces:

IAttributeRetrievalConnector

public interface IAttributeAccessConnector

This interface defines retrieving custom attributes for an item. The IAttributeAccessConnector interface should be implemented by all the Custom attribute connectors. This interface defines methods to retreive Attributes from different systems. Attributes names and the connector are specified in the Universal Worklist configuration (also known as Configuration XML).

IAttributeAccessConnector implementations can use any communication mechanism to connect to the systems and reteive the Items. For example: EJB call, JCO, Web Service etc

IAttributeAccessConnector implementations are expected to be stateless and hence thread safe.

Custom IAttributeAccessConnector implementation should be registered to IUWLService.
UWL ships four attribute access connectors by default. They are

1. UM : For retrieving Users attributes like firstName, LastName etc.
3. ABAP_BOR : For retrieving attributes from ABAP BOR repositoty.
5. WEBFLOW_CONTAINER : For retrieving attributes from work item container for Business Workflow items.
7. ALERT_CONTAINER : For retrieving attributes from Alerts container for alert items.

See Also:

Item, CustomAttributes, Attribute, IUWLService.registerAttributeConnector(java.lang.String, com.sap.netweaver.bc.uwl.connect.IAttributeAccessConnector)

Field Summary

static String	ABAP_ATTRIBUTE_CONNECTOR Constant for ABAP Business Object Repository attribute connectors Identifier.
static String	ALRTCONTAINER_ATTRIBUTE_CONNECTOR Constant for Alert Systems Container's attribute connectors Identifier.
static String	UM_ATTRIBUTE_CONNECTOR Constant for User Management attribute connector's Identifier.
static String	WFCONTAINER_ATTRIBUTE_CONNECTOR Constant for Business Workflow Container attribute connectors Identifier.

Method Summary

Map	getAttributes(UWLContext context, Item item, String objectType, String objectid, AttributeCollection attributes) Gets values of attributes of the item specified in the parameter attributeNames.
String	getId() Every IAttributeAccessConnectorshould identify itself with a unique identifer.

Field Detail

UM_ATTRIBUTE_CONNECTOR

static final String UM_ATTRIBUTE_CONNECTOR

Constant for User Management attribute connector's Identifier. This implementation can retreive user related attributes such as name, telephone etc..

See Also:

Constant Field Values

ABAP_ATTRIBUTE_CONNECTOR

static final String ABAP_ATTRIBUTE_CONNECTOR

Constant for ABAP Business Object Repository attribute connectors Identifier.

See Also:

Constant Field Values

WFCONTAINER_ATTRIBUTE_CONNECTOR

static final String WFCONTAINER_ATTRIBUTE_CONNECTOR

Constant for Business Workflow Container attribute connectors Identifier.

See Also:

Constant Field Values

ALRTCONTAINER_ATTRIBUTE_CONNECTOR

static final String ALRTCONTAINER_ATTRIBUTE_CONNECTOR

Constant for Alert Systems Container's attribute connectors Identifier.

See Also:

Constant Field Values

Method Detail

getId

String getId()

Every IAttributeAccessConnectorshould identify itself with a unique identifer. Id is case sensitive.

Returns:

not null identifier

See Also:

CustomAttributes.getSource()

getAttributes

Map getAttributes(UWLContext context,
                  Item item,
                  String objectType,
                  String objectid,
                  AttributeCollection attributes)
                  throws ConnectorException

Gets values of attributes of the item specified in the parameter attributeNames.

Parameters:

context - contains user, application context, portal request information

item - not null, item for which attributes are needed

objectType - Empty or null if attributes are not associated with a custom object

objectid - Empty or null if attributes are not associated with a custom object

attributes - not null, contains names of custom attributes, their types etc. For the types fo attributes refer to com.sap.netweaver.bc.uwl.config.DTDConstants javadoc

Returns:

Map of key as attribute name, and value com.sap.netweaver.bc.uwl.Attribute

Throws:

ConnectorException - in case of problems from the provider source

See Also:

DTDConstants

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] UWLJWF	[sap.com] tc/kmc/bc.uwl/api	default	EP-BC-UWL
[sap.com] UWLJWF	[sap.com] tc/kmc/bc.uwl/api	-	EP-BC-UWL