org.sakaiproject.calendaring.logic

Interface SakaiProxy

public interface SakaiProxy

An interface to abstract all Sakai related API calls. This does not form part of the public API for the ExternalCalendaringService.

Author:

Steve Swinsburg (steve.swinsburg@gmail.com)

Method Summary

Modifier and Type	Method and Description
String	getCalendarFilePath() Get the configured calendar file path on the server.
String	getCurrentUserId() Get current user id
String	getServerName() Get the name of the server
String	getUserDisplayName(String uuid) Get the display name for this user
String	getUserEmail(String uuid) Get the email address for this user
boolean	isCleanupEnabled() Is cleanup enabled?
boolean	isIcsEnabled() Is the ICS service enabled?
boolean	isSuperUser() Is the current user a superUser?

Method Detail

getCurrentUserId

String getCurrentUserId()

Get current user id

Returns:

isSuperUser

boolean isSuperUser()

Is the current user a superUser? (anyone in admin realm)

Returns:

getServerName

String getServerName()

Get the name of the server

Returns:

getCalendarFilePath

String getCalendarFilePath()

Get the configured calendar file path on the server. This is where the ICS files are created. Defaults to java.io.tmpdir if not provided

Returns:

getUserEmail

String getUserEmail(String uuid)

Get the email address for this user

Parameters:

uuid -

Returns:

getUserDisplayName

String getUserDisplayName(String uuid)

Get the display name for this user

Parameters:

uuid -

Returns:

isIcsEnabled

boolean isIcsEnabled()

Is the ICS service enabled? If not, all operations will be no-ops. Defaults to true.

Returns:

isCleanupEnabled

boolean isCleanupEnabled()

Is cleanup enabled? If so, generated files will be cleaned up (deleted via File.deleteOnExit()) when the JVM exits. Once a file has been generated and used it is no longer needed nor used again, so this defaults to true.

Returns: