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

Interface AuditPolicyMXBean

public interface AuditPolicyMXBean

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	exportAuditConfig(java.lang.String filterPreset, java.lang.String specialUsers, java.lang.String customEvents, java.lang.String componentTypeList, java.lang.String appStripe) Returns the audit configuration for the passed in app stripe
PortableAuditConfig	getAuditConfiguration(java.lang.String appStripe) Returns the audit configuration structure
PortableComponentEvents[]	getComponentEvents(java.lang.String appStripe) Gets the component events for system services
java.lang.String[]	getComponentTypes(java.lang.String appStripes)
java.lang.String	getCustomEvents(java.lang.String appStripe) Returns the custom events for the passed in app stripe
java.lang.String	getFilterPreset(java.lang.String appStripe) Returns the filter preset value set for the given app stripe
long	getMaxLogDirSize(java.lang.String appStripe) Returns the max log directory size for audit log file for the passed in app stripe
long	getMaxLogFileSize(java.lang.String appStripe) Returns the max log file size for audit log file for the passed in app stripe
java.lang.String	getSpecialUsers(java.lang.String appStripe) Returns the special users for the passed in app stripe
PortableAuditConfig	importAuditConfig(java.lang.String auditConfig, java.lang.String appStripe) Imports the audit configuration structure for the passed in app stripe
boolean	isAuditAware(java.lang.String appStripe)
java.lang.String[]	listAppStripes()
void	setCustomEvents(java.lang.String customEvents, java.lang.String appStripe) Sets the custom events for the passed in app stripe
void	setFilterPreset(java.lang.String filterPreset, java.lang.String appStripe) Sets the filter preset for the passed in app stripe
void	setMaxLogDirSize(long maxLogDirSize, java.lang.String appStripe) Sets the max log directory size for the passed in app stripe
void	setMaxLogFileSize(long maxLogFileSize, java.lang.String appStripe) Sets the max log file size for the passed in app stripe
void	setSpecialUsers(java.lang.String specialUsers, java.lang.String appStripe) Sets the special users for the passed in app stripe
void	validateExpression(java.lang.String componentType, java.lang.String eventName, java.lang.String expression) Validates the filter expression
java.lang.String	wlstAuditConfig(java.lang.String appStripe) Returns the audit configuration structure
java.lang.String	wlstAuditEvents(java.lang.String componentType, java.lang.String appStripe) Returns the audit events
java.lang.String	wlstExportAuditConfig(java.lang.String appStripe) Returns the audit configuration for the passed in app stripe
java.lang.String	wlstGetAppStripes()
java.lang.String	wlstGetComponentTypes(java.lang.String appStripe)
java.lang.String	wlstImportAuditConfig(java.lang.String auditConfig, java.lang.String appStripe) Sets the audit configuration structure for the passed in app stripe
java.lang.String	wlstUpdateAuditPolicy(java.lang.String filterPreset, java.lang.String addUsers, java.lang.String removeUsers, java.lang.String addEvents, java.lang.String removeEvents, java.lang.String appStripe) Sets the audit configuration structure for the passed in app stripe

Field Detail

RBN

static final java.lang.String RBN

See Also:

Constant Field Values

Method Detail

getAuditConfiguration

@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.AuditConfiguration",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableAuditConfig getAuditConfiguration(java.lang.String appStripe)
                                          throws oracle.as.jmx.framework.exceptions.ManagementException,
                                                 java.text.ParseException

Returns the audit configuration structure

Parameters:

appStripe - The Application Stripe name

Returns:

PortableAuditConfig A list of all the audit configuration properties

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - ,ParseException

java.text.ParseException

wlstAuditEvents

@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.wlstAuditEvents",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.String wlstAuditEvents(java.lang.String componentType,
                                                  java.lang.String appStripe)

Returns the audit events

Parameters:

componentType - Name of the component whose event definitions are retrieved

appStripe - App Stripe name

Returns:

String which contains all the audit events

wlstAuditConfig

@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.wlstAuditConfig",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.String wlstAuditConfig(java.lang.String appStripe)
                                 throws oracle.as.jmx.framework.exceptions.ManagementException

Returns the audit configuration structure

Parameters:

appStripe - App Stripe Name

Returns:

String A list of all audit filter properties

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

wlstUpdateAuditPolicy

@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.wlstUpdateAuditPolicy",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
java.lang.String wlstUpdateAuditPolicy(java.lang.String filterPreset,
                                                        java.lang.String addUsers,
                                                        java.lang.String removeUsers,
                                                        java.lang.String addEvents,
                                                        java.lang.String removeEvents,
                                                        java.lang.String appStripe)
                                       throws oracle.as.jmx.framework.exceptions.ManagementException

Sets the audit configuration structure for the passed in app stripe

Parameters:

filterPreset - The auditing level

addUsers - List of special users to be added

removeUsers - List of special users to be removed

addEvents - List of custom events to be added

removeEvents - List of custom events to be removed

appStripe - App Stripe name

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

wlstExportAuditConfig

@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.wlstExportAuditConfig",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.String wlstExportAuditConfig(java.lang.String appStripe)
                                       throws oracle.as.jmx.framework.exceptions.ManagementException,
                                              java.io.IOException

Returns the audit configuration for the passed in app stripe

Parameters:

appStripe - App Stripe name

Returns:

String A list of all audit configuration properties

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - ,IOException

java.io.IOException

wlstImportAuditConfig

@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.wlstImportAuditConfig",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
java.lang.String wlstImportAuditConfig(java.lang.String auditConfig,
                                                        java.lang.String appStripe)
                                       throws oracle.as.jmx.framework.exceptions.ManagementException,
                                              java.io.IOException,
                                              java.text.ParseException

Sets the audit configuration structure for the passed in app stripe

Parameters:

auditConfig - A list of all audit configuration properties

appStripe - App Stripe name

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - ,IOException

java.io.IOException

java.text.ParseException

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,
                                                       java.lang.String appStripe)
                                      throws oracle.as.jmx.framework.exceptions.ManagementException,
                                             java.io.IOException,
                                             java.text.ParseException

Imports the audit configuration structure for the passed in app stripe

Parameters:

auditConfig -

appStripe - App Stripe name

Returns:

PortableAuditConfig A list of all the audit configuration properties

Throws:

oracle.as.jmx.framework.exceptions.ManagementException - ,IOException

java.io.IOException

java.text.ParseException

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 componentTypeList,
                                                    java.lang.String appStripe)
                                   throws java.io.IOException

Returns the audit configuration for the passed in app stripe

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 Customs

appStripe - App Stripe name

Returns:

String A list of all the audit configuration properties

Throws:

java.io.IOException

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

appStripe - App Stripe name

Throws:

java.text.ParseException

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 appStripe)
                                             throws oracle.as.jmx.framework.exceptions.ManagementException

Gets the component events for system services

Parameters:

language - Language in which the display name, help text will be displayed

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")
@Impact(value=0)
java.lang.String getFilterPreset(java.lang.String appStripe)
                                 throws oracle.as.jmx.framework.exceptions.ManagementException

Returns the filter preset value set for the given app stripe

Parameters:

appStripe - App Stripe Name

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")
@Impact(value=0)
long getMaxLogFileSize(java.lang.String appStripe)
                       throws oracle.as.jmx.framework.exceptions.ManagementException

Returns the max log file size for audit log file for the passed in app stripe

Parameters:

appStripe - App Stripe Name

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")
@Impact(value=0)
long getMaxLogDirSize(java.lang.String appStripe)
                      throws oracle.as.jmx.framework.exceptions.ManagementException

Returns the max log directory size for audit log file for the passed in app stripe

Parameters:

appStripe - App Stripe Name

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")
@Impact(value=0)
java.lang.String getCustomEvents(java.lang.String appStripe)
                                 throws oracle.as.jmx.framework.exceptions.ManagementException

Returns the custom events for the passed in app stripe

Parameters:

appStripe - App Stripe name

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")
@Impact(value=0)
java.lang.String getSpecialUsers(java.lang.String appStripe)
                                 throws oracle.as.jmx.framework.exceptions.ManagementException

Returns the special users for the passed in app stripe

Parameters:

appStripe - App Stripe Name

Returns:

String List of special users for audit for the given app stripe

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

setFilterPreset

@Impact(value=1)
void setFilterPreset(java.lang.String filterPreset,
                          java.lang.String appStripe)
                     throws oracle.as.jmx.framework.exceptions.ManagementException

Sets the filter preset for the passed in app stripe

Parameters:

filterPreset - The auditing level

appStripe - App Stripe name

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

setMaxLogFileSize

@Impact(value=1)
void setMaxLogFileSize(long maxLogFileSize,
                            java.lang.String appStripe)
                       throws oracle.as.jmx.framework.exceptions.ManagementException

Sets the max log file size for the passed in app stripe

Parameters:

maxLogFileSize - The max log file size for audit

appStripe - App Stripe name

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

setMaxLogDirSize

@Impact(value=1)
void setMaxLogDirSize(long maxLogDirSize,
                           java.lang.String appStripe)
                      throws oracle.as.jmx.framework.exceptions.ManagementException

Sets the max log directory size for the passed in app stripe

Parameters:

maxLogDirSize - The max log directory size for audit logs

appStripe - App Stripe name

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

setSpecialUsers

@Impact(value=1)
void setSpecialUsers(java.lang.String specialUsers,
                          java.lang.String appStripe)
                     throws oracle.as.jmx.framework.exceptions.ManagementException

Sets the special users for the passed in app stripe

Parameters:

specialUsers - List for special users for audit

appStripe - App Stripe name

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

setCustomEvents

@Impact(value=1)
void setCustomEvents(java.lang.String customEvents,
                          java.lang.String appStripe)
                     throws oracle.as.jmx.framework.exceptions.ManagementException,
                            java.text.ParseException

Sets the custom events for the passed in app stripe

Parameters:

customEvents - List of custom events for audit

appStripe - App Stripe name

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

java.text.ParseException

isAuditAware

@Impact(value=0)
boolean isAuditAware(java.lang.String appStripe)
                     throws oracle.as.jmx.framework.exceptions.ManagementException,
                            java.text.ParseException

Parameters:

appStripe -

Returns:

true if the appStripe is known to the Audit Framework. false otherwise.

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

java.text.ParseException

listAppStripes

@Impact(value=0)
java.lang.String[] listAppStripes()
                                  throws oracle.as.jmx.framework.exceptions.ManagementException

Returns:

the app stripes configured with this audit policy store

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

getComponentTypes

@Impact(value=0)
java.lang.String[] getComponentTypes(java.lang.String appStripes)
                                     throws oracle.as.jmx.framework.exceptions.ManagementException

Parameters:

appStripes -

Returns:

the list of component types for a particular app stripe

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

wlstGetAppStripes

@Impact(value=0)
java.lang.String wlstGetAppStripes()
                                   throws oracle.as.jmx.framework.exceptions.ManagementException

Throws:

oracle.as.jmx.framework.exceptions.ManagementException

wlstGetComponentTypes

@Impact(value=0)
java.lang.String wlstGetComponentTypes(java.lang.String appStripe)
                                       throws oracle.as.jmx.framework.exceptions.ManagementException

Throws:

oracle.as.jmx.framework.exceptions.ManagementException