ConfigurationMBean
, DeploymentMBean
, DescriptorBean
, javax.management.DynamicMBean
, javax.management.MBeanRegistration
, javax.management.NotificationBroadcaster
, RMCFactoryMBean
, SettableBean
, WebLogicMBean
public interface MailSessionMBean extends RMCFactoryMBean
Facilitates using the JavaMail APIs, which provide applications and other Java EE modules with access to Internet Message Access Protocol (IMAP)- and Simple Mail Transfer Protocol (SMTP)-capable mail servers on your network or the Internet.
In the reference implementation of JavaMail, applications must instantiate
javax.mail.Session
objects, which designate mail hosts, transport and
store protocols, and a default mail user for connecting to a mail server. In WebLogic Server,
you create a mail session, which configures a javax.mail.Session
object and
registers it in the WebLogic Server JNDI tree. Applications access the mail session
through JNDI instead of instantiating their own javax.mail.Session object.
DEFAULT_EMPTY_BYTE_ARRAY
DEFAULT_ORDER, MAX_ORDER, MIN_ORDER
Modifier and Type | Method | Description |
---|---|---|
java.lang.String |
getName() |
jmsserverjmshat on
|
java.util.Properties |
getProperties() |
The configuration options and user authentication data that this mail session
uses to interact with a mail server.
|
java.lang.String |
getSessionPassword() |
The decrypted JavaMail Session password attribute, for use only temporarily in-memory;
the value returned by this attribute should not be held in memory long term.
|
byte[] |
getSessionPasswordEncrypted() |
The encrypted JavaMail Session password as set with
setSessionPassword() ,
setSessionPasswordEncrypted(byte[] bytes) . |
java.lang.String |
getSessionUsername() |
Returns the username to be used to create an authenticated JavaMail
Session, using a JavaMail
Authenticator instance; if this is
not set, it will be assumed that the Session is not to be authenticated. |
void |
setProperties(java.util.Properties props) |
Sets the value of the Properties attribute.
|
void |
setSessionPassword(java.lang.String password) |
Sets the password for the JavaMail session; this will
in turn call
getSessionPasswordEncrypted()
to store the password in an encrypted form. |
void |
setSessionPasswordEncrypted(byte[] passwordEncrypted) |
Used to store the encrypted password value for an authenticated JavaMail
session in the domain configuration.
|
void |
setSessionUsername(java.lang.String user) |
Sets the user name to be used for an authenticated JavaMail session
|
freezeCurrentValue, getId, getInheritedProperties, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet
addTarget, getDeploymentOrder, getTargets, removeTarget, setDeploymentOrder, setTargets
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener
getAttribute, getAttributes, invoke, setAttribute, setAttributes
postDeregister, postRegister, preDeregister, preRegister
addNotificationListener, getNotificationInfo, removeNotificationListener
getJNDIName, setJNDIName
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent
java.lang.String getName()
The user-specified name of this MBean instance.
This name is included as one of the key properties in the
MBean's javax.management.ObjectName
:
Name=user-specified-name
getName
in interface ConfigurationMBean
getName
in interface WebLogicMBean
java.util.Properties getProperties()
The configuration options and user authentication data that this mail session uses to interact with a mail server. Each property that you specify overrides the default property value as defined by the JavaMail API Design Specification.
Include only the properties defined by the JavaMail API Design Specification.
If you do not specify any properties, this mail session will use the JavaMail default property values.
Express each property as a name=value
pair. Separate
multiple properties with a semicolon (;
).
void setProperties(java.util.Properties props) throws javax.management.InvalidAttributeValueException
Sets the value of the Properties attribute.
props
- The new properties valuejavax.management.InvalidAttributeValueException
getProperties()
java.lang.String getSessionUsername()
Returns the username to be used to create an authenticated JavaMail
Session, using a JavaMail Authenticator
instance; if this is
not set, it will be assumed that the Session is not to be authenticated.
void setSessionUsername(java.lang.String user)
Sets the user name to be used for an authenticated JavaMail session
user
- java.lang.String getSessionPassword()
The decrypted JavaMail Session password attribute, for use only temporarily in-memory; the value returned by this attribute should not be held in memory long term.
The value is stored in an encrypted form in the descriptor file and when displayed in an administration console.
void setSessionPassword(java.lang.String password)
Sets the password for the JavaMail session; this will
in turn call getSessionPasswordEncrypted()
to store the password in an encrypted form.
password
- byte[] getSessionPasswordEncrypted()
The encrypted JavaMail Session password as set with setSessionPassword()
,
setSessionPasswordEncrypted(byte[] bytes)
.
void setSessionPasswordEncrypted(byte[] passwordEncrypted)
passwordEncrypted
-