[Contents] [Prev] [Next] [Index] [Report an Error]

WEB-INF/struts-config.xml

The WEB-INF/struts-config.xml file contains the following settings. The file has multiple sections.

data-sources

Not used by the sample residential portal.

form-beans

Holds data entered in an HTML form and makes it available to the associated action.

global-exceptions

Specifies that the sample residential portal declare one global exception handler, which is invoked for any exception raised during action processing.

global-forwards

Global forwards for handling error situations. The sample residential portal declares a number of global forwards.
Value
- unknownUser—Used when an action is processed for a subscriber who is not known by the system. The possible pages are either .error.unknownUser.page, which displays an error message, or .login.page, which asks the user to log in.
- nonUniqueUser—Used when a request cannot be mapped to a single subscriber session.
  The sample residential portal uses the IP address of the subscriber, preventing this error.
- unknownService—Used when a request refers to a service that is not loaded by the SAE. This can happen if services are modified while subscribers are connected to the portal.
- unknownSubscription—Used when a request refers to a service to which the current subscriber is not subscribed.
- serviceAuthError—Used if authorization for a service is denied; for example, because mutex group restrictions are violated or a plug-in has denied authorization.
- loginError—Used if login was unsuccessful.
- saeError—Used for SAE internal errors.
- error—Used for any other problem.

action-mappings

Actions that each correspond to an interaction of the subscriber with the portal page. The sample residential portal declares a number of actions.
Value
- /index—Displays the main page of the portal; collects information about the subscriber requesting the page and forwards it to the .index.page.
- /services—Gets information about the subscribed services and forwards to the .services.page.
- /activate—Checks whether authentication is required and forwards the request either to the .service.auth.page or back to the .services.page.
  Called when the subscriber wants to activate a service.
- /deactivate—Forwards the request back to the .services.page.
  Called when the subscriber wants to deactivate an active service.
- /schedules—Gets information about the service schedule. Allows the subscriber to view and change service schedules. The action forwards the request to the .schedules.page.
- /scheduleOperation—Forwards the request back to the .schedules.page.
  Called when the subscriber wants to change the service schedule.
- /usage—Collects statistics for currently active services and forwards them to the .usage.page.
- /account—Allows modification of the activationTrigger property of currently subscribed services. After a change of the activationTrigger property has been processed, the action forwards subscribers to the .account.page.
- /subscribe—Allows the subscriber to subscribe to and unsubscribe from services. After processing the subscription change, the action forwards subscribers to the .subscribe.page.
- /register—Allows subscribers to register MAC addresses for authenticated DHCP addresses. The action checks whether the subscriber has provided a username and password and forwards the request to the .register.auth.page to enter the username and password or to the .register.page displaying the currently registered equipment.
- /unregister—Allows subscribers to remove MAC addresses that are registered for DHCP addresses. The action checks whether the subscriber provided a username and password and forwards the request to the .unregister.auth.page to enter the username and password or to the .unregister.page displaying the currently registered equipment.
- /login—Allows the subscriber to log in to the system. If the login causes a switch of the DHCP IP address, the request is forwarded to the wait.page . If the DHCP IP address remains the same after the login, the request is forwarded to the index.page.
- /logout—Allows the subscriber to log out of the system. If the logout causes a switch of the DHCP IP address, the request is forwarded to the .wait.page. If the DHCP IP address remains the same after the login, the request is forwarded to the index.page.
- /wait—Checks whether the IP address of the current subscriber is authenticated or unauthenticated. If the address is of the wrong type, the request is forwarded to the .wait.page, which will renew itself automatically. If the address is of the expected type, the request is forwarded to .index.page.
- /accessDenied—Processes a captive portal request. The request is forwarded only to the .error.accessDenied.page.

controller

Ensures generation of the correct headers for disabling caching of the generated pages.
Value—nocache

message-resources

Base name of the resource bundle. The resource bundle contains message strings in different languages.
Value
- WEB-INF/classes/net/juniper/smgt/ssp/ApplicationResources.properties
  The location of the resource file containing messages in English that is shipped with the sample residential portal.
- WEB-INF/classes/net/juniper/smgt/ssp/ApplicationResources_xx.properties
  where xx is the two-letter ISO language code, optionally followed by an underline and the two-letter country code; for example, en_CA for English/Canada or zh_TW for Chinese/Taiwan.
  
  To create a sample residential portal that supports other languages, translate the messages and store the translated file in the above location.

plug-in

Processes templates.

[Contents] [Prev] [Next] [Index] [Report an Error]