Once you have created the plugin.xml file, and optionally the plugin.properties file, you can make your application available in a few quick steps, described below.
The server looks in specific directories for required files. To place your plug-in files in the appropriate location:
- Save the plug-in xml file using the following naming convention:
- Save the properties file, if you have one, using the following naming convention:
- Place the saved file(s) at the following location:
To add these resources to the server, create a folder for them using the following path and naming convention:
Place the resources in that folder.
Making resources private has the advantage of allowing applications to define their own security constraints without needing to make changes to low-level configuration files.
- Navigate to the following location:
- Create a subdirectory.
- Add the resources for your application to this directory.
- Provide Controller implementations that make these resources available to users with the correct roles using the security annotations provided by the Spring Framework.
- Navigate to the following file and open it in a text editor:
- Edit the file by including this line:
<intercept-url pattern="/<application name>/**"access="ROLE_PUREWEB_USER"/>
This secures all of the resources using a simple pattern that recursively matches your resource directory; in this example access to the resources is limited to users who log in using a “user” level security role.
- Save the file to commit your changes.
You must perform a reload or restart the server before server configuration or plug-in file changes take effect.
To perform a reload, navigate to the server's Configuration page and click the Reload button for the section where the file is located within the page (for example, if you edited a plug-in configuration file, click the Reload Plugins button, if you edited a logging configuration file, click the Reload Logging button, and so on).
If you edit a configuration file, the server will display a reload required message beside this file in the Configuration page as a reminder until the changes have been applied.
A working link to your application should now appear in the server's Apps page.
If your application doesn't appear in the server's Apps page, check that you added the link to the application when you created the plugin.xml file.
The plugin.xml and plugin.properties files for your application will also appear in the server’s Configuration page, where you will be able to open them in a browser for editing.
If you need to remove an application that you have added, see Removing an Application from the Server.