com.ibm.wps.portletservice.credentialvault.credentials
Class JavaMailCredential
java.lang.Object
com.ibm.wps.portletservice.credentialvault.credentials.Credential
com.ibm.wps.portletservice.credentialvault.credentials.ActiveCredential
com.ibm.wps.portletservice.credentialvault.credentials.UserPasswordCredential
com.ibm.wps.portletservice.credentialvault.credentials.JavaMailCredential
- All Implemented Interfaces:
- ActiveCredential, Credential, JavaMailCredential, java.io.Serializable, UserPasswordCredential
Deprecated. since 5.1.0.1, use the Java Portlet API and corresponding IBM portlet services instead
- public class JavaMailCredential
- extends UserPasswordCredential
- implements JavaMailCredential
Credential for authenticating at the back-end the javax.mail API.
To be used in following way:
- Construct and initialize the credential
- Create a javax.mail.Session and have it authenticated by the credential
To do so, call getAuthenticatedSession and supply you session object,
the host name and optionally the port number to use
- Use the session for business calls to the mail server
Preconditions:
- The configuration data passed to the constructor must define the values that are
required by UserPasswordCredential)
- Since:
- WP 5.1.0.1
- See Also:
- Serialized Form
Fields inherited from class com.ibm.wps.portletservice.credentialvault.credentials.Credential
LOGGER_NAME
| |
Method Summary
javax.mail.Session
| getAuthenticatedSession(javax.mail.Session session,
java.lang.String host)
Deprecated. Authenticates an javax.mail.Session.
javax.mail.Session
| getAuthenticatedSession(javax.mail.Session session,
java.lang.String host,
int port)
Deprecated. Authenticates an javax.mail.Session.
int
| getSecretType()
Deprecated. Returns the credential's Secret Type in terms of the constants declared in
com.ibm.portal.portlet.service.credentialvault.CredentialVaultService
Should be overwritten by any child class that "overwrites" the secret attribute.
void
| java.util.Map)">init(java.util.Map config)
Deprecated. Creates a new JavaMail credential.
| | | | |
Methods inherited from class java.lang.Object
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
|
JavaMailCredential
public JavaMailCredential()
- Deprecated.
java.util.Map)">
init
public void init(java.util.Map config)
throws CredentialVaultException
- Deprecated.
- Creates a new JavaMail credential.
- Specified by:
- java.util.Map)">init in interface JavaMailCredential
- Overrides:
- init in class UserPasswordCredential
- Parameters:
- config - The configuration needed to initialize this credential:
- KEY_CREDENTIAL_SECRET JavaMailCredentialSecret - the credential's secret (mandatory)
- Throws:
- CredentialVaultException - If any mandatory parameter is missing or has a wrong object type as value.
getSecretType
public int getSecretType()
- Deprecated.
- Description copied from interface: Credential
- Returns the credential's Secret Type in terms of the constants declared in
com.ibm.portal.portlet.service.credentialvault.CredentialVaultService
Should be overwritten by any child class that "overwrites" the secret attribute.
- Specified by:
- getSecretType in interface JavaMailCredential
- Overrides:
- getSecretType in class UserPasswordCredential
getAuthenticatedSession
public javax.mail.Session getAuthenticatedSession(javax.mail.Session session,
java.lang.String host)
throws javax.mail.MessagingException
- Deprecated.
- Authenticates an javax.mail.Session.
- Specified by:
- getAuthenticatedSession in interface JavaMailCredential
- Parameters:
- session - The session to authenticate.
- host - The mail server host name.
- Returns:
- Session
The authenticated session.
- Throws:
- javax.mail.MessagingException - thrown if javax.mail.session.getTransport().connect() fails.
getAuthenticatedSession
public javax.mail.Session getAuthenticatedSession(javax.mail.Session session,
java.lang.String host,
int port)
throws javax.mail.MessagingException
- Deprecated.
- Authenticates an javax.mail.Session.
- Specified by:
- getAuthenticatedSession in interface JavaMailCredential
- Parameters:
- session - The session to authenticate.
- host - The mail server host name.
- port - The mail server port number.
- Returns:
- Session
The authenticated session.
- Throws:
- javax.mail.MessagingException - thrown if javax.mail.session.getTransport().connect() fails.
WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.
IBM is a trademark of the IBM Corporation in the United States, other countries, or both.