|
Oracle Fusion Middleware Java API Reference for Oracle Business Intelligence Enterprise Edition Systems Management 11g Release 1(11.1.1) E16455-04 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.description",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
public interface SecurityConfigurationMBean
Defines an MBean interface for managing the centralized security 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 | |
---|---|
java.lang.String |
generateSSLCertificates(java.lang.String passphrase, java.lang.String webServerCACertificatePath, java.lang.String certificateEncodingString) Schedules a request to generate the certificates required as a prerequisite for enabling SSL, using the specific passphrase. |
java.lang.String |
getSsoProvider() Returns the SSO provider. |
java.lang.String[] |
getSsoProviderDisplayNames() Gets the list of valid 'SSO Providers' display Names. |
java.lang.String |
getSsoProviderLogoffURL() GetSSO Provider LogoffURL. |
java.lang.String |
getSsoProviderLogonURL() GetSSO Provider LogonURL. |
java.lang.String[] |
getSsoProviders() Gets the list of valid 'SSO Providers'. |
boolean |
isSSLCertificatesGenerated() Indicates whether or not SSL certificates have been generated. |
boolean |
isSSLEnabled() Indicates whether or not SSL has been enabled for the BI Instance. |
boolean |
isSSLManualConfig() Indicates whether or not SSL manual configuration has been enabled for the BI Instance. |
boolean |
isSSLVerifyPeers() Indicates whether or not servers within the system will only allow connections from authenticated clients. |
boolean |
isSsoEnabled() Returns the flag indicating whether SSO is enabled. |
java.lang.String |
runSSLReport() Performs SSL pings using the automated SSL configuration and returns a human readable report |
java.lang.String |
runXMLSSLReport() Performs SSL pings using the automated SSL configuration and returns an XML report |
void |
setSSLEnabled(boolean b) Enables or disables SSL for all communication links between processes of the BI Instance. |
void |
setSSLManualConfig(boolean b) Enables or disables manual SSL configuration. |
void |
setSSLVerifyPeers(boolean b) Enables or disables servers requiring that clients are authenticated. |
void |
setSsoEnabled(boolean ssoEnabled) Sets the flag indicating whether SSO is enabled. |
void |
setSsoProvider(java.lang.String ssoProvider) Sets the SSO provider. |
void |
setSsoProviderLogoffURL(java.lang.String ssoProviderLogoffURL) Sets the SSO provider LogoffURL. |
void |
setSsoProviderLogonURL(java.lang.String ssoProviderLogonURL) Sets the SSO provider LogonURL. |
Method Detail |
---|
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SsoEnabled",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
boolean isSsoEnabled()
void setSsoEnabled(boolean ssoEnabled)
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SsoProvider",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getSsoProvider()
void setSsoProvider(java.lang.String ssoProvider)
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SsoProviders",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String[] getSsoProviders()
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SsoProviderDisplayNames",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String[] getSsoProviderDisplayNames()
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SSLCertificatesGenerated",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
boolean isSSLCertificatesGenerated()
throws javax.management.OperationsException
javax.management.OperationsException
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.generateSSLCertificates", resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg") java.lang.String generateSSLCertificates(@Name(value="passphrase") java.lang.String passphrase, @Name(value="webServerCACertificatePath") java.lang.String webServerCACertificatePath, @Name(value="certificateEncoding")@LegalValues(value={"der","pem"}) java.lang.String certificateEncodingString) throws javax.management.OperationsException
passphrase
- The passphrase to use when generating the ssl certificates. Must be at least 6 characters long.webServerCACertificatePath
- WebServer (eg WebLogic) uses an outward facing SSL certificate - so it must be signed by a certificate authority recognized by the clients. This means either a public CA (eg verisign) or a corporate CA. Contrast this with the internal APIs (eg OBIPS, OBIS) which can use a private CA we can generate here. Since the CA is outside our control, its public certificate must be passed in. The path is on the admin server machine. The certificate will be copied to all BI cluster members - there is no need for it to be made available on all machines by the user. Since this is an MBean api, use the open mbean compatible String type not File.certificateEncodingString
- "der" or "pem" is required.java.lang.IllegalArgumentException
- if the passphrase is less than 6 characters, encoding is not supported, or any argument is null. long.javax.management.OperationsException
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.runSSLReport",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String runSSLReport()
throws javax.management.OperationsException
java.lang.IllegalStateException
- if manual SSL configuration is in force, or certificates have not yet been generated for the BI Instance. This method cannot be called getSSLReport(), since that would be interpreted by mbean code as a property rather than an operation.javax.management.OperationsException
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.runXMLSSLReport",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String runXMLSSLReport()
throws javax.management.OperationsException
java.lang.IllegalStateException
- if manual SSL configuration is in force, or certificates have not yet been generated for the BI Instance. This method cannot be called getSSLReport(), since that would be interpreted by mbean code as a property rather than an operation.javax.management.OperationsException
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SSLManualConfig",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
boolean isSSLManualConfig()
void setSSLManualConfig(boolean b)
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SSLEnabled",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
boolean isSSLEnabled()
void setSSLEnabled(boolean b) throws javax.management.OperationsException
java.lang.IllegalStateException
- if certificates have not yet been generated for the BI Instance.javax.management.OperationsException
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SSLVerifyPeers",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
boolean isSSLVerifyPeers()
void setSSLVerifyPeers(boolean b)
b
- set to true to require that clients are authenticatedvoid setSsoProviderLogonURL(java.lang.String ssoProviderLogonURL)
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SsoProviderLogonURL",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getSsoProviderLogonURL()
void setSsoProviderLogoffURL(java.lang.String ssoProviderLogoffURL)
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SsoProviderLogoffURL",
resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getSsoProviderLogoffURL()
|
Oracle Fusion Middleware Java API Reference for Oracle Business Intelligence Enterprise Edition Systems Management 11g Release 1(11.1.1) E16455-04 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |