jhelp.util.post

Class PostOffice

java.lang.Object

jhelp.util.post.PostOffice

public class PostOffice
extends java.lang.Object

Post office for deliver Message between users.
Each User have to register for be able receive Message.
2 different users can't have the same name

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private ThreadedSimpleTask<Pair<Message,User>>	giveMessage Deliver message to user in separate thread
private java.util.HashMap<java.lang.String,SortedArray<java.lang.String>>	groups Groups map
static PostOffice	POST_OFFICE Post office singleton
private java.util.HashMap<java.lang.String,User>	users Users map

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PostOffice() Create a new instance of PostOffice

Method Summary

Methods

Modifier and Type	Method and Description
void	addToGroup(User user, java.lang.String group) Add a user to a group.
java.util.Set<java.lang.String>	getGroupNames() Set of actual groups
java.util.List<java.lang.String>	getGroupsFor(java.lang.String user) Give the list where the user is in
java.util.List<java.lang.String>	getMembers(java.lang.String group) Give the list of the members of a group
java.util.Set<java.lang.String>	getUserNames() List of registered users
boolean	isInGroup(User user, java.lang.String group) Indicates if a user is in a group
boolean	isRegisteredUser(java.lang.String user) Indicates if a user is registered
boolean	postMessage(User sender, int messageId, java.lang.String destination, java.lang.Object message) Post a message for a specific user
void	postMessageForAll(User sender, int messageId, java.lang.Object message, boolean excludeMe) Post a message for all registered users
void	postMessageForGroup(User sender, int messageId, java.lang.String group, java.lang.Object message) Post a message for all members of a group
void	registerUser(User user) Register a user
void	removeFromGroup(User user, java.lang.String group) Remove a user from a group
void	unregisterUser(User user) Unregister a user

Methods inherited from class java.lang.Object

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

Field Detail

POST_OFFICE

public static final PostOffice POST_OFFICE

Post office singleton

giveMessage

private final ThreadedSimpleTask<Pair<Message,User>> giveMessage

Deliver message to user in separate thread

groups

private final java.util.HashMap<java.lang.String,SortedArray<java.lang.String>> groups

Groups map

users

private final java.util.HashMap<java.lang.String,User> users

Users map

Constructor Detail

PostOffice

private PostOffice()

Create a new instance of PostOffice

Method Detail

addToGroup

public void addToGroup(User user,
              java.lang.String group)

Add a user to a group.
If the user is not already registered, it is automatically register.
If the group not already exits, it is created

Parameters:

user - User to add

group - Group where add.

getGroupNames

public java.util.Set<java.lang.String> getGroupNames()

Set of actual groups

Returns:

Set of actual groups

getGroupsFor

public java.util.List<java.lang.String> getGroupsFor(java.lang.String user)

Give the list where the user is in

Parameters:

user - User name

Returns:

List of groups where is the user

getMembers

public java.util.List<java.lang.String> getMembers(java.lang.String group)

Give the list of the members of a group

Parameters:

group - Group name

Returns:

List of members

getUserNames

public java.util.Set<java.lang.String> getUserNames()

List of registered users

Returns:

List of registered users

isInGroup

public boolean isInGroup(User user,
                java.lang.String group)

Indicates if a user is in a group

Parameters:

user - User tested

group - Group name

Returns:

true if the user is in the group

isRegisteredUser

public boolean isRegisteredUser(java.lang.String user)

Indicates if a user is registered

Parameters:

user - User name tested

Returns:

true if the user is registered

postMessage

public boolean postMessage(User sender,
                  int messageId,
                  java.lang.String destination,
                  java.lang.Object message)

Post a message for a specific user

Parameters:

sender - Message sender

messageId - Message ID

destination - User destination

message - Message to send

Returns:

true if message posted.false if message not posted, because the destination user dosen't exits

postMessageForAll

public void postMessageForAll(User sender,
                     int messageId,
                     java.lang.Object message,
                     boolean excludeMe)

Post a message for all registered users

Parameters:

sender - Sender of message

messageId - Message ID

message - Message it self

excludeMe - Indicates if the sender is not in the distribution

postMessageForGroup

public void postMessageForGroup(User sender,
                       int messageId,
                       java.lang.String group,
                       java.lang.Object message)

Post a message for all members of a group

Parameters:

sender - Sender

messageId - Message ID

group - Group to send

message - Message itself

registerUser

public void registerUser(User user)

Register a user

Parameters:

user - User to register

removeFromGroup

public void removeFromGroup(User user,
                   java.lang.String group)

Remove a user from a group

Parameters:

user - User to remove

group - Group where remove

unregisterUser

public void unregisterUser(User user)

Unregister a user

Parameters:

user - User to unregister