You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openmeetings.apache.org by so...@apache.org on 2017/12/08 18:12:37 UTC
[4/4] openmeetings git commit: [OPENMEETINGS-1777] mysql version is
updated, some javadoc errors are fixed
[OPENMEETINGS-1777] mysql version is updated, some javadoc errors are fixed
Project: http://git-wip-us.apache.org/repos/asf/openmeetings/repo
Commit: http://git-wip-us.apache.org/repos/asf/openmeetings/commit/508ad005
Tree: http://git-wip-us.apache.org/repos/asf/openmeetings/tree/508ad005
Diff: http://git-wip-us.apache.org/repos/asf/openmeetings/diff/508ad005
Branch: refs/heads/master
Commit: 508ad0055cf2bdd8306e8c890ff5110b79bdc905
Parents: 52fc718
Author: Maxim Solodovnik <so...@gmail.com>
Authored: Sat Dec 9 01:11:12 2017 +0700
Committer: Maxim Solodovnik <so...@gmail.com>
Committed: Sat Dec 9 01:12:28 2017 +0700
----------------------------------------------------------------------
.../core/converter/DocumentConverter.java | 4 ++
.../core/converter/ImageConverter.java | 2 +
.../record/listener/async/BaseStreamWriter.java | 3 +-
.../core/ldap/LdapLoginManagement.java | 5 +++
.../openmeetings/core/remote/MobileService.java | 1 +
.../openmeetings/core/util/IClientUtil.java | 2 +-
.../openmeetings/db/dao/IDataProviderDao.java | 3 +-
.../db/dao/basic/ConfigurationDao.java | 15 +++++---
.../db/dao/calendar/AppointmentDao.java | 8 +++-
.../db/dao/calendar/MeetingMemberDao.java | 3 ++
.../openmeetings/db/dao/file/FileItemDao.java | 16 +++++---
.../db/dao/server/ISessionManager.java | 34 ++++++++---------
.../db/dao/server/SessiondataDao.java | 12 +++---
.../db/dao/user/UserContactDao.java | 4 +-
.../openmeetings/db/dao/user/UserDao.java | 40 ++++++++++----------
.../openmeetings/db/dto/room/InvitationDTO.java | 2 +-
.../db/entity/record/Recording.java | 6 +--
.../db/entity/record/RecordingMetaData.java | 3 +-
.../db/entity/room/RoomPollAnswer.java | 6 +--
.../db/entity/server/RemoteSessionObject.java | 14 +++----
.../openmeetings/db/util/FormatHelper.java | 3 ++
.../openmeetings/db/util/TimezoneUtil.java | 6 ++-
.../apache/openmeetings/util/ImportHelper.java | 3 +-
.../openmeetings/util/mail/IcalHandler.java | 20 +++++++++-
openmeetings-web/pom.xml | 2 +-
25 files changed, 133 insertions(+), 84 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-core/src/main/java/org/apache/openmeetings/core/converter/DocumentConverter.java
----------------------------------------------------------------------
diff --git a/openmeetings-core/src/main/java/org/apache/openmeetings/core/converter/DocumentConverter.java b/openmeetings-core/src/main/java/org/apache/openmeetings/core/converter/DocumentConverter.java
index 3fc14d4..dcdcc14 100644
--- a/openmeetings-core/src/main/java/org/apache/openmeetings/core/converter/DocumentConverter.java
+++ b/openmeetings-core/src/main/java/org/apache/openmeetings/core/converter/DocumentConverter.java
@@ -90,6 +90,10 @@ public class DocumentConverter {
/**
* Generates PDF using JOD Library (external library)
+ *
+ * @param in - file to convert
+ * @param out - file to write result
+ * @return - result of the conversion as {@link ProcessResult}
*/
public ProcessResult doJodConvert(File in, File out) {
try {
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-core/src/main/java/org/apache/openmeetings/core/converter/ImageConverter.java
----------------------------------------------------------------------
diff --git a/openmeetings-core/src/main/java/org/apache/openmeetings/core/converter/ImageConverter.java b/openmeetings-core/src/main/java/org/apache/openmeetings/core/converter/ImageConverter.java
index 6d4d2df..0cee85c 100644
--- a/openmeetings-core/src/main/java/org/apache/openmeetings/core/converter/ImageConverter.java
+++ b/openmeetings-core/src/main/java/org/apache/openmeetings/core/converter/ImageConverter.java
@@ -168,7 +168,9 @@ public class ImageConverter extends BaseConverter {
/**
* Converts PDF document to the series of images
*
+ * @param f - {@link FileItem} object to write number of pages and size
* @param pdf - input PDF document
+ * @param logs - logs of the conversion
* @return - result of conversion
* @throws IOException in case IO exception occurred
*/
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-core/src/main/java/org/apache/openmeetings/core/data/record/listener/async/BaseStreamWriter.java
----------------------------------------------------------------------
diff --git a/openmeetings-core/src/main/java/org/apache/openmeetings/core/data/record/listener/async/BaseStreamWriter.java b/openmeetings-core/src/main/java/org/apache/openmeetings/core/data/record/listener/async/BaseStreamWriter.java
index d58ae1a..537ebc5 100644
--- a/openmeetings-core/src/main/java/org/apache/openmeetings/core/data/record/listener/async/BaseStreamWriter.java
+++ b/openmeetings-core/src/main/java/org/apache/openmeetings/core/data/record/listener/async/BaseStreamWriter.java
@@ -163,11 +163,12 @@ public abstract class BaseStreamWriter implements Runnable {
/**
* Write the actual packet data to the disk and do calculate any needed additional information
*
- * @param streampacket
+ * @param streampacket - received packet
*/
public abstract void packetReceived(CachedEvent streampacket);
protected abstract void internalCloseStream();
+
/**
* called when the stream is finished written on the disk
*/
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-core/src/main/java/org/apache/openmeetings/core/ldap/LdapLoginManagement.java
----------------------------------------------------------------------
diff --git a/openmeetings-core/src/main/java/org/apache/openmeetings/core/ldap/LdapLoginManagement.java b/openmeetings-core/src/main/java/org/apache/openmeetings/core/ldap/LdapLoginManagement.java
index 9d70692..be64e94 100644
--- a/openmeetings-core/src/main/java/org/apache/openmeetings/core/ldap/LdapLoginManagement.java
+++ b/openmeetings-core/src/main/java/org/apache/openmeetings/core/ldap/LdapLoginManagement.java
@@ -164,6 +164,11 @@ public class LdapLoginManagement {
*
* Connection Data is retrieved from ConfigurationFile
*
+ * @param _login - user login
+ * @param passwd - user password
+ * @param domainId - user domain id
+ * @return - {@link User} with this credentials or <code>null</code>
+ * @throws OmException - in case of any error
*/
public User login(String _login, String passwd, Long domainId) throws OmException {
log.debug("LdapLoginmanagement.doLdapLogin");
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-core/src/main/java/org/apache/openmeetings/core/remote/MobileService.java
----------------------------------------------------------------------
diff --git a/openmeetings-core/src/main/java/org/apache/openmeetings/core/remote/MobileService.java b/openmeetings-core/src/main/java/org/apache/openmeetings/core/remote/MobileService.java
index 34c57bf..ef36015 100644
--- a/openmeetings-core/src/main/java/org/apache/openmeetings/core/remote/MobileService.java
+++ b/openmeetings-core/src/main/java/org/apache/openmeetings/core/remote/MobileService.java
@@ -348,6 +348,7 @@ public class MobileService {
*
* @param sid - sid
* @param userId - redundant userId
+ * @return {@link Map} with publiSid and broadcastId
*/
public Map<String, Object> roomConnect(String sid, Long userId) {
// publicSid is changed on mobile room connect
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-core/src/main/java/org/apache/openmeetings/core/util/IClientUtil.java
----------------------------------------------------------------------
diff --git a/openmeetings-core/src/main/java/org/apache/openmeetings/core/util/IClientUtil.java b/openmeetings-core/src/main/java/org/apache/openmeetings/core/util/IClientUtil.java
index 590ebfa..c2c6136 100644
--- a/openmeetings-core/src/main/java/org/apache/openmeetings/core/util/IClientUtil.java
+++ b/openmeetings-core/src/main/java/org/apache/openmeetings/core/util/IClientUtil.java
@@ -37,7 +37,7 @@ public class IClientUtil {
/**
* Id of {@link StreamClient} for this IConnection
*
- * @param conn
+ * @param client - {@link IClient} to get if from
* @return - Id of {@link StreamClient} for this IConnection, or <code>null</code>
*/
public static String getId(IClient client) {
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/IDataProviderDao.java
----------------------------------------------------------------------
diff --git a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/IDataProviderDao.java b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/IDataProviderDao.java
index d58f6be..ca09b88 100644
--- a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/IDataProviderDao.java
+++ b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/IDataProviderDao.java
@@ -27,7 +27,7 @@ import org.apache.openmeetings.db.entity.IDataProviderEntity;
*
* @author solomax, swagner
*
- * @param <T>
+ * @param <T> entity type for this provider
*/
public interface IDataProviderDao<T extends IDataProviderEntity> {
/**
@@ -80,6 +80,7 @@ public interface IDataProviderDao<T extends IDataProviderEntity> {
*
* @param entity - entity to be updated
* @param userId - user performed update
+ * @return - updated entity
*/
T update(T entity, Long userId);
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/basic/ConfigurationDao.java
----------------------------------------------------------------------
diff --git a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/basic/ConfigurationDao.java b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/basic/ConfigurationDao.java
index c5e4345..27bc446 100644
--- a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/basic/ConfigurationDao.java
+++ b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/basic/ConfigurationDao.java
@@ -109,11 +109,14 @@ import org.springframework.transaction.annotation.Transactional;
import com.github.openjson.JSONObject;
/**
- * Insert/update/Delete on {@link Configuration}<br/>
- * <br/>
- * It provides basic mechanism to get a Conf Key:<br/>
- * {@link #getConfValue(String, Class, String)} <br/>
- * <br/>
+ * Insert/update/Delete on {@link Configuration}
+ *
+ * It provides basic mechanism to get a Conf Key:
+ * {@link #getBool(String, boolean)}
+ * {@link #getLong(String, Long)}
+ * {@link #getInt(String, int)}
+ * {@link #getString(String, String)}
+ *
* <b> {@link #get(String)} is deprecated!</b>
*
* @author swagner
@@ -142,7 +145,7 @@ public class ConfigurationDao implements IDataProviderDao<Configuration> {
/**
* Retrieves Configuration regardless of its deleted status
*
- * @param key
+ * @param key - key of the {@link Configuration} to get
* @return correspondent {@link Configuration} or null
*/
public Configuration forceGet(String key) {
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/calendar/AppointmentDao.java
----------------------------------------------------------------------
diff --git a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/calendar/AppointmentDao.java b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/calendar/AppointmentDao.java
index adae9fb..2b905e4 100644
--- a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/calendar/AppointmentDao.java
+++ b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/calendar/AppointmentDao.java
@@ -31,6 +31,7 @@ import java.util.Set;
import javax.persistence.EntityManager;
import javax.persistence.PersistenceContext;
+import javax.persistence.Query;
import javax.persistence.TypedQuery;
import org.apache.openmeetings.db.dao.basic.ConfigurationDao;
@@ -249,14 +250,17 @@ public class AppointmentDao {
}
/**
- * Bulk Deletes the Appointments related the the calId.<br/>
+ * Bulk Deletes the Appointments related the the calId.
* Note: Does not automatically, commit, but gets cascaded in the function which calls it.
* If there is a need to commit during this function, use <code>em.flush()</code> and <code>em.clear()</code>
*
* @param calId Calendar Id of the Calendar Id to which the Appointments belong to.
* @return Returns <code>-1</code> if the there was an error executing the query,
* otherwise returns the number of updated rows.
- * @see Query#executeUpdate()
+ * as described here {@link Query#executeUpdate()}
+ *
+ * @param calId - id of the calendar
+ * @return - number of deleted items
*/
public int deletebyCalendar(Long calId) {
return em.createNamedQuery("deleteAppointmentsbyCalendar", Appointment.class)
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/calendar/MeetingMemberDao.java
----------------------------------------------------------------------
diff --git a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/calendar/MeetingMemberDao.java b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/calendar/MeetingMemberDao.java
index bb3ab4d..4fe4f0c 100644
--- a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/calendar/MeetingMemberDao.java
+++ b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/calendar/MeetingMemberDao.java
@@ -60,6 +60,9 @@ public class MeetingMemberDao {
/**
* Updating MeetingMember
+ *
+ * @param meetingMember - entity to update
+ * @return - updated entity
*/
// -------------------------------------------------------------------------------
public MeetingMember update(MeetingMember meetingMember) {
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/file/FileItemDao.java
----------------------------------------------------------------------
diff --git a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/file/FileItemDao.java b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/file/FileItemDao.java
index 2245232..e831a8b 100644
--- a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/file/FileItemDao.java
+++ b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/file/FileItemDao.java
@@ -128,8 +128,10 @@ public class FileItemDao extends BaseFileItemDao {
}
/**
- * @param id
- * @param name
+ * @param id - id of file item to rename
+ * @param name - new name
+ *
+ * @return renamed item
*/
public FileItem rename(Long id, String name) {
log.debug("rename started");
@@ -158,10 +160,12 @@ public class FileItemDao extends BaseFileItemDao {
}
/**
- * @param id
- * @param parentId
- * @param isOwner
- * @param roomId
+ * @param id - id of file item to move
+ * @param parentId - id of parent item
+ * @param ownerId - id of item owner
+ * @param roomId - id of room
+ *
+ * @return moved item
*/
public FileItem move(long id, long parentId, long ownerId, long roomId) {
log.debug(".move() started");
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/server/ISessionManager.java
----------------------------------------------------------------------
diff --git a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/server/ISessionManager.java b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/server/ISessionManager.java
index e92e95f..eaec577 100644
--- a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/server/ISessionManager.java
+++ b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/server/ISessionManager.java
@@ -38,30 +38,29 @@ public interface ISessionManager {
/**
* loads the server into the client (only if database cache is used)
*
- * @return
+ * @return - list of all clients
*/
Collection<StreamClient> list();
/**
* Get a client by its UID
*
- * @param uid
- * @return
+ * @param uid - uid of the client to get
+ * @return - client with giver uid
*/
StreamClient get(String uid);
/**
* Updates {@link StreamClient} in the cache
*
- * @param rcm
- * @return updated client
+ * @param rcm - client to update
*/
void update(IClient rcm);
/**
* Remove a client from the session store
*
- * @param uid
+ * @param uid - uid of the client to remove
* @return true if client was removed
*/
boolean remove(String uid);
@@ -71,40 +70,41 @@ public interface ISessionManager {
* needed cause it is invoked internally AFTER the current user has been
* already removed from the ClientList to see if the Room is empty again and
* the PollList can be removed
- * @param roomId
- * @return
+ *
+ * @param roomId - id of the room
+ * @return - list of all clients in the room
*/
List<StreamClient> listByRoom(Long roomId);
/**
* returns number of users performing recording
*
- * @param roomId
- * @return
+ * @param roomId - id of the room
+ * @return - number of recording clients (MUST be 0 or 1)
*/
long getRecordingCount(Long roomId);
/**
* returns a number of current users publishing screensharing
*
- * @param roomId
- * @return
+ * @param roomId - id of the room
+ * @return - number of publishing clients (MUST be 0 or 1)
*/
long getPublishingCount(Long roomId);
/**
* returns a number of users performing screen-sharing
*
- * @param roomId
- * @return MUST return 0 or 1
+ * @param roomId - id of the room
+ * @return - number of sharing clients (MUST be 0 or 1)
*/
long getSharingCount(Long roomId);
/**
* returns number of users sending A/V streams to server
*
- * @param roomId
- * @return
+ * @param roomId - id of the room
+ * @return - number of broadcasting clients
*/
long getBroadcastingCount(Long roomId);
@@ -118,7 +118,7 @@ public interface ISessionManager {
/**
* Get a list of rooms with users on particular cluster node.
*
- * @param server
+ * @param serverId - id of the server
* @return a set, a roomId can be only one time in this list
*/
Set<Long> getActiveRoomIds(String serverId);
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/server/SessiondataDao.java
----------------------------------------------------------------------
diff --git a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/server/SessiondataDao.java b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/server/SessiondataDao.java
index 6e65377..e7c800d 100644
--- a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/server/SessiondataDao.java
+++ b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/server/SessiondataDao.java
@@ -117,8 +117,8 @@ public class SessiondataDao {
/**
*
- * @param sid
- * @return
+ * @param sid - sid of {@link Sessiondata} to check
+ * @return - {@link Sessiondata} for given sid or new {@link Sessiondata}
*/
public Sessiondata check(String sid) {
Sessiondata sd = find(sid);
@@ -131,8 +131,8 @@ public class SessiondataDao {
/**
*
- * @param refreshed
- * @return
+ * @param refreshed - date to compare session update time with
+ * @return - the list of all expired session data
*/
private List<Sessiondata> getSessionToDelete(Date refreshed) {
try {
@@ -147,7 +147,7 @@ public class SessiondataDao {
/**
*
- * @param timeout
+ * @param timeout - timeout in millis to check expired sessions
*/
public void clearSessionTable(long timeout) {
try {
@@ -166,7 +166,7 @@ public class SessiondataDao {
}
/**
- * @param roomId
+ * @param roomId - room to clear sessions
*/
public void clearSessionByRoomId(Long roomId) {
try {
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/user/UserContactDao.java
----------------------------------------------------------------------
diff --git a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/user/UserContactDao.java b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/user/UserContactDao.java
index 0dda168..bac4307 100644
--- a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/user/UserContactDao.java
+++ b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/user/UserContactDao.java
@@ -62,14 +62,14 @@ public class UserContactDao {
}
/**
- * @param id
+ * @param id - id of item to delete
*/
public void delete(Long id) {
em.createNamedQuery("deleteUserContact").setParameter("id", id).executeUpdate();
}
/**
- * @param ownerId
+ * @param ownerId - id of owner
* @return rowcount of update
*/
public Integer deleteAllUserContacts(Long ownerId) {
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/user/UserDao.java
----------------------------------------------------------------------
diff --git a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/user/UserDao.java b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/user/UserDao.java
index 647c840..c092bd9 100644
--- a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/user/UserDao.java
+++ b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dao/user/UserDao.java
@@ -340,11 +340,11 @@ public class UserDao implements IGroupAdminDataProviderDao<User> {
/**
* check for duplicates
*
- * @param login
- * @param type
- * @param domainId
- * @param id
- * @return
+ * @param login - login to check
+ * @param type - user {@link Type} to check
+ * @param domainId - domain to check
+ * @param id - id of current user to allow self update
+ * @return <code>true</code> in case login is allowed
*/
public boolean checkLogin(String login, Type type, Long domainId, Long id) {
User u = getByLogin(login, type, domainId);
@@ -354,11 +354,11 @@ public class UserDao implements IGroupAdminDataProviderDao<User> {
/**
* Checks if a mail is already taken by someone else
*
- * @param email
- * @param type
- * @param domainId
- * @param id
- * @return
+ * @param email - email to check
+ * @param type - user {@link Type} to check
+ * @param domainId - domain to check
+ * @param id - id of current user to allow self update
+ * @return <code>true</code> in case email is allowed
*/
public boolean checkEmail(String email, Type type, Long domainId, Long id) {
log.debug("checkEmail: email = {}, id = {}", email, id);
@@ -410,8 +410,8 @@ public class UserDao implements IGroupAdminDataProviderDao<User> {
}
/**
- * @param search
- * @return
+ * @param search - term to search
+ * @return - number of matching user
*/
public Long selectMaxFromUsersWithSearch(String search) {
try {
@@ -419,7 +419,7 @@ public class UserDao implements IGroupAdminDataProviderDao<User> {
TypedQuery<Long> query = em.createNamedQuery("selectMaxFromUsersWithSearch", Long.class);
query.setParameter("search", StringUtils.lowerCase(search));
List<Long> ll = query.getResultList();
- log.info("selectMaxFromUsers" + ll.get(0));
+ log.info("selectMaxFromUsers {}", ll.get(0));
return ll.get(0);
} catch (Exception ex2) {
log.error("[selectMaxFromUsers] ", ex2);
@@ -430,9 +430,9 @@ public class UserDao implements IGroupAdminDataProviderDao<User> {
/**
* Returns true if the password is correct
*
- * @param userId
- * @param password
- * @return
+ * @param userId - id of the user to check
+ * @param password - password to check
+ * @return <code>true</code> if entered password is correct
*/
public boolean verifyPassword(Long userId, String password) {
List<String> l = em.createNamedQuery("getPassword", String.class)
@@ -496,8 +496,8 @@ public class UserDao implements IGroupAdminDataProviderDao<User> {
}
/**
- * @param hash
- * @return
+ * @param hash - activation hash
+ * @return user with this hash
*/
public User getByActivationHash(String hash) {
return getSingle(em.createQuery("SELECT u FROM User as u WHERE u.activatehash = :activatehash AND u.deleted = false", User.class)
@@ -579,8 +579,8 @@ public class UserDao implements IGroupAdminDataProviderDao<User> {
/**
* login logic
*
- * @param userOrEmail: login or email of the user being tested
- * @param userpass: password of the user being tested
+ * @param userOrEmail - login or email of the user being tested
+ * @param userpass - password of the user being tested
* @return User object in case of successful login
* @throws OmException in case of any issue
*/
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-db/src/main/java/org/apache/openmeetings/db/dto/room/InvitationDTO.java
----------------------------------------------------------------------
diff --git a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dto/room/InvitationDTO.java b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dto/room/InvitationDTO.java
index b320784..320c028 100644
--- a/openmeetings-db/src/main/java/org/apache/openmeetings/db/dto/room/InvitationDTO.java
+++ b/openmeetings-db/src/main/java/org/apache/openmeetings/db/dto/room/InvitationDTO.java
@@ -166,7 +166,7 @@ public class InvitationDTO implements Serializable {
/**
* Method to set valid to date-time in format YYYY-MM-dd HH:mm:ss
*
- * @param validFrom
+ * @param validTo
* date-time in format YYYY-MM-dd HH:mm:ss
*/
public void setValidTo(String validTo) {
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/record/Recording.java
----------------------------------------------------------------------
diff --git a/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/record/Recording.java b/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/record/Recording.java
index ef4ea7f..2600a05 100644
--- a/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/record/Recording.java
+++ b/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/record/Recording.java
@@ -45,16 +45,16 @@ import org.simpleframework.xml.ElementList;
import org.simpleframework.xml.Root;
/**
- * An item in the file explorer in the recording section. Can be either:<br/>
+ * An item in the file explorer in the recording section. Can be either:
* <ul>
* <li>a conference recording</li>
* <li>a interview recording</li>
* <li>a folder</li>
* </ul>
*
- * Recorded files are situated in: webapps/openmeetings/streams/hibernate.<br/>
+ * Recorded files are situated in: webapps/openmeetings/streams/hibernate.
* The raw recorded files are situated in:
- * webapps/openmeetings/streams/$ROOM_ID.<br/>
+ * webapps/openmeetings/streams/$ROOM_ID.
*
* @author sebawagner
*
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/record/RecordingMetaData.java
----------------------------------------------------------------------
diff --git a/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/record/RecordingMetaData.java b/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/record/RecordingMetaData.java
index 7839386..b3cc956 100644
--- a/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/record/RecordingMetaData.java
+++ b/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/record/RecordingMetaData.java
@@ -44,7 +44,7 @@ import org.simpleframework.xml.Root;
* contains meta data about each stream, for example if it is a screen sharing or
* audio/video stream. There is also a {@link Status} value
* {@link #streamStatus}, as long as this variable is not set
- * to {@link Status.STOPPED}, the recording process will not proceed and start to convert all
+ * to {@link Status#STOPPED}, the recording process will not proceed and start to convert all
* input sources to a single recording file.
*
* @author sebawagner
@@ -119,7 +119,6 @@ public class RecordingMetaData extends HistoricalEntity {
/**
* this is only STOPPED when the asynchronous stream writer's have completed to write packets to the file.
- * @see BaseStreamWriter#closeStream()
*/
@Column(name = "stream_status")
@Enumerated(EnumType.STRING)
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/room/RoomPollAnswer.java
----------------------------------------------------------------------
diff --git a/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/room/RoomPollAnswer.java b/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/room/RoomPollAnswer.java
index d8011ac..be298be 100644
--- a/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/room/RoomPollAnswer.java
+++ b/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/room/RoomPollAnswer.java
@@ -131,15 +131,15 @@ public class RoomPollAnswer implements IDataProviderEntity {
}
/**
- * @return the votedClient
+ * @return the voted {@link User}
*/
public User getVotedUser() {
return votedUser;
}
/**
- * @param votedClient
- * the votedClient to set
+ * @param votedUser
+ * the voted {@link User} to set
*/
public void setVotedUser(User votedUser) {
this.votedUser = votedUser;
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/server/RemoteSessionObject.java
----------------------------------------------------------------------
diff --git a/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/server/RemoteSessionObject.java b/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/server/RemoteSessionObject.java
index af6a9ff..4cef503 100644
--- a/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/server/RemoteSessionObject.java
+++ b/openmeetings-db/src/main/java/org/apache/openmeetings/db/entity/server/RemoteSessionObject.java
@@ -65,13 +65,13 @@ public class RemoteSessionObject {
}
/**
- * @param username
- * @param firstname
- * @param lastname
- * @param pictureUrl
- * @param email
- * @param externalUserId
- * @param externalUserType
+ * @param username - username
+ * @param firstname - first name
+ * @param lastname - last name
+ * @param pictureUrl - picture url
+ * @param email - email
+ * @param externalUserId - external user id
+ * @param externalUserType - external user type
*
* 06.09.2009 17:05:48
* sebastianwagner
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-db/src/main/java/org/apache/openmeetings/db/util/FormatHelper.java
----------------------------------------------------------------------
diff --git a/openmeetings-db/src/main/java/org/apache/openmeetings/db/util/FormatHelper.java b/openmeetings-db/src/main/java/org/apache/openmeetings/db/util/FormatHelper.java
index 3a98027..420a4ea 100644
--- a/openmeetings-db/src/main/java/org/apache/openmeetings/db/util/FormatHelper.java
+++ b/openmeetings-db/src/main/java/org/apache/openmeetings/db/util/FormatHelper.java
@@ -60,6 +60,9 @@ public class FormatHelper {
* http://www.iana.org/assignments/language-subtag-registry, as well as
* Sindhi (sd) and Uyghur (ug). The presence of other subtags of the
* language code, e.g. regions like EG (Egypt), is ignored.
+ *
+ * @param languageString - locale string
+ * @return <code>true</code> in case passed locale is right-to-left
*/
public static boolean isRtlLanguage(String languageString) {
return languageString != null && RtlLocalesRe.matcher(languageString).find();
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-db/src/main/java/org/apache/openmeetings/db/util/TimezoneUtil.java
----------------------------------------------------------------------
diff --git a/openmeetings-db/src/main/java/org/apache/openmeetings/db/util/TimezoneUtil.java b/openmeetings-db/src/main/java/org/apache/openmeetings/db/util/TimezoneUtil.java
index 08a0476..7e5169f 100644
--- a/openmeetings-db/src/main/java/org/apache/openmeetings/db/util/TimezoneUtil.java
+++ b/openmeetings-db/src/main/java/org/apache/openmeetings/db/util/TimezoneUtil.java
@@ -42,10 +42,12 @@ public class TimezoneUtil {
}
/**
- * Returns the timezone based on the user profile, if not return the timezone from the server
+ * Returns the timezone based on the user profile, if not return the timezone
+ * from the server
*
* @param user
- * @return
+ * to get timezone for
+ * @return {@link TimeZone} of given user
*/
public static TimeZone getTimeZone(User user) {
return getTimeZone(user == null ? null : user.getTimeZoneId());
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-util/src/main/java/org/apache/openmeetings/util/ImportHelper.java
----------------------------------------------------------------------
diff --git a/openmeetings-util/src/main/java/org/apache/openmeetings/util/ImportHelper.java b/openmeetings-util/src/main/java/org/apache/openmeetings/util/ImportHelper.java
index d5488c1..13fc997 100644
--- a/openmeetings-util/src/main/java/org/apache/openmeetings/util/ImportHelper.java
+++ b/openmeetings-util/src/main/java/org/apache/openmeetings/util/ImportHelper.java
@@ -35,7 +35,8 @@ public class ImportHelper {
* returns a list of all timezones as a {@link Map}
*
* @param tzList
- * @return
+ * - timezones to put to resulting {@link Map}
+ * @return {@link Map} with passed time zones as key and value
*/
public static Map<String, String> getAllTimeZones(String ... tzList) {
Map<String, String> result = new LinkedHashMap<>();
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-util/src/main/java/org/apache/openmeetings/util/mail/IcalHandler.java
----------------------------------------------------------------------
diff --git a/openmeetings-util/src/main/java/org/apache/openmeetings/util/mail/IcalHandler.java b/openmeetings-util/src/main/java/org/apache/openmeetings/util/mail/IcalHandler.java
index 2564e7f..5f6596f 100644
--- a/openmeetings-util/src/main/java/org/apache/openmeetings/util/mail/IcalHandler.java
+++ b/openmeetings-util/src/main/java/org/apache/openmeetings/util/mail/IcalHandler.java
@@ -79,8 +79,7 @@ public class IcalHandler {
* Constructor
*
* @param method
- * (@see IcalHandler Constants)
- * @throws Exception
+ * (@see IcalHandler) constants
*/
public IcalHandler(Method method) {
log.debug("Icalhandler method type : " + method);
@@ -170,6 +169,14 @@ public class IcalHandler {
/**
* Use this function to build a valid record for the AttendeeList for
* addMeetings Generate a Attendee
+ *
+ * @param emailAdress
+ * - email of attendee
+ * @param displayName
+ * - name of attendee
+ * @param chair
+ * - is this organizer
+ * @return attendee data as {@link Map}
*/
public Map<String, String> getAttendeeData(String emailAdress, String displayName, boolean chair) {
Map<String, String> oneRecord = new HashMap<>();
@@ -182,6 +189,11 @@ public class IcalHandler {
/**
* Write iCal to File
+ *
+ * @param _filerPath
+ * - path to '*.ics' file
+ * @throws Exception
+ * - in case of error during writing to the file
*/
public void writeDataToFile(String _filerPath) throws Exception {
String filerPath = _filerPath.endsWith(".ics") ? _filerPath
@@ -195,6 +207,10 @@ public class IcalHandler {
/**
* Get IcalBody as ByteArray
+ *
+ * @return - calendar in ICS format as byte[]
+ * @throws Exception
+ * - in case of error during writing to byte array
*/
public byte[] getIcalAsByteArray() throws Exception {
ByteArrayOutputStream bout = new ByteArrayOutputStream();
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/508ad005/openmeetings-web/pom.xml
----------------------------------------------------------------------
diff --git a/openmeetings-web/pom.xml b/openmeetings-web/pom.xml
index 6e82f53..8ac81b3 100644
--- a/openmeetings-web/pom.xml
+++ b/openmeetings-web/pom.xml
@@ -30,7 +30,7 @@
<name>Openmeetings Web</name>
<description>Module for all Wicket based UI OpenMeetings components</description>
<properties>
- <mysql.version>5.1.44</mysql.version>
+ <mysql.version>5.1.45</mysql.version>
<mssql.version>6.2.1.jre8</mssql.version>
<old-backups.dir>${project.build.directory}/test-data</old-backups.dir>
<site.basedir>${project.parent.basedir}</site.basedir>