Package com.planet_ink.coffee_mud.Libraries

Class CMJournals

java.lang.Object

com.planet_ink.coffee_mud.Libraries.StdLibrary

com.planet_ink.coffee_mud.Libraries.CMJournals

All Implemented Interfaces:

CMObject, Tickable, CMLibrary, JournalsLibrary, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class CMJournals
extends StdLibrary
implements JournalsLibrary

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CMJournals.JScriptWindow

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.JournalsLibrary

JournalsLibrary.CommandJournal, JournalsLibrary.CommandJournalFlags, JournalsLibrary.ForumJournal, JournalsLibrary.ForumJournalFlags, JournalsLibrary.JournalMetaData, JournalsLibrary.MsgMkrCallback, JournalsLibrary.MsgMkrResolution, JournalsLibrary.SMTPJournal

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,java.util.List<JournalsLibrary.ForumJournal>>	clanForums
protected SHashtable<java.lang.String,JournalsLibrary.CommandJournal>	commandJournals
protected PairList<java.lang.Long,java.lang.String>	cronJobs
protected static java.util.List<JournalsLibrary.ForumJournal>	emptyForums
protected SHashtable<java.lang.String,JournalsLibrary.ForumJournal>	forumJournals
protected java.util.Vector<JournalsLibrary.ForumJournal>	forumJournalsSorted
protected int	lastMotdDate
protected long	lastSweepTime
protected java.util.List<JournalEntry>	nextEvents
int	QUEUE_SIZE
protected static int	SWEEP_TICK_MAX
protected int	sweepTickDown

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Fields inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.JournalsLibrary

JOURNAL_BOUNDARY

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

isDebugging, name, serviceClient, tickStatus

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable

STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors

Constructor	Description
CMJournals()

Method Summary

Modifier and Type	Method	Description
boolean	activate()	Activates the library.
boolean	canReadMessage(JournalEntry entry, java.lang.String srchMatch, MOB readerM, boolean ignorePrivileges)	A security checker for whether the given user can read the given message.
void	clearJournalSummaryStats(JournalsLibrary.ForumJournal journal)	Clears the forum journal summary stats so that they can be rebuilt from the database.
java.util.Enumeration<JournalsLibrary.CommandJournal>	commandJournals()	Returns an enumeration of all registered command journals
protected void	expirationJournalSweep()
java.util.Enumeration<JournalsLibrary.ForumJournal>	forumJournals()	Returns an enumeration of all normal forumJournals (not clan ones).
java.util.Enumeration<JournalsLibrary.ForumJournal>	forumJournalsSorted()	Returns an enumeration of all normal ForumJournals (not clan ones), sorted by somehow.
java.util.Set<java.lang.String>	getArchonJournalNames()	Returns the cached set of basic items that implement the ArchonOnly interface, thus making them ArchonOnly journals.
protected java.lang.String	getCalendarEvent(TimeClock localClock, JournalEntry event)
java.util.List<JournalsLibrary.ForumJournal>	getClanForums(Clan clan)	Returns the list of ForumJournals that exist for the given clan.
JournalsLibrary.CommandJournal	getCommandJournal(java.lang.String named)	Returns the information about the Command Journal of the given name.
JournalsLibrary.ForumJournal	getForumJournal(java.lang.String named)	Returns a ForumJournal of the given name.
JournalsLibrary.ForumJournal	getForumJournal(java.lang.String named, Clan clan)	Retreives a specific forum journal given to a particular clan.
JournalsLibrary.JournalMetaData	getJournalStats(JournalsLibrary.ForumJournal journal)	Get the forum journal summary stats, caching them after calculation from the database
protected java.lang.String	getMsgMkrHelp(Session sess)
int	getNumCommandJournals()	Returns the number of command journals, or journals written to using standard game commands.
int	getNumForumJournals()	Returns the number of forum journals.
java.lang.String	getScriptValue(MOB mob, java.lang.String journal, java.lang.String oldValue)	If the given journal requires running a MOBPROG script in order to produce a final message, this function will run that script.
protected java.util.Hashtable<java.lang.String,JournalsLibrary.JournalMetaData>	getSummaryStats()
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
protected void	initializeCalendarEvents()
boolean	isArchonJournalName(java.lang.String journal)	Returns whether the given journal appears on the archon journal names list.
int	loadCommandJournals(java.lang.String list)	Given an encoded journals list string, this function will register all the CommandJournals described by the encoded list string.
int	loadForumJournals(java.lang.String list)	Loads the forumjournals from the given encoded forum definition string.
protected JournalsLibrary.MsgMkrResolution	makeMessage(MOB mob, java.lang.String messageTitle, java.util.List<java.lang.String> vbuf, boolean autoAdd)
void	makeMessageASync(MOB M, java.lang.String messageTitle, java.util.List<java.lang.String> vbuf, boolean autoAdd, JournalsLibrary.MsgMkrCallback back)	An asynchronous system for allowing a user to edit a text document with options for search and replace, line inserting and deleting, and line replacement.
void	notifyPosting(java.lang.String journal, java.lang.String from, java.lang.String to, java.lang.String subject)	Whenever a post to a journal is made, this function is called to send a notification to online users who have subscribed to such things.
void	notifyReplying(java.lang.String journal, java.lang.String tpAuthor, java.lang.String reAuthor, java.lang.String subject)	Whenever a reply to a journal is made, this function is called to send a notification to online users who have subscribed to such things.
java.util.List<JournalsLibrary.ForumJournal>	parseForumJournals(java.lang.String list)
protected void	postCalendarEventTo(JournalEntry event, java.util.List<Area> areas, MOB M)
protected void	processCalendarEvents()
protected JournalEntry	processCalendarExpiration(JournalEntry expiredEntry)
void	registerClanForum(Clan clan, java.lang.String allClanForumDefs)	Registers a set of ForumJournals for the given clan from the coded string.
void	resetCalendarEvents()	Since Calendar events are also journal entries, whenever the calendar is changed, this method must be called to make sure notifications for new events occurs.
protected void	resetCalendarEvents(long now)
protected long	runCronJob(java.lang.String jobKey, boolean debug)
boolean	shutdown()	Shuts down the library.
boolean	subscribeToJournal(java.lang.String journalName, java.lang.String userName, boolean saveMailingList)	Called to add a user to the subscription list for a journal.
boolean	tick(Tickable ticking, int tickID)	this is the method which is called periodically by the threading engine.
boolean	unsubscribeFromAll(java.lang.String username)	Unsubscribes the given user/account from every mailing list.
boolean	unsubscribeFromJournal(java.lang.String journalName, java.lang.String userName, boolean saveMailingList)	Called to remove a user from the subscription list for a journal.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

