|
Oracle Fusion Middleware Java API Reference for Oracle Platform Security Services 11g Release 1 (11.1.1) E14650-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.security.jps.service.audit.AuditEvent
public class AuditEvent
Field Summary | |
---|---|
static java.lang.String |
APPLICATION_NAME |
static java.lang.String |
COMPONENT_NAME |
static java.lang.String |
COMPONENT_TYPE |
static java.lang.String |
CONTEXT_FIELDS |
static java.lang.String |
DOWNSTREAM_COMPONENT_ID |
static java.lang.String |
EVENT_CATEGORY |
static java.lang.String |
EVENT_STATUS |
static java.lang.String |
EVENT_TYPE |
static java.lang.String |
EXEC_CONTEXT_INSTANCE |
static java.lang.String |
EXEC_CONTEXT_SEQ |
static java.lang.String |
EXEC_CONTEXT_UNIQUE_ID |
static java.lang.String |
FAILURE_CODE |
static java.lang.String |
GENERIC_AUDIT_EVENT |
static java.lang.String |
GENERIC_AUDIT_EVENT_CATEGORY |
static java.lang.String |
HOST_ID |
static java.lang.String |
HOST_NWADDR |
static java.lang.String |
HOSTING_CLIENT_ID |
static java.lang.String |
INITIATOR |
static java.lang.String |
INITIATORDN |
static java.lang.String |
INSTANCE_ID |
static java.lang.String |
MESSAGE_TEXT |
static java.lang.String |
MODULE_ID |
static java.lang.String |
ORACLE_HOME |
static java.lang.String |
ORACLE_INSTANCE |
static java.lang.String |
ORGANIZATION_ID |
static java.lang.String |
PROCESS_ID |
static java.lang.String |
REMOTE_IP |
static java.lang.String |
RESOURCE |
static java.lang.String |
RID |
static java.lang.String |
ROLES |
static java.lang.String |
SECONDARY_SESSION_ID |
static java.lang.String |
SESSION_ID |
static java.lang.String |
TARGET |
static java.lang.String |
TARGET_COMPONENT_TYPE |
static java.lang.String |
THREAD_ID |
static java.lang.String |
TRANSACTION_ID |
static java.lang.String |
TSTZ_ORIGINATING |
static java.lang.String |
UPSTREAM_COMPONENT_ID |
Constructor Summary | |
---|---|
AuditEvent() |
|
AuditEvent(AuditContext ctx) Create a new AuditEvent object, with default values for certain fields. |
|
AuditEvent(AuditContext ctx, java.util.HashMap<java.lang.String,java.lang.Object> props) Creates a new AuditEvent taking the message field values from a Properties list. |
|
AuditEvent(AuditContext ctx, java.lang.String eventType, java.lang.String eventCategory, boolean eventStatus, java.lang.String messageText) Creates a new AuditEvent. |
|
AuditEvent(boolean initialize) |
Method Summary | |
---|---|
java.lang.String |
getApplicationName() |
java.lang.Object |
getAttribute(java.lang.String attributeName) The getAttribute() method is used to get the value of an attribute with the given name. |
boolean |
getAttributeBoolean(java.lang.String attributeName) The getAttributeBoolean() method is used to get the value of an attribute with the given name. |
byte[] |
getAttributeByteArray(java.lang.Object attributeName) The getAttributeByteArray() method is used to get the value of an attribute with the given name. |
java.util.Date |
getAttributeDate(java.lang.String attributeName) The getAttributeDouble() method is used to get the value of an attribute with the given name. |
double |
getAttributeDouble(java.lang.String attributeName) The getAttributeDouble() method is used to get the value of an attribute with the given name. |
float |
getAttributeFloat(java.lang.String attributeName) The getAttributeFloat() method is used to get the value of an attribute with the given name. |
int |
getAttributeInt(java.lang.String attributeName) The getAttributeInt() method is used to get the value of an attribute with the given name. |
long |
getAttributeLong(java.lang.String attributeName) The getAttributeLong() method is used to get the value of an attribute with the given name. |
java.lang.String[] |
getAttributeNames() |
java.util.Map<java.lang.String,java.lang.Object> |
getAttributes() |
java.lang.String |
getAttributeString(java.lang.String attributeName) The getAttributeString() method is used to get the value of an attribute with the given name. |
java.lang.String |
getComponentName() The getComponentName() method is used to get the name of the component generating the event. |
java.lang.String |
getComponentType() The getComponentType() method is used to get the name of the component generating the event. |
java.lang.String |
getContextFields() |
java.lang.String |
getDownstreamComponentId() Deprecated. The downStreamComponentId attribute is no longer used |
java.lang.String |
getECID() The getECID() method is used to set the Execution Context ID. |
java.lang.String |
getEventCategory() The getEventCategory() method is used to get the category of the event. |
java.lang.Object |
getEventDefinition() The getEventDefinition() method is used to get the event definition. |
boolean |
getEventStatus() The getStatus() method is used to get the event status. |
long |
getEventTimestamp() The getEventTimestamp() method is used to get the event creation time. |
java.lang.String |
getEventType() The getEventType() method is used to get the type of the event. |
java.lang.String |
getFailureCode() The getFailureCode() method is used to get the failure code. |
java.lang.String |
getHostId() The getHostId() method is used to get the Host ID. |
java.lang.String |
getHostingClientId() Deprecated. The hostClientId attribute is no longer used |
java.lang.String |
getHostNetworkAddr() The getHostNetworkAddr() method is used to get the Network Address of host generating the event. |
java.lang.String |
getInitiator() The getInitiator() method is used to get the Initiator of the event. |
java.lang.String |
getInstanceId() The getInstanceId() method is used to get the Instance ID. |
java.lang.String |
getMessageText() The getMessageText() method is used to get Supplemental Details. |
java.lang.String |
getModuleId() The getModuleId() method is used to get the module id. |
java.lang.String |
getOracleHome() The getOracleHome() method is used to get the ORACLE HOME. |
java.lang.String |
getOracleInstance() The getOracleInstance() method is used to get the Oracle Intance. |
java.lang.String |
getOrganizationId() Deprecated. The organizationId attribute is no longer used |
java.lang.String |
getProcessId() The getProcessId() method is used to get the process ID of the process generating the event. |
java.lang.String |
getRemoteIP() |
java.lang.String |
getResource() |
java.lang.String |
getRID() |
java.lang.String |
getRoles() |
java.lang.String |
getSecondarySessionId() Deprecated. The secondarySessionId attribute is no longer used |
java.lang.String |
getTarget() |
java.lang.String |
getTargetComponentType() |
java.lang.String |
getThreadId() The getThreadId() method is used to get the Thread ID. |
java.lang.String |
getTransactionId() The getTransactionId() method is used to get the Transaction ID. |
java.lang.String |
getUpstreamComponentId() Deprecated. The upStreamComponentId attribute is no longer used |
void |
setApplicationName(java.lang.String applicationName) The setApplicationName() method is used to set the name of the application generating the event. |
void |
setAttribute(java.lang.String attributeName, java.lang.Object attributeValue) The setAttribute() method is used to set a (attribute-name, attribute-value) pair. |
void |
setAttributeBoolean(java.lang.String attributeName, boolean attributeValue) The setAttributeBoolean() method is used to set a (attribute-name, attribute-value) pair. |
void |
setAttributeBoolean(java.lang.String attributeName, java.lang.Boolean attributeValue) The setAttributeBoolean() method is used to set a (attribute-name, attribute-value) pair. |
void |
setAttributeByteArray(java.lang.String attributeName, byte[] attributeValue) The setAttributeByteArray method is used to set a (attribute-name, attribute-value) pair. |
void |
setAttributeDate(java.lang.String attributeName, java.util.Date attributeValue) The setAttributeDate() method is used to set a (attribute-name, attribute-value) pair. |
void |
setAttributeDouble(java.lang.String attributeName, int attributeValue) The setAttributeDouble() method is used to set a (attribute-name, attribute-value) pair. |
void |
setAttributeFloat(java.lang.String attributeName, float attributeValue) The setAttributeFloat() method is used to set a (attribute-name, attribute-value) pair. |
void |
setAttributeInt(java.lang.String attributeName, int attributeValue) The setAttributeInt() method is used to set a (attribute-name, attribute-value) pair. |
void |
setAttributeLong(java.lang.String attributeName, long attributeValue) The setAttributeLong() method is used to set a (attribute-name, attribute-value) pair. |
void |
setAttributeString(java.lang.String attributeName, java.lang.String attributeValue) The setAttributeString() method is used to set a (attribute-name, attribute-value) pair. |
void |
setComponentName(java.lang.String componentName) The setComponentName() method is used to set the name of the component generating the event. |
void |
setComponentType(java.lang.String componentType) The setComponentType() method is used to set the type of the component generating the event. |
void |
setContextFields(java.lang.String contextFields) |
void |
setDownstreamComponentId(java.lang.String downstreamComponentId) Deprecated. The downStreamComponentId attribute is no longer used |
void |
setECID(java.lang.String ecid) The setECID() method is used to set the Execution Context ID. |
void |
setEventCategory(java.lang.String category) The setEventCategory() method is used to set the category of the event. |
void |
setEventDefinition(java.lang.Object eventDefinition) The setEventDefinition() method is used to set the event definition. |
void |
setEventStatus(boolean status) The setEventStatus() method is used to set the event status. |
void |
setEventTimestamp(long eventTimestamp) The setEventTimestamp() method is used to set the event creation time. |
void |
setEventType(java.lang.String eventType) The setEventType() method is used to set the type of the event. |
void |
setFailureCode(java.lang.String failureCode) The setFailureCode() method is used to set the failureCode. |
void |
setHostId(java.lang.String hostId) The setHostId() method is used to set the Host ID. |
void |
setHostingClientId(java.lang.String hostClientId) Deprecated. The hostClientId attribute is no longer used |
void |
setHostNetworkAddr(java.lang.String hostNetworkAddr) The setHostNetworkAddr() method is used to set the Network Address of host generating the event. |
void |
setInitiator(java.lang.String initiator) The setInitiator() method is used to set the Initiator. |
void |
setInitiatorDN(java.lang.String DN) Deprecated. |
void |
setInstanceId(java.lang.String instanceId) The setInstanceId() method is used to set the Instance ID. |
void |
setMessageText(java.lang.String messageText) The setMessageText() method is used to set the Supplemental Details. |
void |
setModuleId(java.lang.String moduleId) The setModuleId() method is used to set the module id. |
void |
setOracleHome(java.lang.String oracleHome) The setOracleHome() method is used to set the oracleHome. |
void |
setOracleInstance(java.lang.String oracleInstance) The setOracleInstance() method is used to set the oracleInstance. |
void |
setOrganizationId(java.lang.String organizationId) Deprecated. The organizationId attribute is no longer used |
void |
setProcessId(java.lang.String processId) The setProcessId() method is used to set the processId of the process generating the event. |
void |
setRemoteIP(java.lang.String value) |
void |
setResource(java.lang.String value) |
void |
setRID(java.lang.String rid) |
void |
setRoles(java.lang.String value) |
void |
setSecondarySessionId(java.lang.String secondarySessionId) Deprecated. The secondarySessionId attribute is no longer used |
void |
setTarget(java.lang.String value) |
void |
setTargetComponentType(java.lang.String targetComponentType) |
void |
setTargetDN(java.lang.String DN) Deprecated. |
void |
setThreadId(java.lang.String threadId) The setThreadId() method is used to set the Thread ID. |
void |
setTransactionId(java.lang.String transactionId) The setTransactionId() method is used to set the Transaction ID. |
void |
setUpstreamComponentId(java.lang.String upstreamComponentId) Deprecated. The upStreamComponentId attribute is no longer used |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String GENERIC_AUDIT_EVENT
public static final java.lang.String GENERIC_AUDIT_EVENT_CATEGORY
public static final java.lang.String ORGANIZATION_ID
public static final java.lang.String COMPONENT_NAME
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String INSTANCE_ID
public static final java.lang.String HOSTING_CLIENT_ID
public static final java.lang.String HOST_ID
public static final java.lang.String HOST_NWADDR
public static final java.lang.String MODULE_ID
public static final java.lang.String PROCESS_ID
public static final java.lang.String THREAD_ID
public static final java.lang.String ORACLE_HOME
public static final java.lang.String ORACLE_INSTANCE
public static final java.lang.String TARGET_COMPONENT_TYPE
public static final java.lang.String EXEC_CONTEXT_INSTANCE
public static final java.lang.String RID
public static final java.lang.String EXEC_CONTEXT_UNIQUE_ID
public static final java.lang.String EXEC_CONTEXT_SEQ
public static final java.lang.String UPSTREAM_COMPONENT_ID
public static final java.lang.String DOWNSTREAM_COMPONENT_ID
public static final java.lang.String SESSION_ID
public static final java.lang.String SECONDARY_SESSION_ID
public static final java.lang.String APPLICATION_NAME
public static final java.lang.String CONTEXT_FIELDS
public static final java.lang.String EVENT_STATUS
public static final java.lang.String FAILURE_CODE
public static final java.lang.String EVENT_TYPE
public static final java.lang.String EVENT_CATEGORY
public static final java.lang.String TSTZ_ORIGINATING
public static final java.lang.String INITIATOR
public static final java.lang.String INITIATORDN
public static final java.lang.String MESSAGE_TEXT
public static final java.lang.String TRANSACTION_ID
public static final java.lang.String REMOTE_IP
public static final java.lang.String TARGET
public static final java.lang.String RESOURCE
public static final java.lang.String ROLES
Constructor Detail |
---|
public AuditEvent()
public AuditEvent(boolean initialize)
public AuditEvent(AuditContext ctx, java.lang.String eventType, java.lang.String eventCategory, boolean eventStatus, java.lang.String messageText)
The following message fields are initialized internally: originating timestamp, host name, and host network address. The remaining fields are initialized from the values passed as arguments to this method.
If any argument is invalid, the method will attempt to throw a AuditException, by passing this exception to the exception handler. If the handler returns, then a message will be created with arbitrary values in place of the invalid arguments.
ctx
- AuditContexteventType
- Type of the eventeventCategory
- Category of the eventeventStatus
- Status [SUCCESS/FAILURE] of the operation that caused the eventmessageText
- text messagepublic AuditEvent(AuditContext ctx)
ctx
- - an AuditContext Objectpublic AuditEvent(AuditContext ctx, java.util.HashMap<java.lang.String,java.lang.Object> props)
Use the fields provided in this class for the property names.
Example:
java.util.Properties props = new java.util.Properties(); props.setProperty(TestLogMessage.ORGANIZATION_ID, "oracle"); props.setProperty(TestLogMessage.COMPONENT_ID, "myComponent"); AuditEvent msg = new AuditEvent(ctx, props);
props
- A Properties list containing message fields.Method Detail |
---|
public void setEventDefinition(java.lang.Object eventDefinition)
EventDefinition
- object.public java.lang.Object getEventDefinition()
public void setApplicationName(java.lang.String applicationName)
applicationName
- object.public java.lang.String getApplicationName()
public void setUpstreamComponentId(java.lang.String upstreamComponentId)
upstreamComponentId
- object.public java.lang.String getUpstreamComponentId()
public void setDownstreamComponentId(java.lang.String downstreamComponentId)
downstreamComponentId
- object.public java.lang.String getDownstreamComponentId()
public void setECID(java.lang.String ecid)
ecid
- object.public java.lang.String getECID()
public void setRID(java.lang.String rid)
public java.lang.String getRID()
public void setSecondarySessionId(java.lang.String secondarySessionId)
secondarySessionId
- object.public java.lang.String getSecondarySessionId()
public void setComponentName(java.lang.String componentName)
componentName
- object.public java.lang.String getComponentName()
public void setComponentType(java.lang.String componentType)
componentType
- object.public java.lang.String getComponentType()
public void setEventType(java.lang.String eventType)
eventType
- object.public java.lang.String getEventType()
public void setEventCategory(java.lang.String category)
category
- object.public java.lang.String getEventCategory()
public void setEventTimestamp(long eventTimestamp)
eventTimestamp
- object.public long getEventTimestamp()
public void setFailureCode(java.lang.String failureCode)
failureCode
- object.public java.lang.String getFailureCode()
public void setHostId(java.lang.String hostId)
hostId
- object.public java.lang.String getHostId()
public void setHostingClientId(java.lang.String hostClientId)
hostClientId
- object.public java.lang.String getHostingClientId()
public void setHostNetworkAddr(java.lang.String hostNetworkAddr)
hostNetworkAddr
- object.public java.lang.String getHostNetworkAddr()
public void setModuleId(java.lang.String moduleId)
moduleId
- object.public java.lang.String getModuleId()
public void setInitiator(java.lang.String initiator)
initiator
- object.public java.lang.String getInitiator()
public void setInitiatorDN(java.lang.String DN)
DN
- the Distinguished Name for the Initiator is anypublic void setTargetDN(java.lang.String DN)
DN
- the Distinguished Name for the Target is anypublic void setInstanceId(java.lang.String instanceId)
instanceId
- String object.public java.lang.String getInstanceId()
public void setOrganizationId(java.lang.String organizationId)
organizationId
- object.public java.lang.String getOrganizationId()
public void setOracleHome(java.lang.String oracleHome)
oracleHome
- object.public java.lang.String getOracleHome()
public void setOracleInstance(java.lang.String oracleInstance)
oracleInstance
- object.public java.lang.String getOracleInstance()
public void setProcessId(java.lang.String processId)
processId
- object.public java.lang.String getProcessId()
public void setEventStatus(boolean status)
status
- object.public boolean getEventStatus()
public void setMessageText(java.lang.String messageText)
messageText
- object.public java.lang.String getMessageText()
public void setThreadId(java.lang.String threadId)
threadId
- object.public java.lang.String getThreadId()
public void setTransactionId(java.lang.String transactionId)
transactionId
- object.public java.lang.String getTransactionId()
public void setTargetComponentType(java.lang.String targetComponentType)
public java.lang.String getTargetComponentType()
public void setRemoteIP(java.lang.String value)
public java.lang.String getRemoteIP()
public void setTarget(java.lang.String value)
public java.lang.String getTarget()
public void setResource(java.lang.String value)
public java.lang.String getResource()
public void setRoles(java.lang.String value)
public java.lang.String getRoles()
public java.lang.String[] getAttributeNames()
public void setContextFields(java.lang.String contextFields)
public java.lang.String getContextFields()
public java.util.Map<java.lang.String,java.lang.Object> getAttributes()
public void setAttribute(java.lang.String attributeName, java.lang.Object attributeValue)
attributeName
- name of the attribute.attributeValue
- value of the attribute.public java.lang.Object getAttribute(java.lang.String attributeName)
public void setAttributeString(java.lang.String attributeName, java.lang.String attributeValue)
attributeName
- name of the attribute.attributeValue
- value of the attribute.public java.lang.String getAttributeString(java.lang.String attributeName)
public void setAttributeInt(java.lang.String attributeName, int attributeValue)
attributeName
- name of the attribute.attributeValue
- value of the attribute.public int getAttributeInt(java.lang.String attributeName)
public void setAttributeLong(java.lang.String attributeName, long attributeValue)
attributeName
- name of the attribute.attributeValue
- value of the attribute.public long getAttributeLong(java.lang.String attributeName)
public void setAttributeFloat(java.lang.String attributeName, float attributeValue)
attributeName
- name of the attribute.attributeValue
- value of the attribute.public float getAttributeFloat(java.lang.String attributeName)
public void setAttributeBoolean(java.lang.String attributeName, boolean attributeValue)
attributeName
- name of the attribute.attributeValue
- value of the attribute.public void setAttributeBoolean(java.lang.String attributeName, java.lang.Boolean attributeValue)
attributeName
- name of the attribute.attributeValue
- value of the attribute.public boolean getAttributeBoolean(java.lang.String attributeName)
public void setAttributeDouble(java.lang.String attributeName, int attributeValue)
attributeName
- name of the attribute.attributeValue
- value of the attribute.public double getAttributeDouble(java.lang.String attributeName)
public void setAttributeDate(java.lang.String attributeName, java.util.Date attributeValue)
attributeName
- name of the attribute.attributeValue
- value of the attribute.public java.util.Date getAttributeDate(java.lang.String attributeName)
public void setAttributeByteArray(java.lang.String attributeName, byte[] attributeValue)
attributeName
- name of the attribute.attributeValue
- value of the attribute.public byte[] getAttributeByteArray(java.lang.Object attributeName)
|
Oracle Fusion Middleware Java API Reference for Oracle Platform Security Services 11g Release 1 (11.1.1) E14650-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |