AuditResource

java.lang.Object
- com.idimiddleware.objectq.AuditResource

```
public class AuditResource
extends java.lang.Object
```
The AuditResource class is designed to allow an application to set up an audit specification. The transport object will generate audit data and insert it into the envelope based on the value of the AuditResource object, in time of sending or receiving.

Both an Envelope object and a Transport object may have an associated AuditResource object. The Transport's audit resource values are global, in the sense that they will apply to individual Envelope objects transferred by the Transport object, unless the audit resource values are set for the Envelope object, which will then override the ones for Transport.

The AuditResource contains flags indicating whether audit is set to on or off, and whether a certain audit attribute should be included or not. In addition to setting audit on or off, the application may set flags for the following attributes: date and time, process id, real userid of the process, hostname of the node, service requested, and queue address.

The AuditResource also specifies the maximum size of an audit data block. The default value is 1024 bytes for a hop. The size can be reset when needed.

The state of each flag may be NOT_SET, OFF, ON, or FORCED. The value ON indicates audit is on, OFF indicates audit is off. The value NOT_SET indicates audit is not set, and may be used in setting the audit resource values for an envelope, to not override the ones for the transport. If values for both resources associated with Envelope and Transport are NOT_SET, the default is audit off.

The state FORCED is used to specify round-trip audit. If a flag is set to FORCED, the audit is on for all nodes the envelope will travel through, regardless of the audit resource on the nodes. It is normally used by a client application to set up round-trip audit: the audit data will be added to the envelope regardless of the audit resource on the server.

Constructor Summary

Constructors
Constructor and Description
`AuditResource()` Default constructor with all auditing off.
`AuditResource(ObjectQ.AuditState state)` Construct an object with all elements set to the specified state.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearUnforced()` Set all resources that are not FORCED to NOT_SET.
`ObjectQ.AuditState`	`getAudit()`
`ObjectQ.AuditState`	`getDateTime()`
`ObjectQ.AuditState`	`getHostname()`
`int`	`getMaxAuditSize()`
`ObjectQ.AuditState`	`getPid()`
`ObjectQ.AuditState`	`getQueue()`
`ObjectQ.AuditState`	`getService()`
`java.lang.String`	`getUserdata1()`
`java.lang.String`	`getUserdata2()`
`ObjectQ.AuditState`	`getUserid()`
`void`	`setAllForced()`
`void`	`setAllNotSet()`
`void`	`setAllOff()`
`void`	`setAllOn()`
`void`	`setAudit(ObjectQ.AuditState state)` Set the resource to the specified state.
`void`	`setDateTime(ObjectQ.AuditState state)` Set the resource to the specified state.
`void`	`setHostname(ObjectQ.AuditState state)` Set the resource to the specified state.
`void`	`setMaxAuditSize(int maxAuditSize)`
`void`	`setPid(ObjectQ.AuditState state)` Set the resource to the specified state.
`void`	`setQueue(ObjectQ.AuditState state)` Set the resource to the specified state.
`void`	`setService(ObjectQ.AuditState state)` Set the resource to the specified state.
`void`	`setUserdata1(java.lang.String userdata)`
`void`	`setUserdata2(java.lang.String userdata)`
`void`	`setUserid(ObjectQ.AuditState state)` Set the resource to the specified state.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AuditResource
```
public AuditResource()
```
    Default constructor with all auditing off.
  - AuditResource
```
public AuditResource(ObjectQ.AuditState state)
```
    Construct an object with all elements set to the specified state.
    
    Parameters:
    
    state - The state to set elements (NOT_SET, ON, ..).
- Method Detail
  - clearUnforced
```
public void clearUnforced()
```
    Set all resources that are not FORCED to NOT_SET.
  - getAudit
```
public ObjectQ.AuditState getAudit()
```
    Returns:
    
    The audit resource state.
  - getDateTime
```
public ObjectQ.AuditState getDateTime()
```
    Returns:
    
    The dateTime resource state.
  - getHostname
```
public ObjectQ.AuditState getHostname()
```
    Returns:
    
    The hostname resource state.
  - getMaxAuditSize
```
public int getMaxAuditSize()
```
    Returns:
    
    The max size of audit data for each hop.
  - getPid
```
public ObjectQ.AuditState getPid()
```
    Returns:
    
    The pid resource state.
  - getQueue
```
public ObjectQ.AuditState getQueue()
```
    Returns:
    
    The queue resource state.
  - getService
```
public ObjectQ.AuditState getService()
```
    Returns:
    
    The service resource state.
  - getUserdata1
```
public java.lang.String getUserdata1()
```
    Returns:
    
    The first user data.
  - getUserdata2
```
public java.lang.String getUserdata2()
```
    Returns:
    
    The second user data.
  - getUserid
```
public ObjectQ.AuditState getUserid()
```
    Returns:
    
    The userid resource state.
  - setAllForced
```
public void setAllForced()
```
  - setAllNotSet
```
public void setAllNotSet()
```
  - setAllOff
```
public void setAllOff()
```
  - setAllOn
```
public void setAllOn()
```
  - setAudit
```
public void setAudit(ObjectQ.AuditState state)
```
    Set the resource to the specified state.
    
    Parameters:
    
    state - The state to set for this resource.
  - setDateTime
```
public void setDateTime(ObjectQ.AuditState state)
```
    Set the resource to the specified state.
    
    Parameters:
    
    state - The state to set for this resource.
  - setHostname
```
public void setHostname(ObjectQ.AuditState state)
```
    Set the resource to the specified state.
    
    Parameters:
    
    state - The state to set for this resource.
  - setMaxAuditSize
```
public void setMaxAuditSize(int maxAuditSize)
```
    Parameters:
    
    maxAuditSize - The max size of audit data for each hop. The default is 1024.
  - setPid
```
public void setPid(ObjectQ.AuditState state)
```
    Set the resource to the specified state.
    
    Parameters:
    
    state - The state to set for this resource.
  - setQueue
```
public void setQueue(ObjectQ.AuditState state)
```
    Set the resource to the specified state.
    
    Parameters:
    
    state - The state to set for this resource.
  - setService
```
public void setService(ObjectQ.AuditState state)
```
    Set the resource to the specified state.
    
    Parameters:
    
    state - The state to set for this resource.
  - setUserdata1
```
public void setUserdata1(java.lang.String userdata)
```
    Parameters:
    
    userdata - The user data to set.
  - setUserdata2
```
public void setUserdata2(java.lang.String userdata)
```
    Parameters:
    
    userdata - The user data to set.
  - setUserid
```
public void setUserid(ObjectQ.AuditState state)
```
    Set the resource to the specified state.
    
    Parameters:
    
    state - The state to set for this resource.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class AuditResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AuditResource

AuditResource

Method Detail

clearUnforced

getAudit

getDateTime

getHostname

getMaxAuditSize

getPid

getQueue

getService

getUserdata1

getUserdata2

getUserid

setAllForced

setAllNotSet

setAllOff

setAllOn

setAudit

setDateTime

setHostname

setMaxAuditSize

setPid

setQueue

setService

setUserdata1

setUserdata2

setUserid

toString