getServiceClient, L, propertiesLoaded

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from class java.lang.Object

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

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, initializeClass, L, name, newInstance, propertiesLoaded, setThreadStatus

Field Detail

QUEUE_SIZE

public final int QUEUE_SIZE

See Also:

Constant Field Values

SWEEP_TICK_MAX

protected static final int SWEEP_TICK_MAX

See Also:

Constant Field Values

sweepTickDown

protected volatile int sweepTickDown

lastSweepTime

protected volatile long lastSweepTime

commandJournals

protected final SHashtable<java.lang.String,JournalsLibrary.CommandJournal> commandJournals

forumJournalsSorted

protected final java.util.Vector<JournalsLibrary.ForumJournal> forumJournalsSorted

forumJournals

protected final SHashtable<java.lang.String,JournalsLibrary.ForumJournal> forumJournals

clanForums

protected final java.util.Map<java.lang.String,java.util.List<JournalsLibrary.ForumJournal>> clanForums

cronJobs

protected final PairList<java.lang.Long,java.lang.String> cronJobs

nextEvents

protected final java.util.List<JournalEntry> nextEvents

lastMotdDate

protected volatile int lastMotdDate

emptyForums

protected static final java.util.List<JournalsLibrary.ForumJournal> emptyForums

Constructor Detail

CMJournals

public CMJournals()

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class StdLibrary

Returns:

the name of this class

getSummaryStats

protected java.util.Hashtable<java.lang.String,JournalsLibrary.JournalMetaData> getSummaryStats()

getJournalStats

public JournalsLibrary.JournalMetaData getJournalStats(JournalsLibrary.ForumJournal journal)

Description copied from interface: JournalsLibrary

Get the forum journal summary stats, caching them after calculation from the database

Specified by:

getJournalStats in interface JournalsLibrary

Parameters:

journal - the journal

Returns:

the stats

See Also:

JournalsLibrary.JournalMetaData

clearJournalSummaryStats

public void clearJournalSummaryStats(JournalsLibrary.ForumJournal journal)

Description copied from interface: JournalsLibrary

Clears the forum journal summary stats so that they can be rebuilt from the database.

Specified by:

clearJournalSummaryStats in interface JournalsLibrary

Parameters:

journal - the journal that needs updating

See Also:

JournalsLibrary.JournalMetaData

loadCommandJournals

public int loadCommandJournals(java.lang.String list)

Description copied from interface: JournalsLibrary

Given an encoded journals list string, this function will register all the CommandJournals described by the encoded list string. See coffeemud.ini file for the format.

Specified by:

loadCommandJournals in interface JournalsLibrary

Parameters:

list - the coded string

Returns:

the number of command journals loaded

See Also:

JournalsLibrary.CommandJournal, JournalsLibrary.commandJournals(), JournalsLibrary.getCommandJournal(String), JournalsLibrary.getNumCommandJournals()

canReadMessage

public boolean canReadMessage(JournalEntry entry,
                              java.lang.String srchMatch,
                              MOB readerM,
                              boolean ignorePrivileges)

Description copied from interface: JournalsLibrary

A security checker for whether the given user can read the given message. Applies a myriad of rules that can be controlled from the arguments.

Specified by:

canReadMessage in interface JournalsLibrary

Parameters:

entry - the journal entry

srchMatch - null, or a string to match almost anything in the entry

readerM - null, or the reader of the message

ignorePrivileges - true to NOT require JOURNAL secflag, false to require it

Returns:

true if the message can be read

loadForumJournals

public int loadForumJournals(java.lang.String list)

Description copied from interface: JournalsLibrary

Loads the forumjournals from the given encoded forum definition string. See the coffeemud.ini file for the format of this string.

Specified by:

loadForumJournals in interface JournalsLibrary

Parameters:

list - the coded string

Returns:

the number of forum journals loaded

See Also:

JournalsLibrary.getNumForumJournals(), JournalsLibrary.forumJournals(), JournalsLibrary.forumJournalsSorted(), JournalsLibrary.getForumJournal(String), JournalsLibrary.getForumJournal(String, Clan)

getClanForums

public java.util.List<JournalsLibrary.ForumJournal> getClanForums(Clan clan)

Description copied from interface: JournalsLibrary

Returns the list of ForumJournals that exist for the given clan.

Specified by:

getClanForums in interface JournalsLibrary

Parameters:

clan - the clan

Returns:

the list of ForumJournals for this clan

See Also:

JournalsLibrary.registerClanForum(Clan, String)

registerClanForum

public void registerClanForum(Clan clan,
                              java.lang.String allClanForumDefs)

Description copied from interface: JournalsLibrary

Registers a set of ForumJournals for the given clan from the coded string. See the coffeemud.ini file for the format of this string.

Specified by:

registerClanForum in interface JournalsLibrary

Parameters:

clan - the clan

allClanForumDefs - the coded string

See Also:

JournalsLibrary.getClanForums(Clan)

parseForumJournals

public java.util.List<JournalsLibrary.ForumJournal> parseForumJournals(java.lang.String list)

getArchonJournalNames

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

Description copied from interface: JournalsLibrary

Returns the cached set of basic items that implement the ArchonOnly interface, thus making them ArchonOnly journals.

Specified by:

getArchonJournalNames in interface JournalsLibrary

Returns:

the set of journal names

See Also:

JournalsLibrary.isArchonJournalName(String), ArchonOnly

isArchonJournalName

public boolean isArchonJournalName(java.lang.String journal)

Description copied from interface: JournalsLibrary

Returns whether the given journal appears on the archon journal names list.

Specified by:

isArchonJournalName in interface JournalsLibrary

Parameters:

journal - the journal name

Returns:

true if its an archon only item name, false otherwise

See Also:

JournalsLibrary.getArchonJournalNames(), ArchonOnly

getScriptValue

public java.lang.String getScriptValue(MOB mob,
                                       java.lang.String journal,
                                       java.lang.String oldValue)

Description copied from interface: JournalsLibrary

If the given journal requires running a MOBPROG script in order to produce a final message, this function will run that script.

Specified by:

getScriptValue in interface JournalsLibrary

Parameters:

mob - the player trying to post to the journal

journal - the journal that might be scripted

oldValue - the value entered before the scripting

Returns:

the final value, typically just the oldValue

getNumCommandJournals

public int getNumCommandJournals()

Description copied from interface: JournalsLibrary

Returns the number of command journals, or journals written to using standard game commands.

Specified by:

getNumCommandJournals in interface JournalsLibrary

Returns:

the number of command journals loaded

See Also:

JournalsLibrary.CommandJournal, JournalsLibrary.loadCommandJournals(String), JournalsLibrary.commandJournals(), JournalsLibrary.getCommandJournal(String)

commandJournals

public java.util.Enumeration<JournalsLibrary.CommandJournal> commandJournals()

Description copied from interface: JournalsLibrary

Returns an enumeration of all registered command journals

Specified by:

commandJournals in interface JournalsLibrary

Returns:

the command journals

See Also:

JournalsLibrary.CommandJournal, JournalsLibrary.loadCommandJournals(String), JournalsLibrary.getCommandJournal(String), JournalsLibrary.getNumCommandJournals()

