org.exoplatform.moxtra.calendar

Class MoxtraCalendarApplication

java.lang.Object

org.exoplatform.moxtra.calendar.MoxtraCalendarApplication

All Implemented Interfaces:

org.exoplatform.moxtra.webui.MoxtraApplication

public class MoxtraCalendarApplication
extends Object
implements org.exoplatform.moxtra.webui.MoxtraApplication

Application a bridge between WebUI UIApplication associated with calendar event creation or update and Moxtra service. This app instance exists together with the UI app (portlet) and has the same life span.
Created by The eXo Platform SAS

Version:

$Id: MoxtraCalendarApplication.java 00000 Mar 11, 2015 pnedonosko $

Author:

Peter Nedonosko

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	COLON
protected Map<String,SoftReference<org.exoplatform.moxtra.client.MoxtraMeet>>	eventMeets Deprecated.
static org.exoplatform.services.log.Log	LOG
protected Map<org.exoplatform.webui.core.UIComponent,org.exoplatform.moxtra.client.MoxtraMeet>	meets Meets associated with components in the app. Components (forms) are stateful in general (like event form or calendar views).
protected Set<org.exoplatform.webui.config.Component>	mergedConfigs
protected MoxtraCalendarService	moxtra Associated MoxtraCalendarService.
static String	QUICK_ADD_EVENT_FORM_ID
static String	QUICK_ADD_EVENT_POPUP_ID
static String	QUICK_ADD_TASK_FORM_ID
static String	QUICK_ADD_TASK_POPUP_ID
protected ThreadLocal<org.exoplatform.webui.form.UIForm>	requestForm Associated form.
protected ThreadLocal<org.exoplatform.webui.core.UIContainer>	requestViewContainer Associated UICalendarViewContainer.
protected ThreadLocal<org.exoplatform.webui.core.UIApplication>	uiApp Associated WebUI app.

Fields inherited from interface org.exoplatform.moxtra.webui.MoxtraApplication

USER_INIT_SCRIPT

Constructor Summary

Constructors

Constructor and Description
MoxtraCalendarApplication() Empty constructor mandatory!

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(org.exoplatform.webui.core.UIApplication uiApp) Associate with WebUI application and patch the UI app if required.
void	activateForm(org.exoplatform.webui.form.UIForm form) Deprecated.
void	deactivate(org.exoplatform.webui.core.UIApplication uiApp)
org.exoplatform.moxtra.client.MoxtraMeet	disableMeet()
org.exoplatform.moxtra.client.MoxtraMeet	enableMeet()
protected <T extends org.exoplatform.webui.core.UIComponent> T	findChildBySuperType(org.exoplatform.webui.core.UIContainer container, String superTypeName) Find UI component child in given container by its super type name.
protected <T extends org.exoplatform.webui.core.UIComponent> List<T>	findChildsByInterface(org.exoplatform.webui.core.UIContainer container, String interfaceName, boolean deep) Find UI component children in given container by an interface name.
protected <T extends org.exoplatform.webui.core.UIComponent> List<T>	findChildsBySuperType(org.exoplatform.webui.core.UIContainer container, String superTypeName, boolean deep) Find UI component children in given container by a super type name.
protected <T extends org.exoplatform.webui.core.UIComponent> T	findComponent(org.exoplatform.webui.core.UIContainer container, String typeName) Find UI component in given container by its type name or ID if it equals to the given name.
protected org.exoplatform.moxtra.client.MoxtraMeet	findFormMeet(org.exoplatform.webui.form.UIForm form) Find existing meet enabled for even shown in given form.
protected <T extends org.exoplatform.webui.core.UIComponent> T	findRenderedChildByInterface(org.exoplatform.webui.core.UIContainer container, String interfaceName) Find first rendered UI component in children of given container by an interface name.
protected <T extends org.exoplatform.webui.core.UIComponent> T	findRenderedChildBySuperType(org.exoplatform.webui.core.UIContainer container, String superTypeName) Find first rendered UI component in children of given container by a super type name.
protected org.exoplatform.webui.form.UIForm	form()
String	getAuthorizationLink()
org.exoplatform.calendar.service.CalendarSetting	getCalendarSetting() Current user calendar settings.
protected String	getCalendarType() Get current calendar type in UIEventForm.
protected String	getEventCalendarId() Hardcoded version of UIEventForm.getCalendarId().
protected Set<String>	getEventIds() Event ids associated with current context (updated or deleted in the request).
protected org.exoplatform.moxtra.client.MoxtraMeet	getEventMeet(String eventId) Deprecated.
org.exoplatform.moxtra.client.MoxtraMeet	getMeet() Return Moxtra meet associated with this app.
protected String	getQuickAddCalendarId(org.exoplatform.webui.form.UIForm quickAddForm) Deprecated.
org.exoplatform.moxtra.client.MoxtraUser	getUser() Current Moxtra user.
List<org.exoplatform.moxtra.client.MoxtraUser>	getUserContacts() Current user contacts in Moxtra.
boolean	hasMeet() Check if Moxtra meet has been associated with this app.
void	init()
protected void	initContext(org.exoplatform.webui.form.UIForm form) Initialize this app context.
protected void	initEventForm(org.exoplatform.webui.form.UIForm form)
void	initEventFormContainer(org.exoplatform.webui.core.UIContainer formContainer)
protected void	initEventMeet(org.exoplatform.webui.form.UIForm form) Init meet as for UIEventForm.
protected void	initQuickAddForm(org.exoplatform.webui.form.UIForm form) Deprecated.
protected void	initQuickAddMeet() Init meet for quick-add form requests.
protected void	initViewForm(org.exoplatform.webui.form.UIForm form)
boolean	isActivated()
boolean	isAuthorized()
boolean	isInitialized()
boolean	isMeetEnabled() Check if Moxtra meet enabled for this app.
protected boolean	isQuickAddForm(org.exoplatform.webui.core.UIComponent form)
protected org.exoplatform.moxtra.client.MoxtraMeet	meet()
void	mergeConfigs(org.exoplatform.webui.config.Component original, Class<? extends org.exoplatform.webui.core.UIComponent> clazz) Merge component configurations: event with listeners and if template defined, from extension to original component config.
protected MoxtraCalendarService	moxtra()
void	reset() Reset associated WebUI app in the context request (current thread).
void	saveMeet()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

QUICK_ADD_EVENT_POPUP_ID

public static final String QUICK_ADD_EVENT_POPUP_ID

QUICK_ADD_TASK_POPUP_ID

public static final String QUICK_ADD_TASK_POPUP_ID

QUICK_ADD_EVENT_FORM_ID

public static final String QUICK_ADD_EVENT_FORM_ID

QUICK_ADD_TASK_FORM_ID

public static final String QUICK_ADD_TASK_FORM_ID

LOG

public static final org.exoplatform.services.log.Log LOG

COLON

protected static final String COLON

uiApp

protected final ThreadLocal<org.exoplatform.webui.core.UIApplication> uiApp

Associated WebUI app.

requestForm

protected final ThreadLocal<org.exoplatform.webui.form.UIForm> requestForm

Associated form.

requestViewContainer

protected final ThreadLocal<org.exoplatform.webui.core.UIContainer> requestViewContainer

Associated UICalendarViewContainer. Main purpose is caching to reduce UI children traversing in activation and completion (save or delete).

meets

protected final Map<org.exoplatform.webui.core.UIComponent,org.exoplatform.moxtra.client.MoxtraMeet> meets

Meets associated with components in the app.
Components (forms) are stateful in general (like event form or calendar views). Additionally the same instance can be used for different events. As result this map should be intialized in each request and reset on modification operation completion (meet save or delete). Meets map cannot be used itself to activate the app by getting a meet by current form - a meet should be found in the form or any other part of the app and saved in this map to let later read it by other components in the request.
This map will not be required if it will be possible to save meets in forms directly (that isn't possible in Java if form class haven't such support, but in Groovy or via byte-code tools it could be doable).

