Author: thanh_tung_do
Date: 2010-07-05 02:58:19 -0400 (Mon, 05 Jul 2010)
New Revision: 3558
Modified:
portal/trunk/component/application-registry/src/main/java/org/exoplatform/application/gadget/GadgetRegistryService.java
portal/trunk/component/application-registry/src/main/java/org/exoplatform/application/gadget/SourceStorage.java
portal/trunk/component/application-registry/src/main/java/org/exoplatform/application/registry/ApplicationRegistryService.java
portal/trunk/component/application-registry/src/test/java/org/exoplatform/application/gadget/TestGadgetRegistryService.java
portal/trunk/component/portal/src/main/java/org/exoplatform/portal/config/DataStorage.java
portal/trunk/component/portal/src/main/java/org/exoplatform/portal/resource/SkinService.java
portal/trunk/component/web/src/main/java/org/exoplatform/upload/UploadService.java
portal/trunk/component/web/src/main/java/org/exoplatform/web/application/javascript/JavascriptConfigService.java
Log:
Update Java API document
Modified:
portal/trunk/component/application-registry/src/main/java/org/exoplatform/application/gadget/GadgetRegistryService.java
===================================================================
---
portal/trunk/component/application-registry/src/main/java/org/exoplatform/application/gadget/GadgetRegistryService.java 2010-07-05
03:52:36 UTC (rev 3557)
+++
portal/trunk/component/application-registry/src/main/java/org/exoplatform/application/gadget/GadgetRegistryService.java 2010-07-05
06:58:19 UTC (rev 3558)
@@ -33,10 +33,10 @@
{
/**
- * Gets the gadget from database by name.
+ * Return Gadget object retrieved from database by its name.
*
* @param name the name of gadget
- * @return the gadget or null if not found
+ * @return Gadget object or null if not found
* @throws Exception
*/
public Gadget getGadget(String name) throws Exception;
@@ -64,21 +64,28 @@
* Adds the gadget to the database. If the gadget is existing, it will be
* updated.
*
- * @param app the gadget that is saved to database
+ * @param gadget - Gadget that is saved to database, must not be null
* @throws Exception
*/
public void saveGadget(Gadget gadget) throws Exception;
/**
* Removes the gadget from the database.
- *
- * @param id the id of gadget
+ * If can't find Gadget with that name in database, this will throw Exception
+ * @param name the name of gadget
* @throws Exception
*/
public void removeGadget(String name) throws Exception;
+ /**
+ * Always return true
+ * @param username
+ */
public boolean isGadgetDeveloper(String username);
+ /**
+ * Return Country name, it's set in xml config of GadgetRegistryService
+ */
public String getCountry();
public String getLanguage();
Modified:
portal/trunk/component/application-registry/src/main/java/org/exoplatform/application/gadget/SourceStorage.java
===================================================================
---
portal/trunk/component/application-registry/src/main/java/org/exoplatform/application/gadget/SourceStorage.java 2010-07-05
03:52:36 UTC (rev 3557)
+++
portal/trunk/component/application-registry/src/main/java/org/exoplatform/application/gadget/SourceStorage.java 2010-07-05
06:58:19 UTC (rev 3558)
@@ -28,10 +28,10 @@
public interface SourceStorage
{
/**
- * This method will get source from a specify source's path in database
- * @param sourcePath
- * @return
- * @throws Exception
+ * Return {@link Source} object of gadget that name provided in gadget object param
<br/>
+ * If can't find gadget with that name, return null <br/>
+ * If gadget is remote, throw Exception <br/>
+ * @param gadget - Gadget object used to retrieved gadget's name
*/
public Source getSource(Gadget gadget) throws Exception;
Modified:
portal/trunk/component/application-registry/src/main/java/org/exoplatform/application/registry/ApplicationRegistryService.java
===================================================================
---
portal/trunk/component/application-registry/src/main/java/org/exoplatform/application/registry/ApplicationRegistryService.java 2010-07-05
03:52:36 UTC (rev 3557)
+++
portal/trunk/component/application-registry/src/main/java/org/exoplatform/application/registry/ApplicationRegistryService.java 2010-07-05
06:58:19 UTC (rev 3558)
@@ -30,41 +30,119 @@
{
String REMOTE_DISPLAY_NAME_SUFFIX = " (remote)";
+ /**
+ * Return list of ApplicationCatgory (and applications in each category)
+ * @param accessUser
+ * @param appTypes - array of ApplicationType, used to filter applications in each
application category
+ */
public List<ApplicationCategory> getApplicationCategories(String accessUser,
ApplicationType<?>... appTypes) throws Exception;
public void initListener(ComponentPlugin com) throws Exception;
+ /**
+ * Return list of all current application categories (unsorted, all Application in all
ApplicationType)
+ */
public List<ApplicationCategory> getApplicationCategories() throws Exception;
+ /**
+ * Return list of all current application categories (sorted, all applications in all
types)
+ * @param sortComparator - Comparator used to sort the returned list
+ */
public List<ApplicationCategory>
getApplicationCategories(Comparator<ApplicationCategory> sortComparator)
throws Exception;
+ /**
+ * Return ApplicationCategory with name provided <br/>
+ * if not found, return null
+ * @param name - ApplicationCategory's name
+ */
public ApplicationCategory getApplicationCategory(String name) throws Exception;
+ /**
+ * Save an ApplicationCategory to database <br/>
+ * If it doesn't exist, a new one will be created, if not, it will be updated
+ * @param category - ApplicationCategory object that will be saved
+ */
public void save(ApplicationCategory category) throws Exception;
+ /**
+ * Remove application category (and all application in it) from database <br/>
+ * If it doesn't exist, it will be ignored
+ * @param category - ApplicationCategory object that will be removed
+ */
public void remove(ApplicationCategory category) throws Exception;
+ /**
+ * Return list of applications (unsorted) in specific category and have specific type
+ * @param category - ApplicationCategory that you want to list applications
+ * @param appTypes - array of application type
+ */
public List<Application> getApplications(ApplicationCategory category,
ApplicationType<?>... appTypes) throws Exception;
+ /**
+ * Return list of applications (sorted) in specific category and have specific type
+ * @param category - ApplicationCategory that you want to list applications
+ * @param sortComparator - comparator used to sort application list
+ * @param appTypes - array of application type
+ */
public List<Application> getApplications(ApplicationCategory category,
Comparator<Application> sortComparator,
ApplicationType<?>... appTypes) throws
Exception;
-
+ /**
+ * Return list of all Application in database (unsorted) <br/>
+ * If there are not any Application in database, return an empty list
+ */
public List<Application> getAllApplications() throws Exception;
+ /**
+ * Return Application with id provided
+ * @param id - must be valid applicationId (catgoryname/applicationName), if not, this
will throw exception
+ */
public Application getApplication(String id) throws Exception;
+ /**
+ * Return Application in specific category and have name provided in param
<br/>
+ * If it can't be found, return null
+ * @param category - name of application category
+ * @param name - name of application
+ */
public Application getApplication(String category, String name) throws Exception;
+ /**
+ * Save Application in an ApplicationCategory <br/>
+ * If ApplicationCategory or Application don't exist, they'll be created
<br/>
+ * If Application has been already existed, it will be updated <br/>
+ * @param category - ApplicationCategory that your application'll be saved to
+ * @param application - Application that will be saved
+ */
public void save(ApplicationCategory category, Application application) throws
Exception;
+ /**
+ * Update an Application <br/>
+ * It must be existed in database, if not, this will throw an IllegalStateException
+ * @param application - Application that you want to update
+ */
public void update(Application application) throws Exception;
+ /**
+ * Remove an Application from database <br/>
+ * If it can't be found, it will be ignored (no exception)
+ * @param app - Application that you want to remove, must not be null
+ */
public void remove(Application app) throws Exception;
+ /**
+ * Get all deployed portlet, add to portlet's ApplicationCategory <br/>
+ * If ApplicationCategory currently doesn't exist, it'll be created
<br/>
+ * If Application've already existed, it'll be ignored
+ */
public void importAllPortlets() throws Exception;
//TODO: dang.tung
-
+ /**
+ * Get all Gadget, add to eXoGadgets application category <br/>
+ * When first added, it's access permission will be Everyone <br/>
+ * If ApplicationCategory currently doesn't exist, it'll be created
<br/>
+ * Gadget that has been imported will be ignored
+ */
public void importExoGadgets() throws Exception;
}
\ No newline at end of file
Modified:
portal/trunk/component/application-registry/src/test/java/org/exoplatform/application/gadget/TestGadgetRegistryService.java
===================================================================
---
portal/trunk/component/application-registry/src/test/java/org/exoplatform/application/gadget/TestGadgetRegistryService.java 2010-07-05
03:52:36 UTC (rev 3557)
+++
portal/trunk/component/application-registry/src/test/java/org/exoplatform/application/gadget/TestGadgetRegistryService.java 2010-07-05
06:58:19 UTC (rev 3558)
@@ -26,11 +26,9 @@
/**
* todo julien : to fix
- *
- * Created by The eXo Platform SAS
- * Author : Pham Thanh Tung
- * thanhtungty(a)gmail.com
- * Jul 11, 2008
+ *
+ * Created by The eXo Platform SAS Author : Pham Thanh Tung
+ * thanhtungty(a)gmail.com Jul 11, 2008
*/
public abstract class TestGadgetRegistryService extends AbstractGateInTest
{
@@ -53,49 +51,32 @@
g2.setUrl("http://www.labpixies.com/campaigns/maps/maps.xml");
service_.saveGadget(g1);
service_.saveGadget(g2);
+ }
+
+ public void testGetAllGadgets() throws Exception
+ {
assertEquals(2, service_.getAllGadgets().size());
- Gadget g3 = service_.getGadget(g1.getName());
+ }
+
+ public void testGetGadget() throws Exception
+ {
+ Gadget g3 = service_.getGadget("weather");
assertNotNull(g3);
assertEquals("weather", g3.getName());
assertEquals("http://www.labpixies.com/campaigns/weather/weather.xml...;,
g3.getUrl());
- Gadget g4 = service_.getGadget(g2.getName());
+ Gadget g4 = service_.getGadget("map");
assertNotNull(g4);
assertEquals("map", g4.getName());
assertEquals("http://www.labpixies.com/campaigns/maps/maps.xml",
g4.getUrl());
-
}
- public void testGetGadget() throws Exception
+ public void testRemoveGadget() throws Exception
{
- Gadget gadget = new Gadget();
- gadget.setName("weather");
-
gadget.setUrl("http://www.labpixies.com/campaigns/weather/weather.xm...;
- service_.saveGadget(gadget);
- Gadget g = service_.getGadget(gadget.getName());
- assertNotNull(g);
- assertEquals(1, service_.getAllGadgets().size());
- assertEquals("weather", g.getName());
-
assertEquals("http://www.labpixies.com/campaigns/weather/weather.xml...;,
g.getUrl());
- }
-
- public void testGetAllGadgets()
- {
-
- }
-
- public void testRemoveGadget()
- {
-
- }
-
- public void tearDown() throws Exception
- {
List<Gadget> gadgets = service_.getAllGadgets();
for (Gadget ele : gadgets)
{
service_.removeGadget(ele.getName());
}
}
-
}
Modified:
portal/trunk/component/portal/src/main/java/org/exoplatform/portal/config/DataStorage.java
===================================================================
---
portal/trunk/component/portal/src/main/java/org/exoplatform/portal/config/DataStorage.java 2010-07-05
03:52:36 UTC (rev 3557)
+++
portal/trunk/component/portal/src/main/java/org/exoplatform/portal/config/DataStorage.java 2010-07-05
06:58:19 UTC (rev 3558)
@@ -61,16 +61,45 @@
public final static String PORTAL_CONFIG_UPDATED =
"org.exoplatform.portal.config.DataStorage.portalConfigUpdated".intern();
+ /**
+ * Create a PortalConfig in database <br/>
+ * Then broadcast PORTAL_CONFIG_CREATED event
+ * @param config
+ */
public void create(PortalConfig config) throws Exception;
+ /**
+ * This method should update the PortalConfig object <br/>
+ * Then broadcast PORTAL_CONFIG_UPDATED event
+ * @param config
+ */
public void save(PortalConfig config) throws Exception;
+ /**
+ * This method should load the PortalConfig object from db according to the portalName
+ * @param portalName
+ */
public PortalConfig getPortalConfig(String portalName) throws Exception;
+ /**
+ * This method should load the PortalConfig object from db according to the portalName
and ownerType
+ * @param portalName
+ * @param ownerType
+ */
public PortalConfig getPortalConfig(String ownerType, String portalName) throws
Exception;
+ /**
+ * Remove the PortalConfig from the database <br/>
+ * Then broadcast PORTAL_CONFIG_REMOVED event
+ * @param config
+ * @throws Exception
+ */
public void remove(PortalConfig config) throws Exception;
+ /**
+ * This method should load the Page object from the database according to the pageId
+ * @param pageId - String represent id of page, it must be valid pageId (3 parts
saparate by :: )
+ */
public Page getPage(String pageId) throws Exception;
/**
@@ -86,55 +115,152 @@
public Page clonePage(String pageId, String clonedOwnerType, String clonedOwnerId,
String clonedName)
throws Exception;
+ /**
+ * Remove Page from database <br />
+ * Then broadcast PAGE_REMOVED event
+ * @param page
+ * @throws Exception
+ */
public void remove(Page page) throws Exception;
+ /**
+ * This method should create or udate the given page object <br />
+ * Then broasdcast PAGE_CREATED event
+ * @param page
+ * @throws Exception
+ */
public void create(Page page) throws Exception;
/**
* Saves a page. If a page with the same id already exists then a merge operation will
occur, otherwise
- * a new page will be created from the provided argument.
+ * a new page will be created from the provided argument. <br />
*
* The operation returns a list of the change object that describes the changes that
occured during the
- * save operation.
+ * save operation. <br/>
*
+ *Then broadcast PAGE_UPDATED event
+ *
* @param page the page to save
* @return the list of model changes that occured during the save operation
* @throws Exception any exception
*/
public List<ModelChange> save(Page page) throws Exception;
+ /**
+ * Return PageNavigation object from the database according to the fullId <br
/>
+ * If can't find, return null
+ * @param fullId - must be valid (2 parts, split by :: )
+ * @throws Exception
+ */
public PageNavigation getPageNavigation(String fullId) throws Exception;
+ /**
+ * Return PageNavigation object from the database according to the onwnerType (portal,
group or user) and id
+ * @param ownerType
+ * @param id
+ * @throws Exception
+ */
public PageNavigation getPageNavigation(String ownerType, String id) throws
Exception;
+ /**
+ * This method should update the navigation object in the database <br />
+ * Then broadcast NAVIGATION_UPDATED event
+ * @param navigation - PageNavigation object to update
+ * @throws Exception
+ */
public void save(PageNavigation navigation) throws Exception;
+ /**
+ * This method should create the navigation object in the database <br />
+ * Then broadcast NAVIGATION_CREATED event
+ * @param navigation - PageNavigation object to create
+ * @throws Exception
+ */
public void create(PageNavigation navigation) throws Exception;
+ /**
+ * Remove the navigation object from the database <br />
+ * If can't find it in database, ignore
+ * Then broadcast NAVIGATION_REMOVED event
+ * @param navigation - PageNavigation object to remove
+ * @throws Exception
+ */
public void remove(PageNavigation navigation) throws Exception;
+ /**
+ * Save PortletPreferences config node
+ * @param portletPreferences - PortletPreferences object
+ */
public void save(PortletPreferences portletPreferences) throws Exception;
+ /**
+ * Return contentId according to each state (transient, persitent, clone)
+ * @param state
+ */
public <S> String getId(ApplicationState<S> state) throws Exception;
+ /**
+ * Return content state. If can't find, return null
+ * @see PreferencesTask
+ * @param state - ApplicationState object
+ * @param type - ApplicationType object
+ */
public <S> S load(ApplicationState<S> state, ApplicationType<S>
type) throws Exception;
+ /**
+ * Save content state <br />
+ * @param state - ApplicationState object. It must be CloneApplicationState or
PersistentApplicationState object
+ * @param preferences - object to be saved
+ */
public <S> ApplicationState<S> save(ApplicationState<S> state, S
preferences) throws Exception;
+ /**
+ * Return PortletPreferences from database, if can't find it, return null
+ * @param windowID
+ */
public PortletPreferences getPortletPreferences(String windowID) throws Exception;
+ /**
+ * Return LazyPageList of object (unsorted) which type and other info determined in
Query object
+ * @param q - Query object
+ */
public <T> LazyPageList<T> find(Query<T> q) throws Exception;
+ /**
+ * Return LazyPageList of object (sorted) which type and other info determined in
Query object
+ * @param q - Query object
+ */
public <T> LazyPageList<T> find(Query<T> q, Comparator<T>
sortComparator) throws Exception;
+ /**
+ * Return ListAccess, we can retrieved array of object (unsorted) in database through
this.
+ * @param q - Query object
+ */
public <T> ListAccess<T> find2(Query<T> q) throws Exception;
+ /**
+ * Return ListAccess, we can retrieved array of object (sorted) in database through
this.
+ * @param q - Query object
+ * @param sortComparator - Comparator object, used to sort the result list
+ */
public <T> ListAccess<T> find2(Query<T> q, Comparator<T>
sortComparator) throws Exception;
+ /**
+ * Return Container object - info that be used to build this Container is retrieved
from /conf/portal/portal/sharedlayout.xml
+ */
public Container getSharedLayout() throws Exception;
+ /**
+ * Return Dashboard object from database according to dashboard id
+ * If can't find out, return null
+ * @param dashboardId
+ */
public Dashboard loadDashboard(String dashboardId) throws Exception;
+ /**
+ * Save Dashboard (its data : DashboadData) to database
+ * @param dashboard - Dashboard object to be saved
+ */
public void saveDashboard(Dashboard dashboard) throws Exception;
/**
Modified:
portal/trunk/component/portal/src/main/java/org/exoplatform/portal/resource/SkinService.java
===================================================================
---
portal/trunk/component/portal/src/main/java/org/exoplatform/portal/resource/SkinService.java 2010-07-05
03:52:36 UTC (rev 3557)
+++
portal/trunk/component/portal/src/main/java/org/exoplatform/portal/resource/SkinService.java 2010-07-05
06:58:19 UTC (rev 3558)
@@ -150,7 +150,7 @@
/**
* add category into portletThemes_ if portletThemes does not contain one
- * @param categoryName: category's name that want to add into portletThemes_
+ * @param categoryName: category's name that want to add into portletThemes
*/
public void addCategoryTheme(String categoryName)
{
@@ -239,6 +239,20 @@
}
+ /**
+ *
+ * Register the Skin for available portal Skins. Do not override previous skin
+ *
+ * @param module
+ * skin module identifier
+ * @param skinName
+ * skin name
+ * @param cssPath
+ * path uri to the css file. This is relative to the root context,
+ * use leading '/'
+ * @param scontext
+ * the webapp's {@link javax.servlet.ServletContext}
+ */
public void addSkin(String module, String skinName, String cssPath, ServletContext
scontext)
{
addSkin(module, skinName, cssPath, scontext, false);
@@ -308,8 +322,6 @@
* use leading '/'
* @param scontext
* the webapp's {@link javax.servlet.ServletContext}
- * @param overwrite
- * if any previous skin should be replaced by that one
*/
public void addSkin(String module, String skinName, String cssPath, String cssData)
{
@@ -355,7 +367,7 @@
*
* @param cssPath
* path of the css to find
- * @return the css
+ * @return the css contet or null if not found.
*/
public String getCSS(String cssPath)
{
@@ -445,7 +457,7 @@
* get css content of URI file
* @param cssPath
* path uri to the css file
- * @return css content of URI file
+ * @return css content of URI file or null if not found
*/
public String getMergedCSS(String cssPath)
{
@@ -472,6 +484,10 @@
return portalSkins;
}
+ /**
+ * Get all portlet's themes
+ * @return portlet's themes
+ */
public Map<String, Set<String>> getPortletThemes()
{
return portletThemes_;
@@ -481,7 +497,7 @@
* Get SkinConfig by module and skin name
* @param module
* @param skinName
- * @return
+ * @return SkinConfig by SkinKey(module, skinName), or SkinConfig by SkinKey(module,
"Default")
*/
public SkinConfig getSkin(String module, String skinName)
{
@@ -491,6 +507,11 @@
return config;
}
+ /**
+ * Remove SkinKey from SkinCache by portalName and skinName
+ * @param portalName
+ * @param skinName
+ */
public void invalidatePortalSkinCache(String portalName, String skinName)
{
SkinKey key = new SkinKey(portalName, skinName);
@@ -599,6 +620,15 @@
return resource;
}
+ /**
+ * Apply CSS of skin
+ * @param appendable
+ * @param cssPath
+ * @param orientation
+ * @param merge
+ * @throws RenderingException
+ * @throws IOException
+ */
private void processCSS(Appendable appendable, String cssPath, Orientation
orientation, boolean merge)
throws RenderingException, IOException
{
@@ -606,6 +636,16 @@
processCSSRecursively(appendable, merge, skin, orientation);
}
+ /**
+ * Apply CSS for Skin <br/>
+ * If skin is null, do nothing
+ * @param appendable
+ * @param merge
+ * @param skin
+ * @param orientation
+ * @throws RenderingException
+ * @throws IOException
+ */
private void processCSSRecursively(Appendable appendable, boolean merge, Resource
skin, Orientation orientation)
throws RenderingException, IOException
{
@@ -696,6 +736,9 @@
return !matcher2.find();
}
+ /**
+ * Rewrite background url pattern
+ */
private void append(String line, String basePath, Appendable appendable) throws
IOException
{
// Rewrite background url pattern
@@ -712,6 +755,11 @@
}
}
+ /**
+ * Get Suffix of Orientation
+ * @param orientation
+ * @return Suffix of Orientation
+ */
String getSuffix(Orientation orientation)
{
if (orientation == null)
@@ -742,6 +790,11 @@
return availableSkin.toArray(new String[availableSkin.size()]);
}
+ /**
+ * Registry ServletContext into MainResourceResolver of SkinService
+ * @param sContext
+ * ServletContext will be registried
+ */
public void registerContext(ServletContext sContext)
{
mainResolver.registerContext(sContext);
@@ -774,7 +827,8 @@
}
/**
- * Start service
+ * Start service.
+ * Registry org.exoplatform.portal.resource.GateInSkinConfigDeployer and
org.exoplatform.portal.resource.GateInSkinConfigRemoval into ServletContainer.
* @see org.picocontainer.Startable#start()
*/
public void start()
@@ -785,6 +839,7 @@
/**
* Stop service
+ * Remove org.exoplatform.portal.resource.GateInSkinConfigDeployer and
org.exoplatform.portal.resource.GateInSkinConfigRemoval from ServletContainer.
* @see org.picocontainer.Startable#stop()
*/
public void stop()
Modified:
portal/trunk/component/web/src/main/java/org/exoplatform/upload/UploadService.java
===================================================================
---
portal/trunk/component/web/src/main/java/org/exoplatform/upload/UploadService.java 2010-07-05
03:52:36 UTC (rev 3557)
+++
portal/trunk/component/web/src/main/java/org/exoplatform/upload/UploadService.java 2010-07-05
06:58:19 UTC (rev 3558)
@@ -66,6 +66,14 @@
uploadDir.mkdirs();
}
+ /**
+ * Create UploadResource for HttpServletRequest.
+ * If Upload size greater than limit upload size, do not create UploadResource
+ * @param request
+ * the webapp's {@link javax.servlet.http.HttpServletRequest}
+ * @throws IOException
+ * any io exception
+ */
public void createUploadResource(HttpServletRequest request) throws IOException
{
String uploadId = request.getParameter("uploadId");
@@ -123,6 +131,21 @@
fileStore.delete();
}
+ /**
+ * Create UploadResource for uploadId.
+ * If Upload size greater than limit upload size, do not create UploadResource.
+ * @param uploadId
+ * the uploadId will be use to create UploadResource
+ * @param encoding
+ * type of encode
+ * @param contentType
+ * type of upload content
+ * @param contentLength
+ * size of upload content
+ * @param inputStream
+ * java.io.InputStream
+ * @throws Exception
+ */
public void createUploadResource(String uploadId, String encoding, String contentType,
double contentLength,
InputStream inputStream) throws Exception
{
@@ -166,12 +189,24 @@
fileStore.delete();
}
+ /**
+ * Get UploadResource by uploadId
+ * @param uploadId
+ * uploadId of UploadResource
+ * @return org.exoplatform.upload.UploadResource of uploadId
+ */
public UploadResource getUploadResource(String uploadId)
{//throws Exception
UploadResource upResource = uploadResources.get(uploadId);
return upResource;
}
+ /**
+ * Remove UploadResource by uploadId, Delete temp file of UploadResource.
+ * If uploadId is null or UploadResource is null or Store Location of UploadResource
is null, do nothing
+ * @param uploadId
+ * uploadId of UploadResource will be removed
+ */
public void removeUpload(String uploadId)
{
if (uploadId == null)
@@ -187,6 +222,13 @@
//uploadLimitsMB_.remove(uploadId);
}
+ /**
+ * Registry upload limit size for uploadLimitsMB_.
+ * If limitMB is null, defaultUploadLimitMB_ will be registried
+ * @param uploadId
+ * @param limitMB
+ * upload limit size
+ */
public void addUploadLimit(String uploadId, Integer limitMB)
{
if (limitMB == null)
@@ -195,6 +237,11 @@
uploadLimitsMB_.put(uploadId, limitMB);
}
+ /**
+ * Get all upload limit sizes
+ * @return
+ * all upload limit sizes
+ */
public Map<String, Integer> getUploadLimitsMB()
{
return uploadLimitsMB_;
Modified:
portal/trunk/component/web/src/main/java/org/exoplatform/web/application/javascript/JavascriptConfigService.java
===================================================================
---
portal/trunk/component/web/src/main/java/org/exoplatform/web/application/javascript/JavascriptConfigService.java 2010-07-05
03:52:36 UTC (rev 3557)
+++
portal/trunk/component/web/src/main/java/org/exoplatform/web/application/javascript/JavascriptConfigService.java 2010-07-05
06:58:19 UTC (rev 3558)
@@ -69,9 +69,7 @@
}
/**
- * Return a collection list This method should return the availables scripts
- * in the service
- *
+ * Return a collection list This method should return the availables scripts in the
service
* @return
*/
public Collection<String> getAvailableScripts()
@@ -80,8 +78,8 @@
}
/**
- * return a collection list This method should return the availables script paths
- * @return
+ * Get a available script paths
+ * @return a collection list. This method should return the available script paths
*/
public Collection<String> getAvailableScriptsPaths()
{
@@ -146,7 +144,7 @@
}
/**
- * Add an JavaScript into available JavaScript
+ * Add an JavaScript into available JavaScripts
* @param javascript
* JavaScript will be added into available JavaScript
*/
@@ -304,7 +302,7 @@
/**
* Check the existence of module in Available Scripts
* @param module
- * @return
+ * @return true if Available Scripts contain module, else return false
*/
public boolean isModuleLoaded(CharSequence module)
{
@@ -332,7 +330,9 @@
}
/**
- * Start service
+ * Start service.
+ * Registry org.exoplatform.web.application.javascript.JavascriptDeployer,
+ * org.exoplatform.web.application.javascript.JavascriptRemoval into
ServletContainer
* @see org.picocontainer.Startable#start()
*/
public void start()
@@ -342,7 +342,9 @@
}
/**
- * Stop service
+ * Stop service.
+ * Remove org.exoplatform.web.application.javascript.JavascriptDeployer,
+ * org.exoplatform.web.application.javascript.JavascriptRemoval from
ServletContainer
* @see org.picocontainer.Startable#stop()
*/
public void stop()