weblogic.management.configuration
Interface MailSessionMBean

All Superinterfaces:

ConfigurationMBean, DeploymentMBean, DescriptorBean, DynamicMBean, MBeanRegistration, 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.

getProperties

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 (;).

Returns:

The properties value

setProperties

void setProperties(Properties props)
                   throws InvalidAttributeValueException

Sets the value of the Properties attribute.

Parameters:

props - The new properties value

Throws:

InvalidAttributeValueException

See Also:

MailSessionMBean.getProperties()

getSessionUsername

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.

Returns:

The user name for creating an authenticated JavaMail Session

Access limited to the following security roles:

Deployer

setSessionUsername

void setSessionUsername(String user)

Sets the user name to be used for an authenticated JavaMail session

Parameters:

user -

getSessionPassword

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.

Returns:

The clear text value of the password if it can be determined

Access limited to the following security roles:

Deployer

setSessionPassword

void setSessionPassword(String password)

Sets the password for the JavaMail session; this will in turn call MailSessionMBean.getSessionPasswordEncrypted() to store the password in an encrypted form.

Parameters:

password -

getSessionPasswordEncrypted

byte[] getSessionPasswordEncrypted()

The encrypted JavaMail Session password as set with setSessionPassword(), setSessionPasswordEncrypted(byte[] bytes).

Returns:

The password value as an encrypted byte array

Access limited to the following security roles:

Deployer

setSessionPasswordEncrypted

void setSessionPasswordEncrypted(byte[] passwordEncrypted)

Used to store the encrypted password value for an authenticated JavaMail session in the domain configuration.

Parameters:

passwordEncrypted -