eventMeets

@Deprecated
protected final Map<String,SoftReference<org.exoplatform.moxtra.client.MoxtraMeet>> eventMeets

Deprecated.

EventId-to-meet cache to reduce number of calls to Moxtra API during activation.

mergedConfigs

protected final Set<org.exoplatform.webui.config.Component> mergedConfigs

moxtra

protected MoxtraCalendarService moxtra

Associated MoxtraCalendarService.

Constructor Detail

MoxtraCalendarApplication

public MoxtraCalendarApplication()

Empty constructor mandatory!

Method Detail

init

public void init()

Specified by:

init in interface org.exoplatform.moxtra.webui.MoxtraApplication

isAuthorized

public boolean isAuthorized()
                     throws org.exoplatform.moxtra.webui.MoxtraNotInitializedException

Throws:

org.exoplatform.moxtra.webui.MoxtraNotInitializedException

getAuthorizationLink

public String getAuthorizationLink()
                            throws org.exoplatform.moxtra.webui.MoxtraNotInitializedException,
                                   org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                   org.exoplatform.moxtra.client.MoxtraConfigurationException

Throws:

org.exoplatform.moxtra.webui.MoxtraNotInitializedException

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.exoplatform.moxtra.client.MoxtraConfigurationException

activateForm

@Deprecated
public void activateForm(org.exoplatform.webui.form.UIForm form)

Deprecated.

Associate with WebUI application and patch the UI app if required.

Parameters:

uiApp - UIApplication

activate

public void activate(org.exoplatform.webui.core.UIApplication uiApp)

Associate with WebUI application and patch the UI app if required.

Specified by:

activate in interface org.exoplatform.moxtra.webui.MoxtraApplication

Parameters:

uiApp - UIApplication

reset

public void reset()

Reset associated WebUI app in the context request (current thread). Moxtra app cannot be used after the resetting without reactivation.

initEventFormContainer

public void initEventFormContainer(org.exoplatform.webui.core.UIContainer formContainer)

initEventForm

protected void initEventForm(org.exoplatform.webui.form.UIForm form)

initViewForm

protected void initViewForm(org.exoplatform.webui.form.UIForm form)

initEventMeet

protected void initEventMeet(org.exoplatform.webui.form.UIForm form)
                      throws MoxtraCalendarException

Init meet as for UIEventForm.

Throws:

MoxtraCalendarException

initQuickAddMeet

protected void initQuickAddMeet()

Init meet for quick-add form requests. This also will set request meet (thread-local) for later use in UIEventForm.

initQuickAddForm

@Deprecated
protected void initQuickAddForm(org.exoplatform.webui.form.UIForm form)

Deprecated.

Initialize this app if given form is quick-add form UIQuickAddEvent.

Parameters:

form - UIForm

deactivate

public void deactivate(org.exoplatform.webui.core.UIApplication uiApp)

Specified by:

deactivate in interface org.exoplatform.moxtra.webui.MoxtraApplication

enableMeet

public org.exoplatform.moxtra.client.MoxtraMeet enableMeet()
                                                    throws org.exoplatform.moxtra.webui.MoxtraNotActivatedException

Throws:

org.exoplatform.moxtra.webui.MoxtraNotActivatedException

disableMeet

public org.exoplatform.moxtra.client.MoxtraMeet disableMeet()
                                                     throws org.exoplatform.moxtra.webui.MoxtraNotActivatedException

Throws:

org.exoplatform.moxtra.webui.MoxtraNotActivatedException

getMeet

public org.exoplatform.moxtra.client.MoxtraMeet getMeet()
                                                 throws org.exoplatform.moxtra.webui.MoxtraNotActivatedException,
                                                        MoxtraMeetNotFoundException

Return Moxtra meet associated with this app. Returned meet may be already marked as deleted in this app, refer to MoxtraMeet.isDeleted() for its state. If meet wasn't enabled previously this method return MoxtraMeetNotFoundException.

