oracle.security.jps.mas.mgmt.jmx.audit

Interface JpsAuditMXBean

@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

Property Summary

Type	Property and Description
boolean	checkAuditService

Field Summary

Fields

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

Method Summary

All MethodsInstance MethodsAbstract Methods

Modifier and Type	Method and Description
boolean	checkAuditServiceProperty()
java.lang.String	createAuditDBView(java.lang.String componentType) Generates a script for creating a DB view for the passed in component
java.lang.String	createAuditDBView(java.lang.String componentType, java.lang.String dbType) Generates a script for creating a DB view for the passed in component and DB type
java.lang.String	createAuditDBView(java.lang.String componentType, java.lang.String dbType, java.lang.String viewType) Generates a script for creating a DB view for the passed in component and DB type
java.lang.String	createIAUView(java.lang.String componentType, java.lang.String viewType) Creates a IAU DB view for the passed in component in the Audit DB configured in the domain.
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() Gets the component events of all components for audit service
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
java.lang.String	getIAUViewInfo(java.lang.String componentType) Retrieves the IAU View information for a given component.
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	registerAudit(byte[] byteXml, byte[] byteXlf, java.lang.String componentType, java.lang.String mode, java.lang.String createView) 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

Property Detail

checkAuditService

boolean checkAuditServiceProperty

Field Detail

RBN

static final java.lang.String RBN

See Also:

Constant Field Values

Method Detail

refresh

@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

Refreshes state by reloading from backing store (which might have changed)

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

importAuditConfig

@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

Returns the audit configuration structure

Returns:

PortableAuditConfig A list of all the audit configuration properties

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

importAuditConfig

void importAuditConfig(java.lang.String auditConfig,
                       java.lang.String componentType)
                throws oracle.as.jmx.framework.exceptions.ManagementException

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

exportAuditConfig

@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

Returns the audit configuration

Parameters:

filterPreset - The auditing level

specialUsers - List of users for whom auditing is always enabled

customEvents - List of events to be audited if filterPreset is Custom s

Returns:

String A list of all the audit configuration properties

Throws:

java.io.IOException

oracle.as.jmx.framework.exceptions.ManagementException

exportAuditConfig

@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

Returns the audit configuration

Parameters:

filterPreset - The auditing level

specialUsers - List of users for whom auditing is always enabled

customEvents - List of events to be audited if filterPreset is Custom

maxDirSize - Max dir size

maxFileSize - Max audit log file size

componentType - The name of the component for which we are exporting the audit configuration

Returns:

String A list of all the audit configuration properties

Throws:

java.io.IOException

oracle.as.jmx.framework.exceptions.ManagementException

getAuditConfiguration

@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

Returns the audit configuration structure

Returns:

PortableAuditConfig A list of all the audit configuration properties

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

setAuditConfiguration

void setAuditConfiguration(PortableAuditConfig auditConfig)
                    throws oracle.as.jmx.framework.exceptions.ManagementException

Sets the audit configuration structure

Parameters:

PortableAuditConfig - A list of all the audit configuration properties

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

validateExpression

@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

Validates the filter expression

Parameters:

componentType - The component whose event needs to be checked

eventName - Event for which the expression needs to be validated

expression - Expression that is to be validated

Throws:

java.text.ParseException

validateAuditDataSources

@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)

Validates the audit data sources

Parameters:

jndi - List of jndi names to be validated

Returns:

String[] An array of valid audit data sources

Throws:

java.text.ParseException

getAuditLoaderConfiguration

@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

Returns the audit loader configuration structure

Returns:

PortableAuditLoaderConfig A list of all the audit loader properties

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

setAuditLoaderConfiguration

void setAuditLoaderConfiguration(PortableAuditLoaderConfig auditLoaderConfig)
                          throws oracle.as.jmx.framework.exceptions.ManagementException

Sets the audit loader configuration structure

Parameters:

auditLoaderConfig - A list of all the audit loader properties

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

getComponentEvents

@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)

Gets the component events of all components for audit service

Parameters:

language - This parameter is not used

Returns:

PortableComponentEvents An array which contains the event definitions for all the components

getComponentEvents

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

Gets the component events of all components for audit service

Returns:

PortableComponentEvents An array which contains the event definitions for all the components

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

getFilterPreset

@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

Returns the filter preset for audit service

Returns:

String The auditing level

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

getMaxLogFileSize

@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

Returns the max log file size for audit log file

Returns:

long The max log file size for audit

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

getMaxLogDirSize

@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

Returns the max log directory size for audit logs

Returns:

long The max log directory size for audit logs

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

getCustomEvents

@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

Returns the custom events for audit service

Returns:

String A list of custom events

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

getSpecialUsers

@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

Returns the special users for audit service

Returns:

String List of special users for audit

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

setFilterPreset

void setFilterPreset(java.lang.String filterPreset)
              throws oracle.as.jmx.framework.exceptions.ManagementException

Sets the filter preset for audit service

Parameters:

filterPreset - The auditing level

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

setMaxLogFileSize

void setMaxLogFileSize(long maxLogFileSize)
                throws oracle.as.jmx.framework.exceptions.ManagementException

Sets the max log file size for audit log

Parameters:

maxLogFileSize - The max log file size for audit

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

setMaxLogDirSize

