| java.lang.Object
 com.sun.portal.providers.ApplicationHelper
com.sun.portal.providers.mail.NotesMailHelper
| NotesMailHelper | | public class NotesMailHelper extends ApplicationHelper implements MailApplicationHelper(Code) | | This class implements MailSSOHelper and MailApplicationHelper functionality
specific to the Sun One Portal and Mail services.
Specific features include:
- Support for username/password style authentication.
- Ability to generate web application URLs for the following:
- Messenger Express
- MAP JSP Mail application. The URL generated in this case will
specify a configuration index via the query string parameter: "mi".
At the present time, username/password is stored in the clear.
This MailSSOHelper implementation consumes the following Configuration
properties:
- protocol : Required value. Must be either "imap" or "pop3".
- uid : Required value. Username (uid) of imap user.
- password : Required value. Password of imap user.
- host : Required value. Name of host providing IMAP service.
- port : Optional value. Port number of IMAP server. Defaults to
"143" when protocol is "imap", and "110" when protocol is "pop3".
- smtpServer : Optional value. Specifies name of outgoing mail
server. Defaults to value of host property.
- clientProtocol : Protocol to specify within URLs that activate
web application functionality. Defaults to "http".
- clientPort : Port to specify within URLs that that activate
web application functionality. Defaults to "80".
- jspContextPath : The "request context path" to use when
forming a URL that activates MAP JSP application functionality. Defaults
to request.getContextPath().
- jspLaunch : The document path to use when forming a URL that
activates MAP JSP application functionality.
author:
John Saare
version:
1.0
See Also: com.sun.ssoadapter.SSOAdapter
See Also: com.sun.ssoadapter.SSOAdapterFactory |
| Method Summary | |
| public String | getAppHelperEditLink(HttpServletRequest req, ProviderContext pc)
| | public StringBuffer | getAppPrefsEdit(MailProvider mprov, HttpServletRequest req, HttpServletResponse res)
| | public String | getApplicationURL(MailProvider provider, HttpServletRequest request)
Returns client aware URL for mail application access to service associated
with a particular instance of a NotesMailHelper. | | public String | getMessageURL(MailProvider provider, HttpServletRequest request, Message message)
Returns client aware URL for message access to service associated with a
particular instance of a NotesMailHelper. | | public String | getStartURL(MailProvider provider, HttpServletRequest request)
Returns a client URL, if supported by the service. | | public void | init(MailProvider provider, SSOAdapter ssoAdapter)
Initialize Helper. | | public URL | processAppPrefsEdit(MailProvider mprov, HttpServletRequest request, HttpServletResponse response)
|
| adapterProperties | | public Properties adapterProperties(Code) | | Description of the Field
|
| getAppHelperEditLink | | public String getAppHelperEditLink(HttpServletRequest req, ProviderContext pc)(Code) | | Returns a HTML link containing encoding specific for the app helper
Parameters:
req - servlet request
Parameters:
pc - provider context The appHelperEditLink value |
| getApplicationURL | | public String getApplicationURL(MailProvider provider, HttpServletRequest request) throws Exception(Code) | | Returns client aware URL for mail application access to service associated
with a particular instance of a NotesMailHelper.
Parameters:
provider - MailProvider
Parameters:
request - HttpServletRequest The applicationURL value |
| getMessageURL | | public String getMessageURL(MailProvider provider, HttpServletRequest request, Message message) throws Exception(Code) | | Returns client aware URL for message access to service associated with a
particular instance of a NotesMailHelper.
Parameters:
provider - current mail provider
Parameters:
request - servlet request
Parameters:
message - message to generate link for The messageURL value |
| getStartURL | | public String getStartURL(MailProvider provider, HttpServletRequest request)(Code) | | Returns a client URL, if supported by the service.
Parameters:
provider - MailProvider
Parameters:
request - servlet request The startURL value |
| init | | public void init(MailProvider provider, SSOAdapter ssoAdapter) throws Exception(Code) | | Initialize Helper.
Parameters:
ssoAdapter - SSOAdapter object
Parameters:
provider - current MailProvider |
|
|