Oracle Entitlements Server for Java API Reference

com.bea.security
Class AuditingService

java.lang.Object
  |
  +--com.bea.security.PublicSecurityService
        |
        +--com.bea.security.AuditingService

public class AuditingService

extends PublicSecurityService

Provides the interface to all runtime auditing services

Author:

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

Fields inherited from class com.bea.security.PublicSecurityService

COMPATIBLE, COMPATIBLE_DEPRECATED, COMPATIBLE_UNKNOWN, NOT_COMPATIBLE

Method Summary

ServiceType	getServiceType() Indicates this service's type.
ServiceVersion	getVersion() Indicates this service's version.
int	isCompatible(ServiceVersion version) Determines if the version of the public service API specified in the Java application is compatible with the current version of the service API in the security runtime instance.
void	recordEvent(AuditRecord event) Passes an auditing event into the security runtime.
void	recordEvent(AuditRecord event, AuthenticIdentity requestor) Passes an auditing event into the security runtime.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getServiceType

public ServiceType getServiceType()

Indicates this service's type.

Returns:

a ServiceType object indicating this service's type.

Overrides:

getServiceType in class PublicSecurityService

getVersion

public ServiceVersion getVersion()

Indicates this service's version.

Returns:

a ServiceVersion indicating the service version number and the patch level.

Overrides:

getVersion in class PublicSecurityService

isCompatible

public int isCompatible(ServiceVersion version)

Determines if the version of the public service API specified in the Java application is compatible with the current version of the service API in the security runtime instance.

Parameters:

version - a ServiceVersion which is being asked for by the Java application. The current service, that is, the service in the security runtime instance, will indiciate if it supports the version specified in the isCompatible() method.

Returns:

an int equaling NOT_COMPATIBLE if the service is not compatible with the supplied version, COMPATIBLE if the service is fully compatible, COMPATIBLE_DEPRECATED if the service is compatible, but some functions have been depricated between the versions, or, finally, COMPATIBLE_UNKNOWN if the version passed in is newer than the current version, so compatibility is unknown.

Overrides:

isCompatible in class PublicSecurityService

recordEvent

public void recordEvent(AuditRecord event)

Passes an auditing event into the security runtime. The configuration of the runtime routes this event to the proper auditing providers so that it may be recorded.

Parameters:

event - an AuditRecord object containing audit criteria, data, and potentially a reference to an application context.

recordEvent

public void recordEvent(AuditRecord event,
                        AuthenticIdentity requestor)

Passes an auditing event into the security runtime. The configuration of the runtime routes this event to the proper auditing providers so that it may be recorded.

Parameters:

event - an AuditRecord object containing audit criteria, data, and potentially a reference to an application context.

requestor - the identity that is auditing the event