void setMaxLogDirSize(long maxLogDirSize)
               throws oracle.as.jmx.framework.exceptions.ManagementException

Sets the max log directory size for audit logs

Parameters:

maxLogDirSize - This will be deprecated soon. Setting this has no effect.

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

setSpecialUsers

void setSpecialUsers(java.lang.String specialUsers)
              throws oracle.as.jmx.framework.exceptions.ManagementException

Sets the special users for audit service

Parameters:

specialUsers - List for special users for audit

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

setCustomEvents

void setCustomEvents(java.lang.String customEvents)
              throws oracle.as.jmx.framework.exceptions.ManagementException,
                     java.text.ParseException

Sets the custom events for audit service

Parameters:

customEvents - List of custom events for audit

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

java.text.ParseException

checkAuditServiceProperty

boolean checkAuditServiceProperty()

persist

void persist()
      throws oracle.as.jmx.framework.exceptions.ManagementException

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

createAuditDBView

java.lang.String createAuditDBView(java.lang.String componentType)
                            throws oracle.as.jmx.framework.exceptions.ManagementException

Generates a script for creating a DB view for the passed in component

Parameters:

componentType - Name of the component

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - When creating the sql script

createAuditDBView

java.lang.String createAuditDBView(java.lang.String componentType,
                                   java.lang.String dbType)
                            throws oracle.as.jmx.framework.exceptions.ManagementException

Generates a script for creating a DB view for the passed in component and DB type

Parameters:

componentType - Name of the component

dbType - Type of the Security Store being used

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - When creating the sql script

createAuditDBView

java.lang.String createAuditDBView(java.lang.String componentType,
                                   java.lang.String dbType,
                                   java.lang.String viewType)
                            throws oracle.as.jmx.framework.exceptions.ManagementException

Generates a script for creating a DB view for the passed in component and DB type

Parameters:

componentType - Name of the component

dbType - Type of the Security Store being used

viewType - Type of the DB View - simple or indexable

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - When creating the sql script

updateAuditPolicy

void updateAuditPolicy(java.lang.String componentType,
                       javax.management.openmbean.CompositeData cd)
                throws oracle.as.jmx.framework.exceptions.ManagementException

Updates the audit policy

Parameters:

componentType - The component name

cd - The audit attributes passed in as composite data

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

getAuditConfiguration

PortableAuditConfig getAuditConfiguration(java.lang.String componentType)
                                   throws oracle.as.jmx.framework.exceptions.ManagementException

Parameters:

componentType - Name of the component whose audit configuration is retrieved returns PortableAuditConfig

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

importAuditConfiguration

PortableAuditConfig importAuditConfiguration(java.lang.String auditConfig,
                                             java.lang.String componentType)
                                      throws oracle.as.jmx.framework.exceptions.ManagementException

Imports the audit configuration structure for the component

Parameters:

auditConfig - A list of all audit configuration properties

componentType - Component Name

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

exportAuditConfiguration

java.lang.String exportAuditConfiguration(java.lang.String componentType)
                                   throws oracle.as.jmx.framework.exceptions.ManagementException

Exports the audit configuration structure for the component

Parameters:

componentType - Component Name

Returns:

String A list of all the audit configuration properties

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

setConfigFilePath

void setConfigFilePath(java.lang.String fname)

listAuditComponents

java.lang.String listAuditComponents()
                              throws oracle.as.jmx.framework.exceptions.ManagementException

Lists all the components that can be audited

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - When creating the list of audit components fails

registerAudit

void registerAudit(byte[] byteXml,
                   byte[] byteXlf,
                   java.lang.String componentType,
                   java.lang.String mode)
            throws oracle.as.jmx.framework.exceptions.ManagementException

Registers the audit definition files for a given component

Parameters:

byteXml - byte array of the xml file

byteXlf - byte array of the xlf jar file

componentType - Component Name

mode - option to either overwrite or upgrade

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

registerAudit

void registerAudit(byte[] byteXml,
                   byte[] byteXlf,
                   java.lang.String componentType,
                   java.lang.String mode,
                   java.lang.String createView)
            throws oracle.as.jmx.framework.exceptions.ManagementException

Registers the audit definition files for a given component

Parameters:

byteXml - byte array of the xml file

byteXlf - byte array of the xlf jar file

componentType - Component Name

mode - option to either overwrite or upgrade

createView - option to create the view in IAU schema

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

deregisterAudit

void deregisterAudit(java.lang.String componentType)
              throws oracle.as.jmx.framework.exceptions.ManagementException

Deregisters the audit definition files for a given component

Parameters:

componentType - Component Name

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

getIAUViewInfo

java.lang.String getIAUViewInfo(java.lang.String componentType)
                         throws oracle.as.jmx.framework.exceptions.ManagementException

Retrieves the IAU View information for a given component.

Parameters:

componentType - Component Name

Returns:

IAU View info

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

createIAUView

java.lang.String createIAUView(java.lang.String componentType,
                               java.lang.String viewType)
                        throws oracle.as.jmx.framework.exceptions.ManagementException

Creates a IAU DB view for the passed in component in the Audit DB configured in the domain.

Parameters:

componentType - Name of the component

viewType - Type of the DB View - SIMPLE or INDEXABLE (default: SIMPLE)

Returns:

String message

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - When creating the IAU view