getCommandJournal

public JournalsLibrary.CommandJournal getCommandJournal(java.lang.String named)

Description copied from interface: JournalsLibrary

Returns the information about the Command Journal of the given name.

Specified by:

getCommandJournal in interface JournalsLibrary

Parameters:

named - the command journal name

Returns:

null, or the journal info object

See Also:

JournalsLibrary.CommandJournal, JournalsLibrary.loadCommandJournals(String), JournalsLibrary.commandJournals(), JournalsLibrary.getNumCommandJournals()

runCronJob

protected long runCronJob(java.lang.String jobKey,
                          boolean debug)

processCalendarExpiration

protected JournalEntry processCalendarExpiration(JournalEntry expiredEntry)

expirationJournalSweep

protected void expirationJournalSweep()

activate

public boolean activate()

Description copied from interface: CMLibrary

Activates the library. This is called after the mud is booted, but before connections are accepted.

Specified by:

activate in interface CMLibrary

Overrides:

activate in class StdLibrary

Returns:

true if activation was successful, false if you're screwed

See Also:

CMLibrary.shutdown()

initializeCalendarEvents

protected void initializeCalendarEvents()

resetCalendarEvents

protected void resetCalendarEvents(long now)

resetCalendarEvents

public void resetCalendarEvents()

Description copied from interface: JournalsLibrary

Since Calendar events are also journal entries, whenever the calendar is changed, this method must be called to make sure notifications for new events occurs.

Specified by:

resetCalendarEvents in interface JournalsLibrary

getCalendarEvent

protected java.lang.String getCalendarEvent(TimeClock localClock,
                                            JournalEntry event)

postCalendarEventTo

protected void postCalendarEventTo(JournalEntry event,
                                   java.util.List<Area> areas,
                                   MOB M)

processCalendarEvents

protected void processCalendarEvents()

tick

public boolean tick(Tickable ticking,
                    int tickID)

Description copied from interface: Tickable

this is the method which is called periodically by the threading engine. How often it is called depends on the parameters passed to the threadding engine when it is submitted for thread access. Typically the period is once per TIME_TICK period, but that is determined when the object is submitted to the thread engine.

Specified by:

tick in interface Tickable

Overrides:

tick in class StdLibrary

Parameters:

ticking - a reference to this Tickable object

tickID - the TICKID_ constant describing this periodic call, as defined in Tickable

Returns:

true always, unless this object no longer wishes to ever tick again, in which case false

See Also:

Tickable, ServiceEngine, TickableGroup

getNumForumJournals

public int getNumForumJournals()

Description copied from interface: JournalsLibrary

Returns the number of forum journals.

Specified by:

getNumForumJournals in interface JournalsLibrary

Returns:

the number of forum journals.

See Also:

JournalsLibrary.forumJournals(), JournalsLibrary.forumJournalsSorted(), JournalsLibrary.getForumJournal(String), JournalsLibrary.getForumJournal(String, Clan), JournalsLibrary.loadForumJournals(String)

forumJournals

public java.util.Enumeration<JournalsLibrary.ForumJournal> forumJournals()

Description copied from interface: JournalsLibrary

Returns an enumeration of all normal forumJournals (not clan ones). Unsorted for speed.

Specified by:

forumJournals in interface JournalsLibrary

Returns:

the forumjournals

See Also:

JournalsLibrary.getNumForumJournals(), JournalsLibrary.forumJournalsSorted(), JournalsLibrary.getForumJournal(String), JournalsLibrary.getForumJournal(String, Clan), JournalsLibrary.loadForumJournals(String)

forumJournalsSorted

public java.util.Enumeration<JournalsLibrary.ForumJournal> forumJournalsSorted()

Description copied from interface: JournalsLibrary

Returns an enumeration of all normal ForumJournals (not clan ones), sorted by somehow.

Specified by:

forumJournalsSorted in interface JournalsLibrary

Returns:

the sorted forums

See Also:

JournalsLibrary.getNumForumJournals(), JournalsLibrary.forumJournals(), JournalsLibrary.getForumJournal(String), JournalsLibrary.getForumJournal(String, Clan), JournalsLibrary.loadForumJournals(String)

getForumJournal

public JournalsLibrary.ForumJournal getForumJournal(java.lang.String named)

Description copied from interface: JournalsLibrary

Returns a ForumJournal of the given name.

Specified by:

getForumJournal in interface JournalsLibrary

Parameters:

named - the name of the forumjournal

Returns:

the ForumJournal object

See Also:

JournalsLibrary.getNumForumJournals(), JournalsLibrary.forumJournals(), JournalsLibrary.forumJournalsSorted(), JournalsLibrary.getForumJournal(String, Clan), JournalsLibrary.loadForumJournals(String)

getForumJournal

public JournalsLibrary.ForumJournal getForumJournal(java.lang.String named,
                                                    Clan clan)

Description copied from interface: JournalsLibrary

Retreives a specific forum journal given to a particular clan.

Specified by:

getForumJournal in interface JournalsLibrary

Parameters:

named - the name of the journal

clan - the clan to whom the journal belongs

Returns:

null, or the forumjournal

See Also:

JournalsLibrary.getNumForumJournals(), JournalsLibrary.forumJournals(), JournalsLibrary.forumJournalsSorted(), JournalsLibrary.getForumJournal(String), JournalsLibrary.loadForumJournals(String)

shutdown

public boolean shutdown()

Description copied from interface: CMLibrary

Shuts down the library. Called at system shutdown time obviously, but is sometimes called just to reset the library.

Specified by:

shutdown in interface CMLibrary

Overrides:

shutdown in class StdLibrary

Returns:

true if shutdown was successful, false if there's nothing you can do about it

See Also:

CMLibrary.activate()

getMsgMkrHelp

protected java.lang.String getMsgMkrHelp(Session sess)

notifyPosting

public void notifyPosting(java.lang.String journal,
                          java.lang.String from,
                          java.lang.String to,
                          java.lang.String subject)

Description copied from interface: JournalsLibrary

Whenever a post to a journal is made, this function is called to send a notification to online users who have subscribed to such things.

Specified by:

notifyPosting in interface JournalsLibrary

Parameters:

journal - the journal posted at

from - the author of the message posted

to - who the post is too

subject - the subject of the top message

notifyReplying

public void notifyReplying(java.lang.String journal,
                           java.lang.String tpAuthor,
                           java.lang.String reAuthor,
                           java.lang.String subject)

Description copied from interface: JournalsLibrary

Whenever a reply to a journal is made, this function is called to send a notification to online users who have subscribed to such things.

Specified by:

notifyReplying in interface JournalsLibrary

Parameters:

journal - the journal replied at

tpAuthor - the author of the message replied to

reAuthor - the author of the reply

subject - the subject of the top message

makeMessageASync

public void makeMessageASync(MOB M,
                             java.lang.String messageTitle,
                             java.util.List<java.lang.String> vbuf,
                             boolean autoAdd,
                             JournalsLibrary.MsgMkrCallback back)

Description copied from interface: JournalsLibrary

An asynchronous system for allowing a user to edit a text document with options for search and replace, line inserting and deleting, and line replacement. A save option is also provided.

Specified by:

makeMessageASync in interface JournalsLibrary

Parameters:

M - the player doing the editing

messageTitle - the title of the message

vbuf - the text of the message

autoAdd - true to go directly into line adding mode, false to start in menu

back - the callBack when done

See Also:

JournalsLibrary.MsgMkrCallback, JournalsLibrary.MsgMkrResolution

makeMessage

protected JournalsLibrary.MsgMkrResolution makeMessage(MOB mob,
                                                       java.lang.String messageTitle,
                                                       java.util.List<java.lang.String> vbuf,
                                                       boolean autoAdd)
                                                throws java.io.IOException

Throws:

java.io.IOException

unsubscribeFromAll

public boolean unsubscribeFromAll(java.lang.String username)

Description copied from interface: JournalsLibrary

Unsubscribes the given user/account from every mailing list.

Specified by:

unsubscribeFromAll in interface JournalsLibrary

Parameters:

username - the user/account

Returns:

true if an unsubscribe happened

subscribeToJournal

public boolean subscribeToJournal(java.lang.String journalName,
                                  java.lang.String userName,
                                  boolean saveMailingList)

Description copied from interface: JournalsLibrary

Called to add a user to the subscription list for a journal.

Specified by:

subscribeToJournal in interface JournalsLibrary

Parameters:

journalName - the name of the journal

userName - the user who subscribed

saveMailingList - true to save afterwards, false if you'll do it later

Returns:

true if someone was added, false otherwise

unsubscribeFromJournal

public boolean unsubscribeFromJournal(java.lang.String journalName,
                                      java.lang.String userName,
                                      boolean saveMailingList)

Description copied from interface: JournalsLibrary

Called to remove a user from the subscription list for a journal.

Specified by:

unsubscribeFromJournal in interface JournalsLibrary

Parameters:

journalName - the name of the journal

userName - the user who subscribed

saveMailingList - true to save afterwards, false if you'll do it later

Returns:

true if someone was removed, false otherwise