com.jivesoftware.base.database
Class DbGroup

java.lang.Object
  com.jivesoftware.base.database.DbGroup

All Implemented Interfaces:

Group, Cacheable, com.tangosol.io.ExternalizableLite, java.io.Serializable

public class DbGroup
extends java.lang.Object
implements Group, Cacheable, com.tangosol.io.ExternalizableLite

Database implementation of the Group interface.

See Also:

Group, Serialized Form

Constructor Summary

	DbGroup() Constructor for internal use only.
protected	DbGroup(long id) Loads a group from the database based on its id.
protected	DbGroup(long id, java.lang.String name) Creates a new group.
protected	DbGroup(java.lang.String name) Creates a new group.
protected	DbGroup(java.lang.String name, java.lang.Object fake) Loads a group from the database based on its name.

Method Summary

void	addAdministrator(User user) Grants administrator privileges of the group to a user.
void	addMember(User user) Adds a member to the group.
void	deleteProperty(java.lang.String name) Deletes an extended property.
boolean	equals(java.lang.Object object)
int	getAdministratorCount() Returns the number of group administrators.
java.util.Iterator	getAdministrators() An iterator for all the users that are administrators of the group.
int	getCachedSize() Returns the approximate size of the Object in bytes.
java.util.Date	getCreationDate() Returns the date that the group was created.
java.lang.String	getDescription() Returns the description of the group.
long	getID() Returns the id of the group.
int	getMemberCount() Returns the number of group members.
java.util.Iterator	getMembers() An iterator for all the users that are members of the group.
java.util.Date	getModificationDate() Returns the date that the group was last modified.
java.lang.String	getName() Returns the name of the group.
Permissions	getPermissions(AuthToken auth) Returns the permissions for the group that correspond to the passed-in AuthToken.
java.lang.String	getProperty(java.lang.String name) Returns an extended property of the group.
java.util.Iterator	getPropertyNames() Returns an Iterator for all the names of the extended group properties.
int	hashCode()
boolean	isAdministrator(User user) Returns true if the User has group administrator permissions.
boolean	isAuthorized(long permissionType) Returns true if the handle on the object has the permission specified.
boolean	isMember(User user) Returns true if if the User is a member of the group.
void	readExternal(java.io.DataInput in)
void	removeAdministrator(User user) Revokes administrator privileges of the group to a user.
void	removeMember(User user) Removes a member from the group.
void	setCreationDate(java.util.Date creationDate) Sets the creation date of the group.
void	setDescription(java.lang.String description) Sets the description of the group.
void	setModificationDate(java.util.Date modificationDate) Sets the date the group was last modified.
void	setName(java.lang.String name) Sets the name of the group.
void	setProperty(java.lang.String name, java.lang.String value) Sets an extended property of the group.
java.lang.String	toString() Returns a String representation of the Group object using the group name.
protected void	updateModificationDate(long date, java.sql.Connection con) Updates the modified date.
void	writeExternal(java.io.DataOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DbGroup

protected DbGroup(java.lang.String name)

Creates a new group.

Parameters:

name - the name of the group.

DbGroup

protected DbGroup(long id,
                  java.lang.String name)

Creates a new group. This constructor is only intended to be used for mass importing groups via the xml export/import utility.

DbGroup

protected DbGroup(long id)
           throws GroupNotFoundException

Loads a group from the database based on its id.

Parameters:

id - the id of the group to load.

Throws:

GroupNotFoundException

DbGroup

protected DbGroup(java.lang.String name,
                  java.lang.Object fake)
           throws GroupNotFoundException

Loads a group from the database based on its name. The implementation of this method is rather hackish since it includes a fake parameter just so that it can have a different method signature than the first constructor. Even so, this methodology makes this class behave more like our other classes, so we're gleefully leaving it this way. :)

Parameters:

name - the name of the group to load.

fake - a fake paramater that can always be null.

Throws:

GroupNotFoundException

DbGroup

public DbGroup()

Constructor for internal use only.

Method Detail

readExternal

public void readExternal(java.io.DataInput in)
                  throws java.io.IOException

Specified by:

readExternal in interface com.tangosol.io.ExternalizableLite

Throws:

java.io.IOException

writeExternal

public void writeExternal(java.io.DataOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface com.tangosol.io.ExternalizableLite

Throws:

java.io.IOException

getID

public long getID()

Description copied from interface: Group

Returns the id of the group.

Specified by:

getID in interface Group

Returns:

the id of the group.

getName

public java.lang.String getName()

Description copied from interface: Group

Returns the name of the group. For example, 'XYZ Admins'.

Specified by:

getName in interface Group

Returns:

the name of the group.

setName

public void setName(java.lang.String name)
             throws UnauthorizedException

Description copied from interface: Group

Sets the name of the group. For example, 'XYZ Admins'. This method is restricted to those with group administration permission.

Specified by:

setName in interface Group

Parameters:

name - the name for the group.

Throws:

UnauthorizedException - if does not have group administrator permissions.

getDescription

public java.lang.String getDescription()

Description copied from interface: Group

Returns the description of the group. The description often summarizes a group's function, such as 'Administrators of the XYZ forum'.

Specified by:

getDescription in interface Group

Returns:

the description of the group.

setDescription

public void setDescription(java.lang.String description)
                    throws UnauthorizedException

Description copied from interface: Group

Sets the description of the group. The description often summarizes a group's function, such as 'Administrators of the XYZ forum'. This method is restricted to those with group administration permission.

Specified by:

setDescription in interface Group

Parameters:

description - the description of the group.

Throws:

UnauthorizedException - if does not have group administrator permissions.

getCreationDate

public java.util.Date getCreationDate()

Description copied from interface: Group

Returns the date that the group was created.

Specified by:

getCreationDate in interface Group

Returns:

the date the group was created.

setCreationDate

public void setCreationDate(java.util.Date creationDate)
                     throws UnauthorizedException

Description copied from interface: Group

Sets the creation date of the group. In most cases, the creation date will default to when the group was entered into the system. However, the date needs to be set manually when importing data. In other words, skin authors should ignore this method since it only intended for system maintenance.

Specified by:

setCreationDate in interface Group

Parameters:

creationDate - the date the group was created.

Throws:

UnauthorizedException - if does not have administrator permissions.

getModificationDate

public java.util.Date getModificationDate()

Description copied from interface: Group

Returns the date that the group was last modified.

Specified by:

getModificationDate in interface Group

Returns:

the date the group record was last modified.

setModificationDate

public void setModificationDate(java.util.Date modificationDate)
                         throws UnauthorizedException

Description copied from interface: Group

Sets the date the group was last modified. Skin authors should ignore this method since it only intended for system maintenance.

Specified by:

setModificationDate in interface Group

Parameters:

modificationDate - the date the group was modified.

Throws:

UnauthorizedException - if does not have administrator permissions.

getProperty

public java.lang.String getProperty(java.lang.String name)

Description copied from interface: Group

Returns an extended property of the group. Each group can have an arbitrary number of extended properties. This lets particular skins or filters provide enhanced functionality that is not part of the base interface.

Specified by:

getProperty in interface Group

Parameters:

name - the name of the property to get.

Returns:

the value of the property

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)

Description copied from interface: Group

Sets an extended property of the group. Each group can have an arbitrary number of extended properties. This lets particular skins or filters provide enhanced functionality that is not part of the base interface.

Specified by:

setProperty in interface Group

Parameters:

name - the name of the property to set.

value - the new value for the property.

deleteProperty

public void deleteProperty(java.lang.String name)

Description copied from interface: Group

Deletes an extended property. If the property specified by name does not exist, this method will do nothing.

Specified by:

deleteProperty in interface Group

Parameters:

name - the name of the property to delete.

getPropertyNames

public java.util.Iterator getPropertyNames()

Description copied from interface: Group

Returns an Iterator for all the names of the extended group properties.

Specified by:

getPropertyNames in interface Group

Returns:

an Iterator for the property names.

addAdministrator

public void addAdministrator(User user)
                      throws UnauthorizedException

Description copied from interface: Group

Grants administrator privileges of the group to a user. This method is restricted to those with group administration permission.

Specified by:

addAdministrator in interface Group

Parameters:

user - the User to grant adminstrative privileges to.

Throws:

UnauthorizedException - if does not have group administrator permissions.

removeAdministrator

public void removeAdministrator(User user)
                         throws UnauthorizedException

Description copied from interface: Group

Revokes administrator privileges of the group to a user. This method is restricted to those with group administration permission.

Specified by:

removeAdministrator in interface Group

Parameters:

user - the User to grant adminstrative privileges to.

Throws:

UnauthorizedException - if does not have group administrator permissions.

addMember

public void addMember(User user)
               throws UnauthorizedException

Description copied from interface: Group

Adds a member to the group. This method is restricted to those with group administration permission.

Specified by:

addMember in interface Group

Parameters:

user - the User to add to the group.

Throws:

UnauthorizedException - if does not have group administrator permissions.

removeMember

public void removeMember(User user)
                  throws UnauthorizedException

Description copied from interface: Group

Removes a member from the group. If the User is not in the group, this method does nothing. This method is restricted to those with group administration permission.

Specified by:

removeMember in interface Group

Parameters:

user - the User to remove from the group.

Throws:

UnauthorizedException - if does not have group administrator permissions.

isAdministrator

public boolean isAdministrator(User user)

Description copied from interface: Group

Returns true if the User has group administrator permissions.

Specified by:

isAdministrator in interface Group

Returns:

true if the User is an administrator of the group.

isMember

public boolean isMember(User user)

Description copied from interface: Group

Returns true if if the User is a member of the group.

Specified by:

isMember in interface Group

Returns:

true if the User is a member of the group.

getAdministratorCount

public int getAdministratorCount()

Description copied from interface: Group

Returns the number of group administrators.

Specified by:

getAdministratorCount in interface Group

Returns:

the number of group administrators.

getMemberCount

public int getMemberCount()

Description copied from interface: Group

Returns the number of group members.

Specified by:

getMemberCount in interface Group

Returns:

the number of group members.

getMembers

public java.util.Iterator getMembers()

Description copied from interface: Group

An iterator for all the users that are members of the group.

Specified by:

getMembers in interface Group

Returns:

an Iterator for all members of the group.

getAdministrators

public java.util.Iterator getAdministrators()

Description copied from interface: Group

An iterator for all the users that are administrators of the group.

Specified by:

getAdministrators in interface Group

Returns:

an Iterator for all administrators of the group.

getPermissions

public Permissions getPermissions(AuthToken auth)

Description copied from interface: Group

Returns the permissions for the group that correspond to the passed-in AuthToken.

Specified by:

getPermissions in interface Group

Parameters:

auth - the auth token to lookup permissions for.

Returns:

the permissions for the group that correspond to the passed-in AuthToken.

See Also:

Permissions

isAuthorized

public boolean isAuthorized(long permissionType)

Description copied from interface: Group

Returns true if the handle on the object has the permission specified. A list of possible permissions can be found in the Permissions class. Certain methods of this class are restricted to certain permissions as specified in the method comments.

Specified by:

isAuthorized in interface Group

Parameters:

permissionType - a permission type.

Returns:

true if the specified permission is valid.

See Also:

Permissions

getCachedSize

public int getCachedSize()

Description copied from interface: Cacheable

Returns the approximate size of the Object in bytes. The size should be considered to be a best estimate of how much memory the Object occupies and may be based on empirical trials or dynamic calculations.

Specified by:

getCachedSize in interface Cacheable

Returns:

the size of the Object in bytes.

toString

public java.lang.String toString()

Returns a String representation of the Group object using the group name.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of the Group object.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

updateModificationDate

protected void updateModificationDate(long date,
                                      java.sql.Connection con)
                               throws java.sql.SQLException

Updates the modified date. It accepts a Connection so that it can participate in transactions.

Throws:

java.sql.SQLException