com.sap.netweaver.bc.uwl.connect

Interface IPullChannel

public interface IPullChannel

Interface that represents a pull channel for optimized pull mechanism. Provider connector has access to this interface if it had implemented IOptimizedPullSupportinterface.
IPullChannel is implemented by UWL service and the implementation is internal to UWL service.
One channel represents a logical connection to one system and one provider combination for predefined number of users. Life of a pull channel begins when a first user is added and ends when the last users is removed from the channel.

See Also:

IOptimizedPullSupport, IProviderConnector, IPullChannelListener

Method Summary

String[]	getAccumulatedExceptions() Method to monitor the logged messages in the channel.
IProviderConnector	getConnector() Returns the connector to be used for connecting to the system.
Date	getCreationTime() Returns the UWL time when the pull channel was created.
String	getId() Returns the identifier for the channel.
Date	getLastSystemSynchronizationTime() Provider Connector optionally may set the time at the system, while returning the delta result.
Date	getLastUwlSynchronizationTime() Specifies the time when last synchronization was done.
int	getRefreshIntervalInSeconds() Returns the refresh interval for this Pull Channel.
String	getSystem() Returns the System this channel is supposed to connect to
Set	getUserIds() Method to get all users ids in this channel.
UserInfo	getUserInfo(String userId) Returns the users information.
List	getUserInfos() Returns a list of UserInfo objects that are assigned to the channel.

Method Detail

getUserInfos

List getUserInfos()

Returns a list of UserInfo objects that are assigned to the channel. The list returned is read only and shouldn't be manipulated by the caller.

Returns:

getUserInfo

UserInfo getUserInfo(String userId)

Returns the users information.

Parameters:

userId - not null

Returns:

null if user not found

getId

String getId()

Returns the identifier for the channel. This is for internal purposes only.

Returns:

not null

getSystem

String getSystem()

Returns the System this channel is supposed to connect to

Returns:

not null

getConnector

IProviderConnector getConnector()

Returns the connector to be used for connecting to the system.

Returns:

not null

getLastUwlSynchronizationTime

Date getLastUwlSynchronizationTime()

Specifies the time when last synchronization was done. This time is w.r.t to UWL and not the item's systems time.

Returns:

could be null

getLastSystemSynchronizationTime

Date getLastSystemSynchronizationTime()

Provider Connector optionally may set the time at the system, while returning the delta result. In such cases, it is stored in uwl and passed back the next time getItems() is called.

Returns:

could be null if not yet set.

See Also:

ConnectorResult.setSystemTimestamp(java.util.Date)

getUserIds

Set getUserIds()

Method to get all users ids in this channel.

Returns:

distinct portal user ids

getAccumulatedExceptions

String[] getAccumulatedExceptions()

Method to monitor the logged messages in the channel.

Returns:

contains Strings of warning/errors that occured in the channel. Typically only last 10 errors are stored.

getCreationTime

Date getCreationTime()

Returns the UWL time when the pull channel was created. This is used only for monitoring purposes.

Returns:

not null

getRefreshIntervalInSeconds

int getRefreshIntervalInSeconds()

Returns the refresh interval for this Pull Channel. return value is in minutes. It is always > 0. This is the time gap between completion of one pull and beginning of another pull.

Returns:

refresh interval in seconds.