|
Oracle Fusion Middleware MBeans Java API Reference for Oracle Platform Security Services 11g Release 1 (11.1.1) E14651-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.description",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@ImmutableInfo(value="true")
@Since(value="11.1.1.0.0")
@Visibility(value=Advanced)
@SystemMBean
public interface JpsAuditMXBean
Interface that exposes jmx methods to manage audit store
Field Summary | |
---|---|
static java.lang.String |
RBN |
Method Summary | |
---|---|
boolean |
checkAuditServiceProperty() |
java.lang.String |
createAuditDBView(java.lang.String componentType) Generates a script for creating a DB view for the passed in component |
void |
deregisterAudit(java.lang.String componentType) Deregisters the audit definition files for a given component |
java.lang.String |
exportAuditConfig(java.lang.String filterPreset, java.lang.String specialUsers, java.lang.String customEvents) Returns the audit configuration |
java.lang.String |
exportAuditConfig(java.lang.String filterPreset, java.lang.String specialUsers, java.lang.String customEvents, java.lang.String maxDirSize, java.lang.String maxFileSize, java.lang.String componentType) Returns the audit configuration |
java.lang.String |
exportAuditConfiguration(java.lang.String componentType) Exports the audit configuration structure for the component |
PortableAuditConfig |
getAuditConfiguration() Returns the audit configuration structure |
PortableAuditConfig |
getAuditConfiguration(java.lang.String componentType) |
PortableAuditLoaderConfig |
getAuditLoaderConfiguration() Returns the audit loader configuration structure |
PortableComponentEvents[] |
getComponentEvents(java.lang.String language) Gets the component events of all components for audit service |
java.lang.String |
getCustomEvents() Returns the custom events for audit service |
java.lang.String |
getFilterPreset() Returns the filter preset for audit service |
long |
getMaxLogDirSize() Returns the max log directory size for audit logs |
long |
getMaxLogFileSize() Returns the max log file size for audit log file |
java.lang.String |
getSpecialUsers() Returns the special users for audit service |
PortableAuditConfig |
importAuditConfig(java.lang.String auditConfig) Returns the audit configuration structure |
void |
importAuditConfig(java.lang.String auditConfig, java.lang.String componentType) |
PortableAuditConfig |
importAuditConfiguration(java.lang.String auditConfig, java.lang.String componentType) Imports the audit configuration structure for the component |
java.lang.String |
listAuditComponents() Lists all the components that can be audited |
void |
persist() |
void |
refresh() Refreshes state by reloading from backing store (which might have changed) |
void |
registerAudit(byte[] byteXml, byte[] byteXlf, java.lang.String componentType, java.lang.String mode) Registers the audit definition files for a given component |
void |
setAuditConfiguration(PortableAuditConfig auditConfig) Sets the audit configuration structure |
void |
setAuditLoaderConfiguration(PortableAuditLoaderConfig auditLoaderConfig) Sets the audit loader configuration structure |
void |
setConfigFilePath(java.lang.String fname) |
void |
setCustomEvents(java.lang.String customEvents) Sets the custom events for audit service |
void |
setFilterPreset(java.lang.String filterPreset) Sets the filter preset for audit service |
void |
setMaxLogDirSize(long maxLogDirSize) Sets the max log directory size for audit logs |
void |
setMaxLogFileSize(long maxLogFileSize) Sets the max log file size for audit log |
void |
setSpecialUsers(java.lang.String specialUsers) Sets the special users for audit service |
void |
updateAuditPolicy(java.lang.String componentType, javax.management.openmbean.CompositeData cd) Updates the audit policy |
java.lang.String[] |
validateAuditDataSources(java.lang.String[] jndi) Validates the audit data sources |
void |
validateExpression(java.lang.String componentType, java.lang.String eventName, java.lang.String expression) Validates the filter expression |
Field Detail |
---|
static final java.lang.String RBN
Method Detail |
---|
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.refresh",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void refresh()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.importAuditConfig",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
PortableAuditConfig importAuditConfig(java.lang.String auditConfig)
throws oracle.as.jmx.framework.exceptions.ManagementException
ManagementException,IOException
oracle.as.jmx.framework.exceptions.ManagementException
void importAuditConfig(java.lang.String auditConfig, java.lang.String componentType) throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.importAuditConfig",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.String exportAuditConfig(java.lang.String filterPreset,
java.lang.String specialUsers,
java.lang.String customEvents)
throws oracle.as.jmx.framework.exceptions.ManagementException
filterPreset
- The auditing levelspecialUsers
- List of users for whom auditing is always enabledcustomEvents
- List of events to be audited if filterPreset is Custom sIOException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.importAuditConfig",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.String exportAuditConfig(java.lang.String filterPreset,
java.lang.String specialUsers,
java.lang.String customEvents,
java.lang.String maxDirSize,
java.lang.String maxFileSize,
java.lang.String componentType)
throws oracle.as.jmx.framework.exceptions.ManagementException
filterPreset
- The auditing levelspecialUsers
- List of users for whom auditing is always enabledcustomEvents
- List of events to be audited if filterPreset is CustommaxDirSize
- Max dir sizemaxFileSize
- Max audit log file sizecomponentType
- The name of the component for which we are exporting the audit configurationIOException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.AuditConfiguration",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
PortableAuditConfig getAuditConfiguration()
throws oracle.as.jmx.framework.exceptions.ManagementException
ManagementException,ParseException
oracle.as.jmx.framework.exceptions.ManagementException
void setAuditConfiguration(PortableAuditConfig auditConfig) throws oracle.as.jmx.framework.exceptions.ManagementException
PortableAuditConfig
- A list of all the audit configuration propertiesoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.validateExpression",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
void validateExpression(java.lang.String componentType,
java.lang.String eventName,
java.lang.String expression)
throws java.text.ParseException
componentType
- The component whose event needs to be checkedeventName
- Event for which the expression needs to be validatedexpression
- Expression that is to be validatedjava.text.ParseException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.validateAuditDataSources",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.String[] validateAuditDataSources(java.lang.String[] jndi)
jndis
- List of jndi names to be validatedjava.text.ParseException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.AuditLoaderConfiguration",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
PortableAuditLoaderConfig getAuditLoaderConfiguration()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
void setAuditLoaderConfiguration(PortableAuditLoaderConfig auditLoaderConfig) throws oracle.as.jmx.framework.exceptions.ManagementException
auditLoaderConfig
- A list of all the audit loader propertiesoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.getComponentEvents",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableComponentEvents[] getComponentEvents(java.lang.String language)
language
- Language in which the display name, help text will be displayed
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.FilterPreset",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
java.lang.String getFilterPreset()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.MaxLogFileSize",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
long getMaxLogFileSize()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.MaxLogDirSize",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
long getMaxLogDirSize()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.CustomEvents",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
java.lang.String getCustomEvents()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.SpecialUsers",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
java.lang.String getSpecialUsers()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
void setFilterPreset(java.lang.String filterPreset) throws oracle.as.jmx.framework.exceptions.ManagementException
filterPreset
- The auditing leveloracle.as.jmx.framework.exceptions.ManagementException
void setMaxLogFileSize(long maxLogFileSize) throws oracle.as.jmx.framework.exceptions.ManagementException
maxLogFileSize
- The max log file size for auditoracle.as.jmx.framework.exceptions.ManagementException
void setMaxLogDirSize(long maxLogDirSize) throws oracle.as.jmx.framework.exceptions.ManagementException
maxLogDirSize
- The max log directory size for audit logsoracle.as.jmx.framework.exceptions.ManagementException
void setSpecialUsers(java.lang.String specialUsers) throws oracle.as.jmx.framework.exceptions.ManagementException
specialUsers
- List for special users for auditoracle.as.jmx.framework.exceptions.ManagementException
void setCustomEvents(java.lang.String customEvents) throws oracle.as.jmx.framework.exceptions.ManagementException, java.text.ParseException
customEvents
- List of custom events for auditoracle.as.jmx.framework.exceptions.ManagementException
java.text.ParseException
boolean checkAuditServiceProperty()
void persist() throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
java.lang.String createAuditDBView(java.lang.String componentType) throws oracle.as.jmx.framework.exceptions.ManagementException
componentType
- Name of the componentoracle.as.jmx.framework.exceptions.ManagementException
- When creating the sql scriptvoid updateAuditPolicy(java.lang.String componentType, javax.management.openmbean.CompositeData cd) throws oracle.as.jmx.framework.exceptions.ManagementException
componentType
- The component namecd
- The audit attributes passed in as composite dataoracle.as.jmx.framework.exceptions.ManagementException
PortableAuditConfig getAuditConfiguration(java.lang.String componentType) throws oracle.as.jmx.framework.exceptions.ManagementException
componentType
- Name of the component whose audit configuration is retrieved returns PortableAuditConfigManagementException,AuditException,ParseException
oracle.as.jmx.framework.exceptions.ManagementException
PortableAuditConfig importAuditConfiguration(java.lang.String auditConfig, java.lang.String componentType) throws oracle.as.jmx.framework.exceptions.ManagementException
auditConfig
- A list of all audit configuration propertiescomponentType
- Component NameManagementException,IOException,ParseException,AuditException,JpsException
oracle.as.jmx.framework.exceptions.ManagementException
java.lang.String exportAuditConfiguration(java.lang.String componentType) throws oracle.as.jmx.framework.exceptions.ManagementException
componentType
- Component NameManagementException,IOException,AuditException
oracle.as.jmx.framework.exceptions.ManagementException
void setConfigFilePath(java.lang.String fname)
java.lang.String listAuditComponents() throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
- When creating the list of audit components failsvoid registerAudit(byte[] byteXml, byte[] byteXlf, java.lang.String componentType, java.lang.String mode) throws oracle.as.jmx.framework.exceptions.ManagementException
byteXml
- byte array of the xml filebyteXlf
- byte array of the xlf jar filecomponentType
- Component Namemode
- option to either overwrite or upgradeoracle.as.jmx.framework.exceptions.ManagementException
void deregisterAudit(java.lang.String componentType) throws oracle.as.jmx.framework.exceptions.ManagementException
componentType
- Component Nameoracle.as.jmx.framework.exceptions.ManagementException
|
Oracle Fusion Middleware MBeans Java API Reference for Oracle Platform Security Services 11g Release 1 (11.1.1) E14651-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |