oracle.security.jps.mas.mgmt.jmx.config

Interface ConfigurationMXBean

@Description(resourceKey="oracle.security.jps.management.ConfigurationMXBean.description",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@ImmutableInfo(value="true")
@Since(value="12.2.1.0.0")
@Visibility(value=Advanced)
@SystemMBean
public interface ConfigurationMXBean

This interface exposes methods to get and set OPSS configurations via MBean. In multi-tenanted environment, the methods will work against global or tenant configuration based on connection context.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RBN

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getAllServiceTypes() Returns all service types can be managed by Enterprise Manager.
boolean	isRestartRequired() Returns the flag indicates restart of tenant/global is required to make OPSS service changes to take effect
PortablePropertyMetadata[]	listSecurityStorePropertyMetadata() Returns meta data for security store properties
PortablePropertyMetadata[]	listServicePropertyMetadata(java.lang.String serviceType) Returns meta data for properties of given service type
PortableProperty[]	querySecurityStoreProperties() Returns all properties for security store
PortableProperty[]	queryServiceProperties(java.lang.String serviceType) Returns all properties defined for given service type explicitly.
void	updateSecurityStoreProperties(PortableProperty[] pps) Sets properties for security store.
void	updateServiceProperties(java.lang.String serviceType, PortableProperty[] pps) Sets service properties.

Field Detail

RBN

static final java.lang.String RBN

See Also:

Constant Field Values

Method Detail

listSecurityStorePropertyMetadata

@Description(resourceKey="oracle.security.jps.management.ConfigurationMXBean.listSecurityStorePropertyMetadata",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortablePropertyMetadata[] listSecurityStorePropertyMetadata()
                                                             throws oracle.as.jmx.framework.exceptions.ManagementException

Returns meta data for security store properties

Returns:

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

querySecurityStoreProperties

@Description(resourceKey="oracle.security.jps.management.ConfigurationMXBean.querySecurityStoreProperties",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableProperty[] querySecurityStoreProperties()
                                                throws oracle.as.jmx.framework.exceptions.ManagementException

Returns all properties for security store

Returns:

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

updateSecurityStoreProperties

@Description(resourceKey="oracle.security.jps.management.ConfigurationMXBean.updateSecurityStoreProperties",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
@RequireRestart(value=ContainerRestart)
void updateSecurityStoreProperties(PortableProperty[] pps)
                                   throws oracle.as.jmx.framework.exceptions.ManagementException

Sets properties for security store. To remove one property, pass a PortableProperty with null value

Parameters:

pps -

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

listServicePropertyMetadata

@Description(resourceKey="oracle.security.jps.management.ConfigurationMXBean.listServicePropertyMetadata",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortablePropertyMetadata[] listServicePropertyMetadata(java.lang.String serviceType)
                                                       throws oracle.as.jmx.framework.exceptions.ManagementException

Returns meta data for properties of given service type

Parameters:

serviceType -

Returns:

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

getAllServiceTypes

@Description(resourceKey="oracle.security.jps.management.ConfigurationMXBean.getAllServiceTypes",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.String[] getAllServiceTypes()
                                      throws oracle.as.jmx.framework.exceptions.ManagementException

Returns all service types can be managed by Enterprise Manager.

Returns:

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

queryServiceProperties

@Description(resourceKey="oracle.security.jps.management.ConfigurationMXBean.queryServiceProperties",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableProperty[] queryServiceProperties(java.lang.String serviceType)
                                          throws oracle.as.jmx.framework.exceptions.ManagementException

Returns all properties defined for given service type explicitly. The property not set in the service instance but default value takes effect will not be returned.

Parameters:

serviceType -

Returns:

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

isRestartRequired

@Description(resourceKey="oracle.security.jps.management.ConfigurationMXBean.isRestartRequired",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
boolean isRestartRequired()
                          throws oracle.as.jmx.framework.exceptions.ManagementException

Returns the flag indicates restart of tenant/global is required to make OPSS service changes to take effect

Returns:

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

updateServiceProperties

@Description(resourceKey="oracle.security.jps.management.ConfigurationMXBean.updateServiceProperties",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
@RequireRestart(value=ContainerRestart)
void updateServiceProperties(java.lang.String serviceType,
                                                             PortableProperty[] pps)
                             throws oracle.as.jmx.framework.exceptions.ManagementException

Sets service properties. To remove one property, pass a PortableProperty with null value

Parameters:

serviceType -

pps -

Throws:

oracle.as.jmx.framework.exceptions.ManagementException