com.quantum.dxi.rest.system

Class Auditlog

java.lang.Object

Base

com.quantum.dxi.rest.system.Auditlog

@Service
public class Auditlog
extends Base

The Auditlog resource represents audit log records on the system. The Auditlog resource includes services for getting and deleting audit log records.

The schema that defines the SoftwarePatchUpgrades resource is defined below.

 
    <xs:element name="Auditlogs">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:long" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Total number of audit log entries</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element ref="Auditlog" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="Auditlog">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="DbId" type="xs:long">
                    <xs:annotation>
                        <xs:documentation>A unique identifier for each record.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="UserName" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>The local account or LDAP/AD account that performed the activity.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Date" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>The date and time the activity was performed.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Action" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>The type of activity performed (CREATE, UPDATE, or DELETE).</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Category" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>The category of the activity:
                                          Alert, Analyzer, Cluster, Date Time, Email, Event, Hard Drive Security,
                                          Healthcheck, NAS, Network, OST, PTT, Replication, Security, SNMP, Utility, or VTL.
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Role" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>The role of the account that performed the activity (ADMIN, MONITOR, SERVICE).</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Origin" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>The interface where the activity originated.
                                          Possible origins are GUI (remote management console)
                                          or CLI (command line interface).
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Description" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Details about the activity that was performed, including CLI commands and field values.</xs:documentation>
                    </xs:annotation>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="AuditlogColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Id"/>
            <xs:enumeration value="Username"/>
            <xs:enumeration value="Date"/>
            <xs:enumeration value="Action"/>
            <xs:enumeration value="Category"/>
            <xs:enumeration value="Count"/>
            <xs:enumeration value="Role"/>
            <xs:enumeration value="Origin"/>
            <xs:enumeration value="Description"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
Auditlog()

Method Summary

Modifier and Type	Method and Description
void	deleteAllAuditlogEntries(javax.servlet.http.HttpServletRequest request) DELETE /rest/Auditlogs
void	deleteAuditlogEntry(javax.servlet.http.HttpServletRequest request, String dbId) DELETE /rest/Auditlogs/{dbId}
javax.ws.rs.core.Response	export(javax.servlet.http.HttpServletRequest request) GET /rest/Auditlogs/export
Object	getAuditlogs(javax.servlet.http.HttpServletRequest request, int start, int limit, String sortColumn, String sortDirection, String actionString, String filterString) GET /rest/Auditlogs
NumericScalarType	getRowCount(javax.servlet.http.HttpServletRequest request, int start, int limit, String filterString) GET /rest/Auditlogs/getRowCount

Methods inherited from class java.lang.Object

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

Constructor Detail

Auditlog

public Auditlog()

Method Detail

getRowCount

public NumericScalarType getRowCount(@Context
                                     javax.servlet.http.HttpServletRequest request,
                                     int start,
                                     int limit,
                                     String filterString)

GET /rest/Auditlogs/getRowCount

Get the number of audit log records on the system.

getRowCount supports the table query parameters for filtering by column name. Column names are defined in <xs:element name="AuditlogColumnName">

Response Entity type: <xs:element name="NumericScalarType">

Since:

1.1

export

public javax.ws.rs.core.Response export(@Context
                                        javax.servlet.http.HttpServletRequest request)

GET /rest/Auditlogs/export

Export the Auditlogs to a file and download.

Content-Disposition type: attachment

Since:

1.1

getAuditlogs

public Object getAuditlogs(@Context
                           javax.servlet.http.HttpServletRequest request,
                           int start,
                           int limit,
                           String sortColumn,
                           String sortDirection,
                           @Deprecated
                           String actionString,
                           String filterString)

GET /rest/Auditlogs

Get the list of audit log records on the system.

Response Entity type: <xs:element name="Auditlogs">

<xs:element name="Sources"> supports the table query parameters. Column names for sorting and filtering are defined in <xs:element name="AuditlogColumnName">

Deprecated as of 1.1:
The "action" query parameter is deprecated.
?action=getRowCount replaced by getRowCount(HttpServletRequest, int, int, String)
?action=export replaced by export(HttpServletRequest)

Response Entity type: <xs:element name="NumericScalarType"> for query parameter ?action=getRowCount

Content-Disposition type: attachment for query parameter ?action=export

deleteAuditlogEntry

public void deleteAuditlogEntry(@Context
                                javax.servlet.http.HttpServletRequest request,
                                String dbId)

DELETE /rest/Auditlogs/{dbId}

Delete specified audit log records on the system. {dbId} is a comma-separated list of audit log record DbId values identifying the records to be deleted.

deleteAllAuditlogEntries

public void deleteAllAuditlogEntries(@Context
                                     javax.servlet.http.HttpServletRequest request)

DELETE /rest/Auditlogs

Delete all audit log records on the system.