Oracle Entitlements Server Provider SSPI API Reference

com.bea.security.spi
Interface ProviderAuditRecord


public interface ProviderAuditRecord
extends AuditEvent

This interface represents an audit record for the auditing provider.

Author:
Copyright © 2004-2008, Oracle and/or its affiliates. All rights reserved.

Field Summary
static java.lang.String REQUESTOR_ALIAS
          The alias that should be used to store the subject of the identity that audited the event.
 
Method Summary
 java.lang.String getAuthorityName()
          Get the name of the naming authority that defines this naming convention.
 ContextHandler getContext()
          Get the context of the application at the time of this audit event.
 java.util.Enumeration getDeepEnumeration()
          Get an enumeration of NameValueTypes that contain this audit record's name fields.
 java.util.Enumeration getEnumeration()
          Get an enumeration of NameValueTypes that contain this audit record's name fields.
 java.lang.Object getSubject(java.lang.String alias)
          Returns the subject associated with the given alias.
 java.util.Enumeration getSubjectAliases()
          Lists all the subject alias names of this audit event.
 void setSubject(java.lang.String alias, java.lang.Object subject)
          Associates the given subject with the supplied alias.
 java.lang.String toString()
          Get a string representation of this resource name.
 
Methods inherited from interface weblogic.security.spi.AuditEvent
getEventType, getFailureException, getSeverity
 

Field Detail

REQUESTOR_ALIAS

public static final java.lang.String REQUESTOR_ALIAS
The alias that should be used to store the subject of the identity that audited the event.
Method Detail

getSubject

public java.lang.Object getSubject(java.lang.String alias)
Returns the subject associated with the given alias.

Parameters:
alias - the alias name
Returns:
the subject associated with the given alias.

setSubject

public void setSubject(java.lang.String alias,
                       java.lang.Object subject)
Associates the given subject with the supplied alias. Multiple subjects may be contained in an audit event, but only a single subject can be associated with a given alias.

Parameters:
alias - the alias name
subject - the subject to assoicate with the given alias

getSubjectAliases

public java.util.Enumeration getSubjectAliases()
Lists all the subject alias names of this audit event. The getSubject(String alias) method can be used to retrieve the subject associated with each alias.

Returns:
an enumeration of all alias names

getContext

public ContextHandler getContext()
Get the context of the application at the time of this audit event.

Returns:
the context at the time of this record as a ContextHandler

getAuthorityName

public java.lang.String getAuthorityName()
Get the name of the naming authority that defines this naming convention.

Returns:
the name of the authority defining this name as a String

getEnumeration

public java.util.Enumeration getEnumeration()
Get an enumeration of NameValueTypes that contain this audit record's name fields. This enumeration only contains the fields explicitly designated by its naming authority. Sub-authories are not recursively resolved.

Returns:
an Enumeration of NameValueTypes.

getDeepEnumeration

public java.util.Enumeration getDeepEnumeration()
Get an enumeration of NameValueTypes that contain this audit record's name fields. This enumeration contains all fields designated by its naming authority and all sub-authories.

Returns:
an Enumeration of NameValueTypes.

toString

public java.lang.String toString()
Get a string representation of this resource name.
Specified by:
toString in interface AuditEvent

Returns:
a String representing this resource name.
Overrides:
toString in class java.lang.Object