oracle.bi.management.adminservices.mbeans
Interface EmailConfigurationMBean

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.description",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
public interface EmailConfigurationMBean

Defines an MBean interface for managing the email configuration of a BI Instance. To ensure that exceptions are correctly reported in clients such as JConsole, which typically do not have BIEE jars, only standard exceptions are surfaced here.

Method Summary

int	getCertDepth() Get the SSL Certificate verification depth.
int	getCertDepthMax() Returns the max range of the SSL Certificate verification depth.
java.lang.String	getCertDirectory() Get the CA Certificate Directory to use when using SSL.
java.lang.String	getCertFile() Get the CA Certificate File to use when using SSL.
java.lang.String	getCipherList() Get the SSL Cipher List.
int	getMaxRecipients() Get the Maximum number of recipients (0 means don't care).
int	getMaxRecipientsMax() Get the Maximum number of recipients (0 means don't care).
int	getRetryCount() Get the maximum number of retries to try before failing.
int	getRetryCountMax() Returns the max range of number of retries to try before failing.
java.lang.String	getSenderDisplayName() Returns the display name of the sender of emails from the BI system.
java.lang.String	getSenderEmailAddress() Returns the email address to use as the sender of emails from the BI system.
java.lang.String	getSmtpServer() Returns the smtp server to use for dispatching emails.
int	getSmtpServerPort() Returns the port of the smtp server to use for dispatching emails.
java.lang.String	getUsername() Returns the user name.
boolean	isCertDirectoryNotFile() Specify whether the CA Certificate is specified via directory or file.
boolean	isUseBCC() Get the flag to indicate whether to use Bcc: instead of To:
boolean	isUseSSL() Get the flag to indicate whether to connect to the SMTP server using SSL.
boolean	isUseStartTLS() Get the flag to indicate whether to connect to the SMTP server using StartTLS.
void	setCertDepth(int certDepth) Set the SSL Certificate verification depth.
void	setCertDirectory(java.lang.String certDirectory) Set the CA Certificate Directory to use when using SSL.
void	setCertDirectoryNotFile(boolean certDirectoryNotFile) Specify whether the CA Certificate is specified via directory or file.
void	setCertFile(java.lang.String certFile) Set the CA Certificate File to use when using SSL.
void	setCipherList(java.lang.String cipherList) Set the SSL Cipher List.
void	setCredentials(java.lang.String username, char[] password) Sets the credentials for the email connection.
void	setCredentials(java.lang.String username, java.lang.String password) Deprecated. Use setCredentials(String username, char[] password)
void	setMaxRecipients(int maxRecipients) Set the Maximum number of recipients (0 means don't care).
void	setRetryCount(int retryCount) Set the maximum number of retries to try before failing.
void	setSenderDisplayName(java.lang.String displayName) Sets the display name of the sender of emails from the BI system.
void	setSenderEmailAddress(java.lang.String emailAddress) Sets the email address to use as the sender of emails from the BI system.
void	setSmtpServer(java.lang.String smtpServer) Sets the smtp server to use for dispatching emails.
void	setSmtpServerPort(int port) Sets the port of the smtp server to use for dispatching emails.
void	setUseBCC(boolean useBCC) Set the flag to indicate whether to use Bcc: instead of To:
void	setUsername(java.lang.String username) Sets the user name NOTE: Use this api only when username alone needs updation.
void	setUseSSL(boolean useSSL) Set the flag to indicate whether to connect to the SMTP server using SSL.
void	setUseStartTLS(boolean useStartTLS) Set the flag to indicate whether to connect to the SMTP server using StartTLS.

Method Detail

getSenderEmailAddress

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.SenderEmailAddress",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getSenderEmailAddress()

Returns the email address to use as the sender of emails from the BI system.

setSenderEmailAddress

void setSenderEmailAddress(java.lang.String emailAddress)

Sets the email address to use as the sender of emails from the BI system.

getSenderDisplayName

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.SenderDisplayName",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getSenderDisplayName()

Returns the display name of the sender of emails from the BI system.

setSenderDisplayName

void setSenderDisplayName(java.lang.String displayName)

Sets the display name of the sender of emails from the BI system.

getSmtpServer

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.SmtpServer",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getSmtpServer()

Returns the smtp server to use for dispatching emails.

setSmtpServer

void setSmtpServer(java.lang.String smtpServer)

Sets the smtp server to use for dispatching emails.

getSmtpServerPort

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.SmtpServerPort",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getSmtpServerPort()

Returns the port of the smtp server to use for dispatching emails.

setSmtpServerPort

void setSmtpServerPort(int port)
                       throws java.lang.IllegalArgumentException

Sets the port of the smtp server to use for dispatching emails.

Throws:

java.lang.IllegalArgumentException

getRetryCount

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.RetryCount",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getRetryCount()

Get the maximum number of retries to try before failing.

setRetryCount

void setRetryCount(int retryCount)
                   throws java.lang.IllegalArgumentException

Set the maximum number of retries to try before failing.

Throws:

java.lang.IllegalArgumentException

getMaxRecipients

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.MaxRecipients",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getMaxRecipients()

Get the Maximum number of recipients (0 means don't care).

setMaxRecipients

void setMaxRecipients(int maxRecipients)
                      throws java.lang.IllegalArgumentException

Set the Maximum number of recipients (0 means don't care).

Throws:

java.lang.IllegalArgumentException

isUseBCC

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.UseBCC",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isUseBCC()

Get the flag to indicate whether to use Bcc: instead of To:

setUseBCC

void setUseBCC(boolean useBCC)

Set the flag to indicate whether to use Bcc: instead of To:

isUseSSL

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.UseSSL",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isUseSSL()

Get the flag to indicate whether to connect to the SMTP server using SSL.

setUseSSL

void setUseSSL(boolean useSSL)

Set the flag to indicate whether to connect to the SMTP server using SSL.

isUseStartTLS

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.UseStartTLS",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isUseStartTLS()

Get the flag to indicate whether to connect to the SMTP server using StartTLS.

Since:

11.1.1.5.52

setUseStartTLS

void setUseStartTLS(boolean useStartTLS)

Set the flag to indicate whether to connect to the SMTP server using StartTLS.

Since:

11.1.1.5.52

isCertDirectoryNotFile

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.CertDirectoryNotFile",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isCertDirectoryNotFile()

Specify whether the CA Certificate is specified via directory or file.

Returns:

true if directory, false if file.

setCertDirectoryNotFile

void setCertDirectoryNotFile(boolean certDirectoryNotFile)

Specify whether the CA Certificate is specified via directory or file.

Parameters:

certDirectoryNotFile - true if directory, false if file.

getCertDirectory

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.CertDirectory",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getCertDirectory()

Get the CA Certificate Directory to use when using SSL. Note that only one of the CA Certificate directory and CA Certificate file should be specified, not both.

setCertDirectory

void setCertDirectory(java.lang.String certDirectory)

Set the CA Certificate Directory to use when using SSL. Note that only one of the CA Certificate directory and CA Certificate file should be specified, not both.

getCertFile

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.CertFile",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getCertFile()

Get the CA Certificate File to use when using SSL. Note that only one of the CA Certificate directory and CA Certificate file should be specified, not both.

setCertFile

void setCertFile(java.lang.String certFile)

Set the CA Certificate File to use when using SSL. Note that only one of the CA Certificate directory and CA Certificate file should be specified, not both.

getCertDepth

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.CertDepth",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getCertDepth()

Get the SSL Certificate verification depth.

setCertDepth

void setCertDepth(int certDepth)
                  throws java.lang.IllegalArgumentException

Set the SSL Certificate verification depth.

Throws:

java.lang.IllegalArgumentException

getCipherList

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.CipherList",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getCipherList()

Get the SSL Cipher List. This is only necessary for advanced purposes.

setCipherList

void setCipherList(java.lang.String cipherList)

Set the SSL Cipher List. This is only necessary for advanced purposes.

setCredentials

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.deprecated",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
void setCredentials(@Name(value="username")
                                java.lang.String username,
                                @Name(value="password")
                                java.lang.String password)

Deprecated. Use setCredentials(String username, char[] password)

Sets the credentials for the email connection.

Parameters:

username - The username. Must not be null.

password - The password. Must not be null.

setCredentials

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.setCredentials",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
void setCredentials(@Name(value="username")
                                java.lang.String username,
                                @Name(value="password")
                                char[] password)

Sets the credentials for the email connection.

Parameters:

username - The username. Must not be null.

password - The password. Must not be null.

getUsername

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.Username",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getUsername()

Returns the user name.

setUsername

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.Username",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
void setUsername(java.lang.String username)

Sets the user name NOTE: Use this api only when username alone needs updation. Use setCredential(String,String) apis when both username and passwords are to be updated.

Since:

11.1.1.3.51

getRetryCountMax

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.RetryCountMax",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getRetryCountMax()

Returns the max range of number of retries to try before failing.

getMaxRecipientsMax

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.MaxRecipientsMax",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getMaxRecipientsMax()

Get the Maximum number of recipients (0 means don't care).

getCertDepthMax

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.CertDepthMax",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
int getCertDepthMax()

Returns the max range of the SSL Certificate verification depth.