Returns:

MoxtraMeet instance

Throws:

org.exoplatform.moxtra.webui.MoxtraNotActivatedException

MoxtraMeetNotFoundException

hasMeet

public boolean hasMeet()
                throws org.exoplatform.moxtra.webui.MoxtraNotActivatedException

Check if Moxtra meet has been associated with this app. Note that meet can be already marked for deleting.

Returns:

boolean true if meet available to get it, false otherwise

Throws:

org.exoplatform.moxtra.webui.MoxtraNotActivatedException

See Also:

#getMeet()}

isMeetEnabled

public boolean isMeetEnabled()
                      throws org.exoplatform.moxtra.webui.MoxtraNotActivatedException

Check if Moxtra meet enabled for this app.

Returns:

boolean true if meet enabled, false otherwise

Throws:

org.exoplatform.moxtra.webui.MoxtraNotActivatedException

See Also:

#getMeet()}

isActivated

public boolean isActivated()

isInitialized

public boolean isInitialized()

getUser

public org.exoplatform.moxtra.client.MoxtraUser getUser()
                                                 throws MoxtraCalendarException,
                                                        org.exoplatform.moxtra.MoxtraException

Current Moxtra user.

Returns:

MoxtraUser

Throws:

MoxtraCalendarException

org.exoplatform.moxtra.MoxtraException

getCalendarSetting

public org.exoplatform.calendar.service.CalendarSetting getCalendarSetting()
                                                                    throws MoxtraCalendarException,
                                                                           Exception

Current user calendar settings.

Returns:

CalendarSetting

Throws:

Exception

MoxtraCalendarException

getUserContacts

public List<org.exoplatform.moxtra.client.MoxtraUser> getUserContacts()
                                                               throws MoxtraCalendarException,
                                                                      org.exoplatform.moxtra.client.MoxtraAuthenticationException,
                                                                      org.exoplatform.moxtra.MoxtraException,
                                                                      org.exoplatform.moxtra.client.MoxtraConfigurationException

Current user contacts in Moxtra.

Returns:

List of MoxtraUser.

Throws:

MoxtraCalendarException

org.exoplatform.moxtra.client.MoxtraConfigurationException

org.exoplatform.moxtra.MoxtraException

org.exoplatform.moxtra.client.MoxtraAuthenticationException

saveMeet

public void saveMeet()
              throws Exception

Throws:

Exception

initContext

protected void initContext(org.exoplatform.webui.form.UIForm form)
                    throws MoxtraCalendarException,
                           org.exoplatform.moxtra.MoxtraException,
                           org.exoplatform.moxtra.client.MoxtraConfigurationException

Initialize this app context.

Parameters:

form - UIForm

Throws:

MoxtraCalendarException

org.exoplatform.moxtra.client.MoxtraConfigurationException

org.exoplatform.moxtra.MoxtraException

findComponent

protected <T extends org.exoplatform.webui.core.UIComponent> T findComponent(org.exoplatform.webui.core.UIContainer container,
                                                                 String typeName)

Find UI component in given container by its type name or ID if it equals to the given name.

Parameters:

container - UIContainer

typeName - String

Returns:

UIComponent or null

findChildBySuperType

protected <T extends org.exoplatform.webui.core.UIComponent> T findChildBySuperType(org.exoplatform.webui.core.UIContainer container,
                                                                        String superTypeName)

Find UI component child in given container by its super type name. If several such components found preference will be given to a first rendered.

Parameters:

container - UIContainer

superTypeName - String

Returns:

UIComponent or null

findRenderedChildBySuperType

protected <T extends org.exoplatform.webui.core.UIComponent> T findRenderedChildBySuperType(org.exoplatform.webui.core.UIContainer container,
                                                                                String superTypeName)

Find first rendered UI component in children of given container by a super type name.

Parameters:

container - UIContainer

superTypeName - String

Returns:

UIComponent or null

