001: /*
002: * Copyright (c) 2001 - 2005 ivata limited.
003: * All rights reserved.
004: * -----------------------------------------------------------------------------
005: * ivata groupware may be redistributed under the GNU General Public
006: * License as published by the Free Software Foundation;
007: * version 2 of the License.
008: *
009: * These programs are free software; you can redistribute them and/or
010: * modify them under the terms of the GNU General Public License
011: * as published by the Free Software Foundation; version 2 of the License.
012: *
013: * These programs are distributed in the hope that they will be useful,
014: * but WITHOUT ANY WARRANTY; without even the implied warranty of
015: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
016: *
017: * See the GNU General Public License in the file LICENSE.txt for more
018: * details.
019: *
020: * If you would like a copy of the GNU General Public License write to
021: *
022: * Free Software Foundation, Inc.
023: * 59 Temple Place - Suite 330
024: * Boston, MA 02111-1307, USA.
025: *
026: *
027: * To arrange commercial support and licensing, contact ivata at
028: * http://www.ivata.com/contact.jsp
029: * -----------------------------------------------------------------------------
030: * $Log: UserEvent.java,v $
031: * Revision 1.6 2005/10/02 14:08:58 colinmacleod
032: * Added/improved log4j logging.
033: *
034: * Revision 1.5 2005/09/29 14:17:04 colinmacleod
035: * Split UserGroupDO off from GroupDO.
036: * Moved UserGroupDO, Right classes to security subproject (from
037: * addressbook).
038: * Centralized user right handling into Rights and RightsImpl.
039: *
040: * Revision 1.4 2005/09/14 16:10:22 colinmacleod
041: * Removed unused local and class variables.
042: * Added serialVersionUID.
043: *
044: * Revision 1.3 2005/04/10 18:47:41 colinmacleod
045: * Changed i tag to em and b tag to strong.
046: *
047: * Revision 1.2 2005/04/09 17:19:57 colinmacleod
048: * Changed copyright text to GPL v2 explicitly.
049: *
050: * Revision 1.1.1.1 2005/03/10 17:51:42 colinmacleod
051: * Restructured ivata op around Hibernate/PicoContainer.
052: * Renamed ivata groupware.
053: *
054: * Revision 1.1 2004/09/30 15:15:59 colinmacleod
055: * Split off addressbook elements into security subproject.
056: *
057: * Revision 1.1 2004/07/13 19:15:26 colinmacleod
058: * Moved from business.addressbook to admin.security.
059: *
060: * Revision 1.2 2004/03/21 21:16:07 colinmacleod
061: * Shortened name to ivata op.
062: *
063: * Revision 1.1.1.1 2004/01/27 20:57:52 colinmacleod
064: * Moved ivata openportal to SourceForge..
065: *
066: * Revision 1.2 2003/10/15 13:18:02 colin
067: * fixing for XDoclet
068: * -----------------------------------------------------------------------------
069: */
070: package com.ivata.groupware.admin.security.user;
071:
072: import org.apache.log4j.Logger;
073:
074: import com.ivata.groupware.business.event.Event;
075:
076: /**
077: * <p>To implement a specific event with detail specific to your system, you
078: * need to extend this class.</p>
079: *
080: * @author Colin MacLeod
081: * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
082: */
083: public class UserEvent extends Event {
084: /**
085: * Logger for this class.
086: */
087: private static final Logger logger = Logger
088: .getLogger(UserEvent.class);
089:
090: /**
091: * Serialization version (for <code>Serializable</code> interface).
092: */
093: private static final long serialVersionUID = 1L;
094: /**
095: * <p>Stores the user name for the user this event relates to.</p>
096: */
097: private String userName = null;
098:
099: /**
100: * <p>Construct an event and set the name of the <em>JMS</em> topic associated
101: * with this event.</p>
102: *
103: * @param userName the name of the user with whom this event is associated.
104: * @param topic set to one of the constants in <code>UserEventConstants</code>.
105: * @see com.ivata.groupware.admin.security.user.group.right.RightConstants
106: */
107: public UserEvent(String userNameParam, String topic) {
108: super (topic);
109: userName = userNameParam;
110: }
111:
112: /**
113: * <p>Get the user name for the user this event relates to.</p>
114: *
115: * @return the user name for the user this event relates to.</p>
116: */
117: public final String getUserName() {
118: if (logger.isDebugEnabled()) {
119: logger.debug("getUserName() - start");
120: }
121:
122: if (logger.isDebugEnabled()) {
123: logger.debug("getUserName() - end - return value = "
124: + userName);
125: }
126: return userName;
127: }
128:
129: }
|