oracle.bi.management.adminservices.mbeans
Interface SecurityConfigurationMBean

@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	getEndpointURI() Get Security Service Endpoint URI.
java.lang.String	getJaznPolicyStripeName() Get Jazn Policy Stripe Name.
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

isSsoEnabled

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SsoEnabled",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isSsoEnabled()

Returns the flag indicating whether SSO is enabled.

setSsoEnabled

void setSsoEnabled(boolean ssoEnabled)

Sets the flag indicating whether SSO is enabled.

getSsoProvider

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SsoProvider",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getSsoProvider()

Returns the SSO provider.

setSsoProvider

void setSsoProvider(java.lang.String ssoProvider)

Sets the SSO provider.

getSsoProviders

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SsoProviders",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String[] getSsoProviders()

Gets the list of valid 'SSO Providers'.

getSsoProviderDisplayNames

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SsoProviderDisplayNames",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String[] getSsoProviderDisplayNames()

Gets the list of valid 'SSO Providers' display Names.

isSSLCertificatesGenerated

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SSLCertificatesGenerated",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isSSLCertificatesGenerated()
                                   throws javax.management.OperationsException

Indicates whether or not SSL certificates have been generated.

Throws:

javax.management.OperationsException

generateSSLCertificates

@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

Schedules a request to generate the certificates required as a prerequisite for enabling SSL, using the specific passphrase. Initial input validation is performed immediately, however actual certificate creation and therefore some possible error cases is deferred until commit time. The newly created certificates overwrite the certificates in the credential store. This is an externally visible change so must be deferred until all config changes are committed - otherwise non-committed (and possibly to be aborted) config changes would leak.

Parameters:

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.

Returns:

returns a message to the user to remind them to do a 'commit' before any results will appear.

Throws:

java.lang.IllegalArgumentException - if the passphrase is less than 6 characters, encoding is not supported, or any argument is null. long.

javax.management.OperationsException

runSSLReport

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.runSSLReport",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String runSSLReport()
                              throws javax.management.OperationsException

Performs SSL pings using the automated SSL configuration and returns a human readable report

Throws:

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

runXMLSSLReport

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.runXMLSSLReport",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String runXMLSSLReport()
                                 throws javax.management.OperationsException

Performs SSL pings using the automated SSL configuration and returns an XML report

Throws:

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

isSSLManualConfig

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SSLManualConfig",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isSSLManualConfig()

Indicates whether or not SSL manual configuration has been enabled for the BI Instance.

setSSLManualConfig

void setSSLManualConfig(boolean b)

Enables or disables manual SSL configuration. If set to true, all other SSL configuration options are ignored. Manually entered SSL config values in configuration files on each machine will remain in force.

isSSLEnabled

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SSLEnabled",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isSSLEnabled()

Indicates whether or not SSL has been enabled for the BI Instance.

setSSLEnabled

void setSSLEnabled(boolean b)
                   throws javax.management.OperationsException

Enables or disables SSL for all communication links between processes of the BI Instance. Ignored if isSSLManualConfig() is true.

Throws:

java.lang.IllegalStateException - if certificates have not yet been generated for the BI Instance.

javax.management.OperationsException

isSSLVerifyPeers

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SSLVerifyPeers",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isSSLVerifyPeers()

Indicates whether or not servers within the system will only allow connections from authenticated clients.

Returns:

setSSLVerifyPeers

void setSSLVerifyPeers(boolean b)

Enables or disables servers requiring that clients are authenticated.

Parameters:

b - set to true to require that clients are authenticated

setSsoProviderLogonURL

void setSsoProviderLogonURL(java.lang.String ssoProviderLogonURL)

Sets the SSO provider LogonURL.

Since:

11.1.1.3.52

getSsoProviderLogonURL

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SsoProviderLogonURL",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getSsoProviderLogonURL()

GetSSO Provider LogonURL.

Since:

11.1.1.3.52

setSsoProviderLogoffURL

void setSsoProviderLogoffURL(java.lang.String ssoProviderLogoffURL)

Sets the SSO provider LogoffURL.

Since:

11.1.1.3.52

getSsoProviderLogoffURL

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.SsoProviderLogoffURL",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getSsoProviderLogoffURL()

GetSSO Provider LogoffURL.

Since:

11.1.1.3.52

getJaznPolicyStripeName

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.JaznPolicyStripeName",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getJaznPolicyStripeName()

Get Jazn Policy Stripe Name.

Since:

11.1.1.6.51

getEndpointURI

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SecurityConfigurationMBean.EndpointURI",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getEndpointURI()

Get Security Service Endpoint URI.

Since:

11.1.1.6.51