org.dataone.service.types.v1

Class LogEntry

java.lang.Object

org.dataone.service.types.v1.LogEntry

All Implemented Interfaces:

Serializable

public class LogEntry
extends Object
implements Serializable

A single log entry as reported by a Member Node or Coordinating Node through the :func:`MNCore.getLogRecords` or :func:`CNCore.getLogRecords` methods. Schema fragment(s) for this class:

 <xs:complexType xmlns:ns="http://ns.dataone.org/service/types/v1" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="LogEntry">
   <xs:sequence>
     <xs:element type="xs:string" name="entryId" minOccurs="1" maxOccurs="1"/>
     <xs:element type="ns:Identifier" name="identifier" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:string" name="ipAddress" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:string" name="userAgent" minOccurs="1" maxOccurs="1"/>
     <xs:element type="ns:Subject" name="subject" minOccurs="1" maxOccurs="1"/>
     <xs:element type="ns:Event" name="event" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:dateTime" name="dateLogged" minOccurs="1" maxOccurs="1"/>
     <xs:element type="ns:NodeReference" name="nodeIdentifier" minOccurs="1" maxOccurs="1"/>
   </xs:sequence>
 </xs:complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Date	dateLogged
protected String	entryId
protected Event	event
protected Identifier	identifier
protected String	ipAddress
protected NodeReference	nodeIdentifier
protected Subject	subject
protected String	userAgent

Constructor Summary

Constructors

Constructor and Description
LogEntry()

Method Summary

Methods

Modifier and Type	Method and Description
Date	getDateLogged() Get the 'dateLogged' element value.
String	getEntryId() Get the 'entryId' element value.
Event	getEvent() Get the 'event' element value.
Identifier	getIdentifier() Get the 'identifier' element value.
String	getIpAddress() Get the 'ipAddress' element value.
NodeReference	getNodeIdentifier() Get the 'nodeIdentifier' element value.
Subject	getSubject() Get the 'subject' element value.
String	getUserAgent() Get the 'userAgent' element value.
void	setDateLogged(Date dateLogged) Set the 'dateLogged' element value.
void	setEntryId(String entryId) Set the 'entryId' element value.
void	setEvent(Event event) Set the 'event' element value.
void	setIdentifier(Identifier identifier) Set the 'identifier' element value.
void	setIpAddress(String ipAddress) Set the 'ipAddress' element value.
void	setNodeIdentifier(NodeReference nodeIdentifier) Set the 'nodeIdentifier' element value.
void	setSubject(Subject subject) Set the 'subject' element value.
void	setUserAgent(String userAgent) Set the 'userAgent' element value.

Methods inherited from class java.lang.Object

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

Field Detail

entryId

protected String entryId

identifier

protected Identifier identifier

ipAddress

protected String ipAddress

userAgent

protected String userAgent

subject

protected Subject subject

event

protected Event event

dateLogged

protected Date dateLogged

nodeIdentifier

protected NodeReference nodeIdentifier

Constructor Detail

LogEntry

public LogEntry()

Method Detail

getEntryId

public String getEntryId()

Get the 'entryId' element value. A unique identifier for this log entry. The identifier should be unique for a particular node; This is not drawn from the same value space as other identifiers in DataONE, and so is not subjec to the same restrictions.

Returns:

value

setEntryId

public void setEntryId(String entryId)

Set the 'entryId' element value. A unique identifier for this log entry. The identifier should be unique for a particular node; This is not drawn from the same value space as other identifiers in DataONE, and so is not subjec to the same restrictions.

Parameters:

entryId -

getIdentifier

public Identifier getIdentifier()

Get the 'identifier' element value. The :term:`identifier` of the object that was the target of the operation which generated this log entry.

Returns:

value

setIdentifier

public void setIdentifier(Identifier identifier)

Set the 'identifier' element value. The :term:`identifier` of the object that was the target of the operation which generated this log entry.

Parameters:

identifier -

getIpAddress

public String getIpAddress()

Get the 'ipAddress' element value. The IP address, as reported by the service receiving the request, of the request origin.

Returns:

value

setIpAddress

public void setIpAddress(String ipAddress)

Set the 'ipAddress' element value. The IP address, as reported by the service receiving the request, of the request origin.

Parameters:

ipAddress -

getUserAgent

public String getUserAgent()

Get the 'userAgent' element value. The user agent of the client making the request, as reported in the User-Agent HTTP header.

Returns:

value

setUserAgent

public void setUserAgent(String userAgent)

Set the 'userAgent' element value. The user agent of the client making the request, as reported in the User-Agent HTTP header.

Parameters:

userAgent -

getSubject

public Subject getSubject()

Get the 'subject' element value. The :term:`Subject` used for making the request. This may be the DataONE :term:`public` user if the request is not authenticated, otherwise it will be the *Subject* of the certificate used for authenticating the request.

Returns:

value

setSubject

public void setSubject(Subject subject)

Set the 'subject' element value. The :term:`Subject` used for making the request. This may be the DataONE :term:`public` user if the request is not authenticated, otherwise it will be the *Subject* of the certificate used for authenticating the request.

Parameters:

subject -

getEvent

public Event getEvent()

Get the 'event' element value. An entry from the :class:`Types.Event` enumeration indicating the type of operation that triggered the log message.

Returns:

value

setEvent

public void setEvent(Event event)

Set the 'event' element value. An entry from the :class:`Types.Event` enumeration indicating the type of operation that triggered the log message.

Parameters:

event -

getDateLogged

public Date getDateLogged()

Get the 'dateLogged' element value. A :class:`Types.DateTime` time stamp indicating when the event triggering the log message ocurred. Note that all time stamps in DataONE are in UTC.

Returns:

value

setDateLogged

public void setDateLogged(Date dateLogged)

Set the 'dateLogged' element value. A :class:`Types.DateTime` time stamp indicating when the event triggering the log message ocurred. Note that all time stamps in DataONE are in UTC.

Parameters:

dateLogged -

getNodeIdentifier

public NodeReference getNodeIdentifier()

Get the 'nodeIdentifier' element value. The unique identifier for the node where the log message was generated.

Returns:

value

setNodeIdentifier

public void setNodeIdentifier(NodeReference nodeIdentifier)

Set the 'nodeIdentifier' element value. The unique identifier for the node where the log message was generated.

Parameters:

nodeIdentifier -