| java.lang.Object
 com.sun.ssoadapter.AbstractSSOAdapter
com.sun.ssoadapter.impl.JavaMailSSOAdapter
All known Subclasses: com.sun.ssoadapter.impl.NotesMailSSOAdapter, com.sun.ssoadapter.impl.ExchangeMailSSOAdapter,
| JavaMailSSOAdapter | | public class JavaMailSSOAdapter extends AbstractSSOAdapter (Code) | | This class extends the abstract SSOAdapter functionality
specific to the Sun One Portal and Mail services.
Specific features include:
- Support for username/password style authentication.
This SSOAdapter 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".
author:
John Saare
version:
1.0
See Also: com.sun.ssoadapter.SSOAdapter
See Also: com.sun.ssoadapter.SSOAdapterFactory |
| Method Summary | |
| public boolean | closeConnection()
Adapter specific Connection termination. | | public Object | getConnection()
Adapter specific Connection. | | public javax.mail.Session | getSession()
Returns a JavaMail Session object. | | public javax.mail.Store | getStore()
Returns a JavaMail Store object. | | public void | init(String adapterName, SSOToken token, Properties adapterProperties, List userPropertiesList, List encodedProperteisList, Locale locale)
| | public boolean | isAvailable()
Tests service availability. | | public void | ssoTokenChanged(SSOTokenEvent evt)
Implements SSOTokenListener "ssoTokenChanged" method.
The following are possible SSO token event types:
- SSO_TOKEN_IDLE_TIMEOUT
- SSO_TOKEN_MAX_TIMEOUT
- SSO_TOKEN_DESTROY
The event getType() method is used to ensure that one of the
three types above are the basis for this event. | | public void | validate()
Validates configuration. |
| mailSession | | protected javax.mail.Session mailSession(Code) | | |
| mailStore | | protected javax.mail.Store mailStore(Code) | | |
| closeConnection | | public boolean closeConnection()(Code) | | Adapter specific Connection termination.
true if the connection was terminated successfully. |
| getConnection | | public Object getConnection()(Code) | | Adapter specific Connection.
|
| getSession | | public javax.mail.Session getSession() throws Exception(Code) | | Returns a JavaMail Session object.
|
| getStore | | public javax.mail.Store getStore() throws Exception(Code) | | Returns a JavaMail Store object.
|
| init | | public void init(String adapterName, SSOToken token, Properties adapterProperties, List userPropertiesList, List encodedProperteisList, Locale locale) throws SSOAdapterException(Code) | | Initialize and validate JavaMailSSOAdapter
Parameters:
adapterName - Used to identify the SSOAdapter
Parameters:
token - Used to identify the user on who's behalf the request isbeing processed.
Parameters:
adapterProperties - Contains the adapter information that will drivethe operation of this instance of an SSOAdapter. |
| isAvailable | | public boolean isAvailable()(Code) | | Tests service availability.
|
| ssoTokenChanged | | public void ssoTokenChanged(SSOTokenEvent evt)(Code) | | Implements SSOTokenListener "ssoTokenChanged" method.
The following are possible SSO token event types:
- SSO_TOKEN_IDLE_TIMEOUT
- SSO_TOKEN_MAX_TIMEOUT
- SSO_TOKEN_DESTROY
The event getType() method is used to ensure that one of the
three types above are the basis for this event. If getType()
returns a type not listed above, then an SSOException is thrown.
Parameters:
evt - SSOTokenEvent |
|
|