findChildsBySuperType

protected <T extends org.exoplatform.webui.core.UIComponent> List<T> findChildsBySuperType(org.exoplatform.webui.core.UIContainer container,
                                                                               String superTypeName,
                                                                               boolean deep)

Find UI component children in given container by a super type name.

Parameters:

container - UIContainer

superTypeName - String

Returns:

UIComponent or null

findRenderedChildByInterface

protected <T extends org.exoplatform.webui.core.UIComponent> T findRenderedChildByInterface(org.exoplatform.webui.core.UIContainer container,
                                                                                String interfaceName)

Find first rendered UI component in children of given container by an interface name.

Parameters:

container - UIContainer

interfaceName - String

Returns:

UIComponent or null

findChildsByInterface

protected <T extends org.exoplatform.webui.core.UIComponent> List<T> findChildsByInterface(org.exoplatform.webui.core.UIContainer container,
                                                                               String interfaceName,
                                                                               boolean deep)

Find UI component children in given container by an interface name.

Parameters:

container - UIContainer

interfaceName - String

Returns:

UIComponent or null

getEventCalendarId

protected String getEventCalendarId()
                             throws MoxtraCalendarException

Hardcoded version of UIEventForm.getCalendarId().

Parameters:

eventForm - UIForm

Returns:

calendar id selected in given form or null

Throws:

MoxtraCalendarException

getCalendarType

protected String getCalendarType()
                          throws MoxtraCalendarException

Get current calendar type in UIEventForm. Based on idea of #getCalendarId(UIForm).

Returns:

Throws:

MoxtraCalendarException

getEventIds

protected Set<String> getEventIds()

Event ids associated with current context (updated or deleted in the request).

Returns:

Set of String with event ids

getQuickAddCalendarId

@Deprecated
protected String getQuickAddCalendarId(org.exoplatform.webui.form.UIForm quickAddForm)
                                throws MoxtraCalendarException

Deprecated.

Reflection based access to UIQuickAddEvent.getEventCalendar().

Parameters:

quickAddForm - UIForm

Returns:

calendar id selected in given form or null

Throws:

MoxtraCalendarException

moxtra

protected MoxtraCalendarService moxtra()
                                throws org.exoplatform.moxtra.webui.MoxtraNotInitializedException

Throws:

org.exoplatform.moxtra.webui.MoxtraNotInitializedException

form

protected org.exoplatform.webui.form.UIForm form()
                                          throws org.exoplatform.moxtra.webui.MoxtraNotActivatedException

Throws:

org.exoplatform.moxtra.webui.MoxtraNotActivatedException

findFormMeet

protected org.exoplatform.moxtra.client.MoxtraMeet findFormMeet(org.exoplatform.webui.form.UIForm form)
                                                         throws org.exoplatform.moxtra.webui.MoxtraNotInitializedException,
                                                                MoxtraCalendarException

Find existing meet enabled for even shown in given form. Return null if no meet enabled.

Parameters:

form -

userName -

Returns:

MoxtraMeet instance for already enabled meet or null

Throws:

MoxtraCalendarException

org.exoplatform.moxtra.webui.MoxtraNotInitializedException

meet

protected org.exoplatform.moxtra.client.MoxtraMeet meet()
                                                 throws org.exoplatform.moxtra.webui.MoxtraNotActivatedException

Throws:

org.exoplatform.moxtra.webui.MoxtraNotActivatedException

isQuickAddForm

protected boolean isQuickAddForm(org.exoplatform.webui.core.UIComponent form)

mergeConfigs

public void mergeConfigs(org.exoplatform.webui.config.Component original,
                Class<? extends org.exoplatform.webui.core.UIComponent> clazz)
                  throws Exception

Merge component configurations: event with listeners and if template defined, from extension to original component config. When template defined in extension it will replace the original.

Throws:

Exception

getEventMeet

@Deprecated
protected org.exoplatform.moxtra.client.MoxtraMeet getEventMeet(String eventId)

Deprecated.