nl.gx.webmanager.services.usermanager.settings
Interface SettingsManager

public interface SettingsManager

This interface defines an OSGi service to manage the banned and reserved web user words within Webmanager.

Method Summary

void	addBanned(int webId, java.lang.String banned) Adds a banned word for the given web id.
void	addReserved(int webId, java.lang.String reserved) Adds a reserved word for the given web id.
void	deleteBanned(int webId, java.lang.String banned) Deletes a banned word for the given web id.
void	deleteReserved(int webId, java.lang.String reserved) Deletes a reserved word for the given web id.
boolean	isClean(int webId, java.lang.String word) Determines if a given word is clean by checking it against banned and reserved words.
java.util.List<java.lang.String>	searchBanned(int webId, java.lang.String word) Searched banned words that contain the given string.
java.util.List<java.lang.String>	searchReserved(int webId, java.lang.String word) Searched reserved words that contain the given string.

Method Detail

addBanned

void addBanned(int webId,
               java.lang.String banned)
               throws UserSettingsException

Adds a banned word for the given web id.

Parameters:

webId - the web id

banned - the banned word to add

Throws:

UserSettingsException

addReserved

void addReserved(int webId,
                 java.lang.String reserved)
                 throws UserSettingsException

Adds a reserved word for the given web id.

Parameters:

webId - the web id

reserved - the reserved word to add

Throws:

UserSettingsException

deleteBanned

void deleteBanned(int webId,
                  java.lang.String banned)
                  throws UserSettingsException

Deletes a banned word for the given web id.

Parameters:

webId - the web id

banned - the banned word to delete

Throws:

UserSettingsException

deleteReserved

void deleteReserved(int webId,
                    java.lang.String reserved)
                    throws UserSettingsException

Deletes a reserved word for the given web id.

Parameters:

webId - the web id

reserved - the reserved word to delete

Throws:

UserSettingsException

searchBanned

java.util.List<java.lang.String> searchBanned(int webId,
                                              java.lang.String word)
                                              throws UserSettingsException

Searched banned words that contain the given string.

Parameters:

webId - the web id

word - the word to look for, if null or empty then all words are returned

Returns:

a list of strings that contain the given word

Throws:

UserSettingsException

searchReserved

java.util.List<java.lang.String> searchReserved(int webId,
                                                java.lang.String word)
                                                throws UserSettingsException

Searched reserved words that contain the given string.

Parameters:

webId - the web id

word - the word to look for, if null or empty then all words are returned

Returns:

a list of strings that contain the given word

Throws:

UserSettingsException

isClean

boolean isClean(int webId,
                java.lang.String word)
                throws UserSettingsException

Determines if a given word is clean by checking it against banned and reserved words. If banned and reserved words do not appear as substring in the word, then it is considered clean.

Parameters:

webId - the web id

word - the word to look for

Returns:

whether the word is clean

Throws:

UserSettingsException