com.sap.netweaver.bc.uwl.admin

Interface IUWLAdmin

public interface IUWLAdmin

This interface contains all relevant methods for doing housekeeping work with the UWL system. This is functionally is for administration UI only.

See Also:

IUWLService.getAdmin(com.sap.netweaver.bc.uwl.UWLContext)

Method Summary

void	cleanupExpiredItems(String system, Date pushedBeforeThisDate) Removes all expired items from the cache for the sytem specified.
void	clearCache(String system) Use with care, clears all the cache items.
int	getNumberOfPendingJobs(UWLContext context) For internal purpose only.
int	getNumberOfWorkerThreads(UWLContext context) For internal purpose only.
List	getRunningPullChannels(UWLContext context) Note: Strictly for internal usage and administration purpose only.
List	getSystemsAndPercentageSuccess(UWLContext context) Returns a list of SystemStatistics objects
String[]	getSystemsWithItemsInCache() Returns distinct sytem aliases which have items in UWL cache.
int	getTotalNumberOfActiveUsers(UWLContext context) Note: Strictly for internal usage and administration purpose only.
long	getTotalProcessedJobs(UWLContext context) For internal monitoring purpose only.
String	getUserEditorType() Value to be customized by the user on the Admin page.
String	getUwlIviewsPath() This can be customized by the user.

Method Detail

cleanupExpiredItems

public void cleanupExpiredItems(String system,
                                Date pushedBeforeThisDate)
                         throws UWLException

Removes all expired items from the cache for the sytem specified.

Parameters:

system - if null for all systems

pushedBeforeThisDate - if null todays date is used

Throws:

UWLException

clearCache

public void clearCache(String system)
                throws UWLException

Use with care, clears all the cache items.

Parameters:

system - if null for all systems

Throws:

UWLException

getSystemsWithItemsInCache

public String[] getSystemsWithItemsInCache()
                                    throws UWLException

Returns distinct sytem aliases which have items in UWL cache.

Returns:

returns all the sytem names which have items in the cache

Throws:

UWLException

getRunningPullChannels

public List getRunningPullChannels(UWLContext context)
                            throws UWLException

Note: Strictly for internal usage and administration purpose only.

Returns:

non null list of currently running pull channels.

Throws:

UWLException

getSystemsAndPercentageSuccess

public List getSystemsAndPercentageSuccess(UWLContext context)
                                    throws UWLException

Returns a list of SystemStatistics objects

Parameters:

context -

Returns:

not null list of systemAlias and percentage of times system getItems() succeeded. Failures include timeout, bad userid/pwd or system being down or some exceptions

Throws:

UWLException

getTotalNumberOfActiveUsers

public int getTotalNumberOfActiveUsers(UWLContext context)
                                throws UWLException

Note: Strictly for internal usage and administration purpose only.

Returns:

total number of users who have session with UWL.

Throws:

UWLException - in case of system problems

getNumberOfWorkerThreads

public int getNumberOfWorkerThreads(UWLContext context)
                             throws UWLException

For internal purpose only. Returns number of available Worker threads UWL has created.

Parameters:

context -

Returns:

-1 if not available

Throws:

UWLException

getNumberOfPendingJobs

public int getNumberOfPendingJobs(UWLContext context)
                           throws UWLException

For internal purpose only. Returns number of pending jobs waiting to be done by Worker threads

Parameters:

context -

Returns:

-1 if not available

Throws:

UWLException

getTotalProcessedJobs

public long getTotalProcessedJobs(UWLContext context)
                           throws UWLException

For internal monitoring purpose only. Returns total number of jobs processed by UWL worker threads altogether.

Parameters:

context -

Returns:

-1 if not available

Throws:

UWLException

getUwlIviewsPath

public String getUwlIviewsPath()

This can be customized by the user. All UWL iViews must be located under the same path Default path: "portal_content/every_user/general/uwl/"

Returns:

portal content path where the UWL iViews are located outside of the pct

getUserEditorType

public String getUserEditorType()

Value to be customized by the user on the Admin page. It indicates which Editor to use, either text or a more advanced HTML. Default is "HTML".

Returns:

User Editor type (text or HTML) for comments.