BEA Systems, Inc.

BEA WebLogic Enterprise Security for Java 4.2 API Reference

com.bea.security.deployment
Class ResourceDeploymentAuditRecord

java.lang.Object
  |
  +--com.bea.security.NamedObject
        |
        +--com.bea.security.AuditRecord
              |
              +--com.bea.security.deployment.ResourceDeploymentAuditRecord

public class ResourceDeploymentAuditRecord
extends AuditRecord

The ResourceDeploymentAuditRecord is used to publish resources and their attributes to the WLES Administration Application. To do so, create an instance of the audit record, supplying the resource to be deployed (and optionally, the attributes of the resource), and then audit the record using the AuditingService.

An audit provider that can process ResourceDeploymentAuditRecord records must be configured and enabled in the SSM configuration in order for resources to be published. Additionally, the identity that audits the record must have the necessary permissions to create resources.

Author:
Copyright © 2004 BEA Systems, Inc. All Rights Reserved.
See Also:
AuditingService

Field Summary
static java.lang.String APP_CONTEXT_NAMESPACE
          The namespace of all application context elements created by the audit record.
static java.lang.String DEFAULT_NAMING_AUTHORITY
          The default naming authority used if one is not specified during object creation.
static java.lang.String RESOURCE_ATTRIBUTES_NAME
          The unqualified name of the application contex element that contains attributes associated with the deployed RuntimeResource.
static java.lang.String RESOURCE_NAME
          The unqualified name of the application context element that contains the deployed RuntimeResource.
 
Fields inherited from class com.bea.security.AuditRecord
AUDIT_FAILURE, ERROR, eventCtx, evtMessage, FAILURE, identityMap, INFORMATIONAL, msgExc, REQUESTOR_ALIAS, severityCode, SUCCESS, WARNING
 
Fields inherited from class com.bea.security.NamedObject
deep, nameAuth, shallow
 
Constructor Summary
ResourceDeploymentAuditRecord(int severity, java.lang.String message, AppContext context, RuntimeResource resource)
          Creates a new ResourceDeploymentAuditRecord with the given severity, application context, and resource.
ResourceDeploymentAuditRecord(int severity, java.lang.String message, AppContext context, RuntimeResource resource, java.util.Map attributes)
          Creates a new ResourceDeploymentAuditRecord with the given severity, application context, resource, and resource attributes.
ResourceDeploymentAuditRecord(int severity, java.lang.String message, RuntimeResource resource)
          Creates a new ResourceDeploymentAuditRecord with the given severity and resource.
ResourceDeploymentAuditRecord(int severity, java.lang.String message, RuntimeResource resource, java.util.Map attributes)
          Creates a new ResourceDeploymentAuditRecord with the given severity, resource, and resource attributes.
ResourceDeploymentAuditRecord(java.lang.String authorityname, int severity, java.lang.String message, AppContext context, RuntimeResource resource)
          Creates a new ResourceDeploymentAuditRecord with the given naming authority, severity, application context, resource, and resource attributes.
ResourceDeploymentAuditRecord(java.lang.String authorityname, int severity, java.lang.String message, AppContext context, RuntimeResource resource, java.util.Map attributes)
          Creates a new ResourceDeploymentAuditRecord with the given naming authority, severity, application context, resource, and resource attributes.
ResourceDeploymentAuditRecord(java.lang.String authorityname, int severity, java.lang.String message, RuntimeResource resource)
          Creates a new ResourceDeploymentAuditRecord with the given naming authority, severity, and resource.
ResourceDeploymentAuditRecord(java.lang.String authorityname, int severity, java.lang.String message, RuntimeResource resource, java.util.Map attributes)
          Creates a new ResourceDeploymentAuditRecord with the given naming authority, severity, resource, and resource attributes.
 
Method Summary
 RuntimeResource getResource()
          Returns the resource that will be published during audit record processing.
 java.util.Map getResourceAttributes()
          Returns the attributes of the resource to be deployed during audit record processing.
 void setContext(AppContext context)
          Associates any additional application context with the audit record.
 void setResource(RuntimeResource resource)
          Sets the resource that will be published during audit record processing.
 void setResourceAttributes(java.util.Map attributes)
          Sets any attributes assoicated with the resource to be deployed during audit record processing.
 
Methods inherited from class com.bea.security.AuditRecord
getContext, getException, getIdentity, getIdentityAliases, getMessage, getSeverity, setException, setIdentity, setMessage, setSeverity, severityCodeToName, severityNameToCode, toString
 
Methods inherited from class com.bea.security.NamedObject
chop, getAuthorityName, getDeepEnumeration, getEnumeration, getID, getNamingAuthority
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_NAMING_AUTHORITY

public static final java.lang.String DEFAULT_NAMING_AUTHORITY
The default naming authority used if one is not specified during object creation.

APP_CONTEXT_NAMESPACE

public static final java.lang.String APP_CONTEXT_NAMESPACE
The namespace of all application context elements created by the audit record.

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME
The unqualified name of the application context element that contains the deployed RuntimeResource.

RESOURCE_ATTRIBUTES_NAME

public static final java.lang.String RESOURCE_ATTRIBUTES_NAME
The unqualified name of the application contex element that contains attributes associated with the deployed RuntimeResource. Resource attributes are stored as a java.util.Map.
Constructor Detail

ResourceDeploymentAuditRecord

public ResourceDeploymentAuditRecord(int severity,
                                     java.lang.String message,
                                     RuntimeResource resource)
Creates a new ResourceDeploymentAuditRecord with the given severity and resource.

Parameters:
severity - the severity of the audit record
message - the message for the audit record
resource - the resource to be deployed
Throws:
java.lang.IllegalArgumentException - if the supplied resource is null

ResourceDeploymentAuditRecord

public ResourceDeploymentAuditRecord(int severity,
                                     java.lang.String message,
                                     RuntimeResource resource,
                                     java.util.Map attributes)
Creates a new ResourceDeploymentAuditRecord with the given severity, resource, and resource attributes.

Parameters:
severity - the severity of the audit record
message - the message for the audit record
resource - the resource to be deployed
attributes - attributes of the resource to be deployed
Throws:
java.lang.IllegalArgumentException - if the supplied resource is null

ResourceDeploymentAuditRecord

public ResourceDeploymentAuditRecord(int severity,
                                     java.lang.String message,
                                     AppContext context,
                                     RuntimeResource resource)
Creates a new ResourceDeploymentAuditRecord with the given severity, application context, and resource.

Parameters:
severity - the severity of the audit record
message - the message for the audit record
context - additional context to assoicated with the audit record
resource - the resource to be deployed
Throws:
java.lang.IllegalArgumentException - if the supplied resource is null

ResourceDeploymentAuditRecord

public ResourceDeploymentAuditRecord(int severity,
                                     java.lang.String message,
                                     AppContext context,
                                     RuntimeResource resource,
                                     java.util.Map attributes)
Creates a new ResourceDeploymentAuditRecord with the given severity, application context, resource, and resource attributes.

Parameters:
severity - the severity of the audit record
message - the message for the audit record
context - additional context to assoicated with the audit record
resource - the resource to be deployed
attributes - attributes of the resource to be deployed
Throws:
java.lang.IllegalArgumentException - if the supplied resource is null

ResourceDeploymentAuditRecord

public ResourceDeploymentAuditRecord(java.lang.String authorityname,
                                     int severity,
                                     java.lang.String message,
                                     RuntimeResource resource)
Creates a new ResourceDeploymentAuditRecord with the given naming authority, severity, and resource.

Parameters:
authorityname - the naming authority used by the audit record
severity - the severity of the audit record
message - the message for the audit record
resource - the resource to be deployed
Throws:
java.lang.IllegalArgumentException - if the supplied resource is null

ResourceDeploymentAuditRecord

public ResourceDeploymentAuditRecord(java.lang.String authorityname,
                                     int severity,
                                     java.lang.String message,
                                     RuntimeResource resource,
                                     java.util.Map attributes)
Creates a new ResourceDeploymentAuditRecord with the given naming authority, severity, resource, and resource attributes.

Parameters:
authorityname - the naming authority used by the audit record
severity - the severity of the audit record
message - the message for the audit record
resource - the resource to be deployed
attributes - attributes of the resource to be deployed
Throws:
java.lang.IllegalArgumentException - if the supplied resource is null

ResourceDeploymentAuditRecord

public ResourceDeploymentAuditRecord(java.lang.String authorityname,
                                     int severity,
                                     java.lang.String message,
                                     AppContext context,
                                     RuntimeResource resource)
Creates a new ResourceDeploymentAuditRecord with the given naming authority, severity, application context, resource, and resource attributes.

Parameters:
authorityname - the naming authority used by the audit record
severity - the severity of the audit record
message - the message for the audit record
context - additional context to associated with the audit record
resource - the resource to be deployed
Throws:
java.lang.IllegalArgumentException - if the supplied resource is null

ResourceDeploymentAuditRecord

public ResourceDeploymentAuditRecord(java.lang.String authorityname,
                                     int severity,
                                     java.lang.String message,
                                     AppContext context,
                                     RuntimeResource resource,
                                     java.util.Map attributes)
Creates a new ResourceDeploymentAuditRecord with the given naming authority, severity, application context, resource, and resource attributes.

Parameters:
authorityname - the naming authority used by the audit record
severity - the severity of the audit record
message - the message for the audit record
context - additional context to associated with the audit record
resource - the resource to be deployed
attributes - attributes of the resource to be deployed
Throws:
java.lang.IllegalArgumentException - if the supplied resource is null
Method Detail

setResource

public void setResource(RuntimeResource resource)
Sets the resource that will be published during audit record processing.

Parameters:
resource - the resource to deploy
Throws:
java.lang.IllegalArgumentException - if the supplied resource is null

getResource

public RuntimeResource getResource()
Returns the resource that will be published during audit record processing.

Returns:
the resource to be deployed

setResourceAttributes

public void setResourceAttributes(java.util.Map attributes)
Sets any attributes assoicated with the resource to be deployed during audit record processing.

Parameters:
attributes - attributes associated with the resource

getResourceAttributes

public java.util.Map getResourceAttributes()
Returns the attributes of the resource to be deployed during audit record processing.

Returns:
the attributes associated with the resource

setContext

public void setContext(AppContext context)
Associates any additional application context with the audit record. The resource to be deployed and any attributes of the resources will be added to the supplied context.

Parameters:
context - additional application context for the audit record
Overrides:
setContext in class AuditRecord

Documentation is available at
http://edocs.bea.com/wles/docs42