View source for Role Based Menus for Client Window (Melissa)

== Purpose ==

A major issue with Open Wonderland is the ability for users to edit the world. In order for Virtual BU to be fully distributable we would need to be able to eliminate unauthorized access to administrative level functionalities within the client interface.
== Module Structure ==
The module is composed of only a client plugin. <br />The source code for this module will be located within the newmodule code package under<br />
''/trunk/my-wonderland-modules/unstable/newmodule/src/classes/org/jdesktop/wonderland/modules/newmodule/client''

== Compiling the Module ==
To compile the module, you must be within the modules top level directory. If using the current code package, this would be "newmodule." Once within this directory, follow these commands:
<br />'''ant clean'''  ---- This is important because if you do not first remove the pre-existing .jar files, the module will not be newly compiled and your changes not reflected.
<br />'''ant'''        ---- This will actually compile the module for you and package the .jar as well as create the dist folder.
At this point, if you navigate to ''trunk/my-wonderland-modules/unstable/newmodule/dist'' you will find the .jar that you will need to install the module on the Wonderland Server Page, as described in the section Installing Module.

== Installing Module ==
''Prerequisites''<br />
Authentication must be configured for use.
<br />
The module must be compiled.<br />
Must have access to the Server Administration Pages
<br /><br />
''Installing''<br />
1.  Navigate to Manage Modules<br />
2.  Click "Browse" and select the Modules .jar file<br />
3.  Restart Darkstar<br />


== Using the Module ==
You must set up a group titled "Designers" in order to use the module in its current configuration.<br />
To do this:
<br />
1. Sign in to the Server Administration Page<br />
2. Navigate to "Manage Groups." <br />
3. Click "Add group" which will be below the table containing the list of the servers current groups.<br />
4. Create a group named "Designers"<br />
5. Click "Edit Group Members"<br />
6. Assign the desired users to this group<br />
7. Restart Server<br /><br />

You should now be able to see the module remove the selected menu items from the Guest account users.

== Troubleshooting ==
Client crashes after deploying module: This is generally caused by attempting to access incorrect menu instances or menu components, to resolve this try a different combination.

== Problem with Other Modules and Plugins ==
This is an extremely primitive attempt at what actually needs to be done. A significant problem exists in that the module is only able to access menu items that are present prior to a users log in attempt. The module does not have access to any of the plugins that are loaded after a successful login.

== Ideas for Improvement ==
Prior to graduation I had begun examining a way to create a plugin filter that would replace this modules code or depending on how it was implemented work along side it. <br />
'''The Base Class for PluginFilter can be found here:'''<br />
''trunk/wonderland/core/src/classes/org/jdesktop/wonderland/client/login''<br />
Examples of use of a PluginFilter can be found  in the same directory in LoginManager.