|
Oracle Fusion Middleware Java API Reference for Oracle Business Intelligence Enterprise Edition Systems Management 11g Release 1(11.1.1) E16455-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@MBeanRequiredGlobalSecurityRole(value=Admin)
@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. |
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. |
Method Detail |
---|
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.SenderEmailAddress",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getSenderEmailAddress()
void setSenderEmailAddress(java.lang.String emailAddress)
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.SenderDisplayName",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getSenderDisplayName()
void setSenderDisplayName(java.lang.String displayName)
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.SmtpServer",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getSmtpServer()
void setSmtpServer(java.lang.String smtpServer)
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.SmtpServerPort",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
int getSmtpServerPort()
void setSmtpServerPort(int port) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.RetryCount",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
int getRetryCount()
void setRetryCount(int retryCount) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.MaxRecipients",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
int getMaxRecipients()
void setMaxRecipients(int maxRecipients) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.UseBCC",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
boolean isUseBCC()
void setUseBCC(boolean useBCC)
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.UseSSL",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
boolean isUseSSL()
void setUseSSL(boolean useSSL)
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.CertDirectoryNotFile",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
boolean isCertDirectoryNotFile()
void setCertDirectoryNotFile(boolean certDirectoryNotFile)
certDirectoryNotFile
- true if directory, false if file.
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.CertDirectory",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getCertDirectory()
void setCertDirectory(java.lang.String certDirectory)
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.CertFile",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getCertFile()
void setCertFile(java.lang.String certFile)
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.CertDepth",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
int getCertDepth()
void setCertDepth(int certDepth) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.CipherList",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getCipherList()
void setCipherList(java.lang.String cipherList)
@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)
username
- The username. Must not be null.password
- The password. Must not be null.@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)
username
- The username. Must not be null.password
- The password. Must not be null.
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.Username",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getUsername()
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.Username",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
void setUsername(java.lang.String username)
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.RetryCountMax",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
int getRetryCountMax()
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.MaxRecipientsMax",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
int getMaxRecipientsMax()
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.EmailConfigurationMBean.CertDepthMax",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
int getCertDepthMax()
|
Oracle Fusion Middleware Java API Reference for Oracle Business Intelligence Enterprise Edition Systems Management 11g Release 1(11.1.1) E16455-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |