| com.sun.portal.app.calendarcommon.calendar.SharedCalendarUtils
All known Subclasses: com.sun.portal.app.calendarcommon.calendar.SharedCalendarUtilsImpl, com.sun.portal.app.calendarcommon.calendar.DummySharedCalendarUtilsImpl,
| SharedCalendarUtils | | public interface SharedCalendarUtils (Code) | | Utility methods relevant to the Shared Calendar services.
author:
Nigel Jacobs |
| Method Summary | |
| public boolean | createEventsInMembersCalendar(FacesContext context)
Should events be created in the member's community calendar,
or solely in the proxy community calendar (defined in SSO adapter config param).
Parameters:
The - faces context. | | public boolean | createEventsInMembersCalendar(PortletRequest portletRequest)
Should events be created in the member's community calendar,
or solely in the proxy community calendar (defined in SSO adapter config param).
Parameters:
The - portlet request. | | public void | deleteItemFromSearchDatabase(FacesContext context, int appType, String itemID)
Delete a resource description for the calendar item from the search database. | | public void | deleteProxyCalendarStore(String communityID, Properties configurationProperties)
| | public void | destroy()
Perform any clean up operations: close connections and release resources. | | public String | getCommunityCalendarID(PortletRequest portletRequest)
Compute the community proxy users calendar id for this community.
e.g. | | public String | getCommunityCalendarID(FacesContext context)
Compute the community proxy users calendar id for this community.
e.g. | | public Properties | getConfigProperties(Map preferences, HttpServletRequest servletRequest)
Get the Shared Calendar configuration properties for this portlet. | | public DelegatedAdministratorHandler | getDAHandler(String communityID, Properties configProps)
Find of create a DelegatedAdministratorHandler for the community.
Parameters:
communityID - The community ID.
Parameters:
configProps - The SSO adapter configuration properties for the community. | | public String | getMemberCalendarID(PortletRequest portletRequest, String memberID)
Compute the community member's universal calendar id (common across communities). | | public String | getMemberCalendarID(FacesContext context, String memberID)
Compute the community member's universal calendar id (common across communities). | | public CalendarStore | getMemberCalendarStore(PortletRequest portletRequest, String memberID)
Get the user id, and configuration via the request. | | public CalendarStore | getMemberCalendarStore(FacesContext context, String memberID)
Get the user id, and configuration via the request. | | public CalendarStore | getMemberCalendarStore(HttpServletRequest servletRequest, Map preferences, String communityID, String memberID)
Get the user id, and configuration via the request. | | public CalendarStore | getProxyCalendarStore(PortletRequest portletRequest)
Get the community id, and the configuration via the request. | | public CalendarStore | getProxyCalendarStore(FacesContext context)
Get the community id, and the configuration via the request. | | public CalendarStore | getProxyCalendarStore(PortletProvisionPreferences preferences, HttpServletRequest servletRequest, String communityID)
Get the community id, and the configuration via the request. | | public String | getProxyUser(String communityID)
Compute the proxy user uid from the communityID
e.g. | | public SearchDatabase | getSearchDatabase(FacesContext context)
Connect to a search database for the community. | | public void | insertItemIntoSearchDatabase(FacesContext context, int appType, String memberID, String itemID, String title, String description, String displayURL)
Insert a resource description for the calendar item into the search database. |
| APP_TYPE_SHAREDEVENTS | | final public static int APP_TYPE_SHAREDEVENTS(Code) | | |
| APP_TYPE_SHAREDTASKS | | final public static int APP_TYPE_SHAREDTASKS(Code) | | |
| CAL_STORE_CACHE_CONTEXT_ATTR | | final public static String CAL_STORE_CACHE_CONTEXT_ATTR(Code) | | |
| CAL_STORE_CACHE_SESSION_ATTR | | final public static String CAL_STORE_CACHE_SESSION_ATTR(Code) | | |
| CONFIG_CACHE_CONTEXT_ATTR | | final public static String CONFIG_CACHE_CONTEXT_ATTR(Code) | | |
| CONFIG_PROP_autoDeleteProxyUserCal | | final public static String CONFIG_PROP_autoDeleteProxyUserCal(Code) | | |
| CONFIG_PROP_calHost | | final public static String CONFIG_PROP_calHost(Code) | | |
| CONFIG_PROP_calPort | | final public static String CONFIG_PROP_calPort(Code) | | |
| CONFIG_PROP_calProxyPassword | | final public static String CONFIG_PROP_calProxyPassword(Code) | | |
| CONFIG_PROP_calProxyUid | | final public static String CONFIG_PROP_calProxyUid(Code) | | |
| CONFIG_PROP_configDesc | | final public static String CONFIG_PROP_configDesc(Code) | | |
| CONFIG_PROP_createEventsInMembersCal | | final public static String CONFIG_PROP_createEventsInMembersCal(Code) | | |
| CONFIG_PROP_daDomain | | final public static String CONFIG_PROP_daDomain(Code) | | |
| CONFIG_PROP_daHost | | final public static String CONFIG_PROP_daHost(Code) | | |
| CONFIG_PROP_daPort | | final public static String CONFIG_PROP_daPort(Code) | | |
| CONFIG_PROP_daProxyPassword | | final public static String CONFIG_PROP_daProxyPassword(Code) | | |
| CONFIG_PROP_daProxyUid | | final public static String CONFIG_PROP_daProxyUid(Code) | | |
| CONFIG_PROP_isHostedDomain | | final public static String CONFIG_PROP_isHostedDomain(Code) | | |
| CONFIG_PROP_ssoClassName | | final public static String CONFIG_PROP_ssoClassName(Code) | | |
| CTY_CAL_PREFIX | | final public static String CTY_CAL_PREFIX(Code) | | |
| MBR_CAL_DOMAIN_CACHE_CONTEXT_ATTR | | final public static String MBR_CAL_DOMAIN_CACHE_CONTEXT_ATTR(Code) | | |
| SEARCH_DB_PREF | | final public static String SEARCH_DB_PREF(Code) | | The portlet preference that inidicates the name of the search database.
|
| SEARCH_SERVER_URL_PREF | | final public static String SEARCH_SERVER_URL_PREF(Code) | | The portlet preference that inidicates the URL of the search server.
|
| SHARED_CAL_CONFIG_ATTR | | final public static String SHARED_CAL_CONFIG_ATTR(Code) | | The name of the attribute used to store the shared calendar config name in the PortletPreferences and ServletContext.
|
| SHARED_CAL_CONFIG_DEFAULT | | final public static String SHARED_CAL_CONFIG_DEFAULT(Code) | | The default shared calendar config name.
|
| SHARED_CAL_UTILS_CONTEXT_ATTR | | final public static String SHARED_CAL_UTILS_CONTEXT_ATTR(Code) | | The name of the ServletContext attribute used to store the SharedCalendarUtils singleton.
|
| createEventsInMembersCalendar | | public boolean createEventsInMembersCalendar(FacesContext context) throws SharedServicesException(Code) | | Should events be created in the member's community calendar,
or solely in the proxy community calendar (defined in SSO adapter config param).
Parameters:
The - faces context. Whether to create events in members community calendar |
| createEventsInMembersCalendar | | public boolean createEventsInMembersCalendar(PortletRequest portletRequest) throws SharedServicesException(Code) | | Should events be created in the member's community calendar,
or solely in the proxy community calendar (defined in SSO adapter config param).
Parameters:
The - portlet request. Whether to create events in members community calendar |
| deleteItemFromSearchDatabase | | public void deleteItemFromSearchDatabase(FacesContext context, int appType, String itemID) throws SharedServicesException(Code) | | Delete a resource description for the calendar item from the search database.
Parameters:
appType - APP_TYPE_SHAREDEVENTS or APP_TYPE_SHAREDTASKS
Parameters:
itemID - The ID of the event or task |
| destroy | | public void destroy()(Code) | | Perform any clean up operations: close connections and release resources.
|
| getCommunityCalendarID | | public String getCommunityCalendarID(PortletRequest portletRequest) throws SharedServicesException(Code) | | Compute the community proxy users calendar id for this community.
e.g. "Friends" => "CTY_CAL_Friends"
Parameters:
portletRequest - Used to retrieve the community id. Community proxys calendar id |
| getCommunityCalendarID | | public String getCommunityCalendarID(FacesContext context) throws SharedServicesException(Code) | | Compute the community proxy users calendar id for this community.
e.g. "Friends" => "CTY_CAL_Friends"
Parameters:
portletRequest - Used to retrieve the community id. Community proxys calendar id |
| getConfigProperties | | public Properties getConfigProperties(Map preferences, HttpServletRequest servletRequest) throws SharedServicesException(Code) | | Get the Shared Calendar configuration properties for this portlet.
Use the config name stored in the portlet prefs to look up the sso adapter config,
and return contained properties.
Parameters:
preferences - A read-only map of portlet prefs (PortletPreferences or PortletProvisionPreferences)
Parameters:
servletRequest - |
| getDAHandler | | public DelegatedAdministratorHandler getDAHandler(String communityID, Properties configProps)(Code) | | Find of create a DelegatedAdministratorHandler for the community.
Parameters:
communityID - The community ID.
Parameters:
configProps - The SSO adapter configuration properties for the community. The DelegatedAdministratorHandler for the community. |
| getMemberCalendarID | | public String getMemberCalendarID(PortletRequest portletRequest, String memberID) throws SharedServicesException(Code) | | Compute the community member's universal calendar id (common across communities). Uses
the cached organization param, retrieve from the portlet request.
e.g. "joe" in organization "sun.com" => CTY_CAL_joe@sun.com
Parameters:
portletRequest -
Parameters:
memberID - |
| getMemberCalendarID | | public String getMemberCalendarID(FacesContext context, String memberID) throws SharedServicesException(Code) | | Compute the community member's universal calendar id (common across communities). Uses
the cached organization param, retrieve from the portlet request.
e.g. "joe" in organization "sun.com" => CTY_CAL_joe@sun.com
Parameters:
portletRequest -
Parameters:
memberID - |
| getMemberCalendarStore | | public CalendarStore getMemberCalendarStore(PortletRequest portletRequest, String memberID) throws SharedServicesException(Code) | | Get the user id, and configuration via the request.
Generate the calendar id from the user id.
If the calendar store is cached (indexed by calendar id), return it.
Otherwise connect to calendar server, get the users calendar store, and create the calendar with id,
setting default permissions, but allowing the proxy user update access.
Cache and return the store
Parameters:
portletRequest -
Parameters:
memberID - |
| getMemberCalendarStore | | public CalendarStore getMemberCalendarStore(FacesContext context, String memberID) throws SharedServicesException(Code) | | Get the user id, and configuration via the request.
Generate the calendar id from the user id.
If the calendar store is cached (indexed by calendar id), return it.
Otherwise connect to calendar server, get the users calendar store, and create the calendar with id,
setting default permissions, but allowing the proxy user update access.
Cache and return the store
Parameters:
portletRequest -
Parameters:
memberID - |
| getMemberCalendarStore | | public CalendarStore getMemberCalendarStore(HttpServletRequest servletRequest, Map preferences, String communityID, String memberID) throws SharedServicesException(Code) | | Get the user id, and configuration via the request.
Generate the calendar id from the user id.
If the calendar store is cached (indexed by calendar id), return it.
Otherwise connect to calendar server, get the users calendar store, and create the calendar with id,
setting default permissions, but allowing the proxy user update access.
Cache and return the store
Parameters:
servletRequest -
Parameters:
preferences - The PortletPreferences / PortletProvisionPreferences map.
Parameters:
communityID -
Parameters:
memberID - calendar store |
| getProxyCalendarStore | | public CalendarStore getProxyCalendarStore(PortletRequest portletRequest) throws SharedServicesException(Code) | | Get the community id, and the configuration via the request.
Generate the calendar id from the community id.
If the calendar store is cached (indexed by calendar id), return it.
Otherwise connect to calendar server, get the proxys calendar store, and create the calendar with id
Cache and return the store.
Parameters:
portletRequest - |
| getProxyCalendarStore | | public CalendarStore getProxyCalendarStore(FacesContext context) throws SharedServicesException(Code) | | Get the community id, and the configuration via the request.
Generate the calendar id from the community id.
If the calendar store is cached (indexed by calendar id), return it.
Otherwise connect to calendar server, get the proxys calendar store, and create the calendar with id
Cache and return the store.
Parameters:
portletRequest - |
| getProxyCalendarStore | | public CalendarStore getProxyCalendarStore(PortletProvisionPreferences preferences, HttpServletRequest servletRequest, String communityID) throws SharedServicesException(Code) | | Get the community id, and the configuration via the request.
Generate the calendar id from the community id.
If the calendar store is cached (indexed by calendar id), return it.
Otherwise connect to calendar server, get the proxys calendar store, and create the calendar with id
Cache and return the store.
Parameters:
portletRequest - |
| getProxyUser | | public String getProxyUser(String communityID)(Code) | | Compute the proxy user uid from the communityID
e.g. "Friends" => "CTY_CAL_PRX_JTO__Friends"
|
| insertItemIntoSearchDatabase | | public void insertItemIntoSearchDatabase(FacesContext context, int appType, String memberID, String itemID, String title, String description, String displayURL) throws SharedServicesException(Code) | | Insert a resource description for the calendar item into the search database.
Parameters:
FacesContext - The faces context.
Parameters:
appType - APP_TYPE_SHAREDEVENTS or APP_TYPE_SHAREDTASKS
Parameters:
memberID - The id of the community member
Parameters:
itemID - The ID of the event or task
Parameters:
title - The title of the event (summary)
Parameters:
description - The one line description of the item
Parameters:
displayURL - The url that when selected will display the item. |
|
|