com.interfaceware.iguana.plugin
Class LogQuery

java.lang.Object
  com.interfaceware.iguana.plugin.LogQuery

public class LogQuery
extends java.lang.Object

This class is used to represent an Iguana log query.

Constructor Summary

LogQuery()

LogQuery(long Handle)

Method Summary

LogQueryResult	execute() Perform a query on the configured Iguana server.
protected void	finalize()
java.util.Date	getAfter() Specifies the starting timestamp for the search.
java.util.Date	getBefore() Specifies the ending timestamp for the search.
java.lang.String	getChannelName() Restricts search results to specified channel.
boolean	getEncrypt() Specifies that Iguana server is configured to use HTTPS mode.
java.lang.String	getFilter() Restricts search results to log entries that contain specified text pattern in the message contents.
java.lang.String	getHost() Specifies the hostname or IP address of the Iguana server.
boolean	getIncludeAckMessages() Include log entries of Type "Ack" (HL7 acknowledgement) in the query results.
boolean	getIncludeDebugMessages() Include log entries of Type "Debug" (debug events) in the query results.
boolean	getIncludeDeleted() Include log entries that are deleted in the query results.
boolean	getIncludeErrorMessages() Include log entries of Type "Error" (both marked and unmarked) in the query results.
boolean	getIncludeInfoMessages() Include log entries of Type "Info" (info events) in the query results.
boolean	getIncludeMarkedErrorMessages() Include log entries of Type "Error" that are marked in the query results.
boolean	getIncludeMessageMessages() Include log entries of Type "Message" (HL7 data message) in the query results.
boolean	getIncludeNonDeleted() Include log entries that are not deleted in the query results.
boolean	getIncludeSourceLogs() Indicates that messages associated with the source channel should be included.
boolean	getIncludeSuccessMessages() Include log entries of Type "Success" (success events) in the query results.
boolean	getIncludeUnmarkedErrorMessages() Include log entries of Type "Error" that are not marked in the query results.
boolean	getIncludeWarningMessages() Include log entries of Type "Warning" (warning events) in the query results.
java.lang.String	getMessageLogId() If this field is set, the message with specified Message Id as well as messages related to it are returned.
java.lang.String	getPassword() Specifies the password which should be used to authenticate with the Iguana server.
int	getPort() Specifies the port number which is used to access the Iguana server's HTTP/HTTPS interface.
java.lang.String	getUsername() Specifies the username which should be used to authenticate with the Iguana server.
void	release()
void	setAfter(java.util.Date Value) Set method for After.
void	setBefore(java.util.Date Value) Set method for Before.
void	setChannelName(java.lang.String Value) Set method for ChannelName.
void	setEncrypt(boolean Value) Set method for Encrypt.
void	setFilter(java.lang.String Value) Set method for Filter.
void	setHost(java.lang.String Value) Set method for Host.
void	setIncludeAckMessages(boolean Value) Set method for IncludeAckMessages.
void	setIncludeDebugMessages(boolean Value) Set method for IncludeDebugMessages.
void	setIncludeDeleted(boolean Value) Set method for IncludeDeleted.
void	setIncludeErrorMessages(boolean Value) Set method for IncludeErrorMessages.
void	setIncludeInfoMessages(boolean Value) Set method for IncludeInfoMessages.
void	setIncludeMarkedErrorMessages(boolean Value) Set method for IncludeMarkedErrorMessages.
void	setIncludeMessageMessages(boolean Value) Set method for IncludeMessageMessages.
void	setIncludeNonDeleted(boolean Value) Set method for IncludeNonDeleted.
void	setIncludeSourceLogs(boolean Value) Set method for IncludeSourceLogs.
void	setIncludeSuccessMessages(boolean Value) Set method for IncludeSuccessMessages.
void	setIncludeUnmarkedErrorMessages(boolean Value) Set method for IncludeUnmarkedErrorMessages.
void	setIncludeWarningMessages(boolean Value) Set method for IncludeWarningMessages.
void	setMessageLogId(java.lang.String Value) Set method for MessageLogId.
void	setPassword(java.lang.String Value) Set method for Password.
void	setPort(int Value) Set method for Port.
void	setUsername(java.lang.String Value) Set method for Username.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogQuery

public LogQuery()
         throws PluginException

Throws:

PluginException

LogQuery

public LogQuery(long Handle)
         throws PluginException

Throws:

PluginException

Method Detail

release

public void release()
             throws PluginException

Throws:

PluginException

finalize

protected void finalize()
                 throws PluginException

Overrides:

finalize in class java.lang.Object

Throws:

PluginException

getHost

public java.lang.String getHost()
                         throws PluginException

Specifies the hostname or IP address of the Iguana server.

See also the setHost method.

Throws:

PluginException

setHost

public void setHost(java.lang.String Value)
             throws PluginException

Set method for Host.

See Host.

Parameters:

Value - Value to set Host to.

Throws:

PluginException

getPort

public int getPort()
            throws PluginException

Specifies the port number which is used to access the Iguana server's HTTP/HTTPS interface.

See also the setPort method.

Throws:

PluginException

setPort

public void setPort(int Value)
             throws PluginException

Set method for Port.

See Port.

Parameters:

Value - Value to set Port to.

Throws:

PluginException

getUsername

public java.lang.String getUsername()
                             throws PluginException

Specifies the username which should be used to authenticate with the Iguana server.

See also the setUsername method.

Throws:

PluginException

setUsername

public void setUsername(java.lang.String Value)
                 throws PluginException

Set method for Username.

See Username.

Parameters:

Value - Value to set Username to.

Throws:

PluginException

getPassword

public java.lang.String getPassword()
                             throws PluginException

Specifies the password which should be used to authenticate with the Iguana server.

See also the setPassword method.

Throws:

PluginException

setPassword

public void setPassword(java.lang.String Value)
                 throws PluginException

Set method for Password.

See Password.

Parameters:

Value - Value to set Password to.

Throws:

PluginException

getEncrypt

public boolean getEncrypt()
                   throws PluginException

Specifies that Iguana server is configured to use HTTPS mode.

See also the setEncrypt method.

Throws:

PluginException

setEncrypt

public void setEncrypt(boolean Value)
                throws PluginException

Set method for Encrypt.

See Encrypt.

Parameters:

Value - Value to set Encrypt to.

Throws:

PluginException

getFilter

public java.lang.String getFilter()
                           throws PluginException

Restricts search results to log entries that contain specified text pattern in the message contents. (Optional)

See also the setFilter method.

Throws:

PluginException

setFilter

public void setFilter(java.lang.String Value)
               throws PluginException

Set method for Filter.

See Filter.

Parameters:

Value - Value to set Filter to.

Throws:

PluginException

getChannelName

public java.lang.String getChannelName()
                                throws PluginException

Restricts search results to specified channel. (Optional)

See also the setChannelName method.

Throws:

PluginException

setChannelName

public void setChannelName(java.lang.String Value)
                    throws PluginException

Set method for ChannelName.

See ChannelName.

Parameters:

Value - Value to set ChannelName to.

Throws:

PluginException

getMessageLogId

public java.lang.String getMessageLogId()
                                 throws PluginException

If this field is set, the message with specified Message Id as well as messages related to it are returned. When this field is set, the other search constraints (Filter, ChannelName, IncludeMessageMessages, IncludeAckMessages, etc) are ignored.

See also the setMessageLogId method.

Throws:

PluginException

setMessageLogId

public void setMessageLogId(java.lang.String Value)
                     throws PluginException

Set method for MessageLogId.

See MessageLogId.

Parameters:

Value - Value to set MessageLogId to.

Throws:

PluginException

getIncludeMessageMessages

public boolean getIncludeMessageMessages()
                                  throws PluginException

Include log entries of Type "Message" (HL7 data message) in the query results.

See also the setIncludeMessageMessages method.

Throws:

PluginException

setIncludeMessageMessages

public void setIncludeMessageMessages(boolean Value)
                               throws PluginException

Set method for IncludeMessageMessages.

See IncludeMessageMessages.

Parameters:

Value - Value to set IncludeMessageMessages to.

Throws:

PluginException

getIncludeAckMessages

public boolean getIncludeAckMessages()
                              throws PluginException

Include log entries of Type "Ack" (HL7 acknowledgement) in the query results.

See also the setIncludeAckMessages method.

Throws:

PluginException

setIncludeAckMessages

public void setIncludeAckMessages(boolean Value)
                           throws PluginException

Set method for IncludeAckMessages.

See IncludeAckMessages.

Parameters:

Value - Value to set IncludeAckMessages to.

Throws:

PluginException

getIncludeSuccessMessages

public boolean getIncludeSuccessMessages()
                                  throws PluginException

Include log entries of Type "Success" (success events) in the query results.

See also the setIncludeSuccessMessages method.

Throws:

PluginException

setIncludeSuccessMessages

public void setIncludeSuccessMessages(boolean Value)
                               throws PluginException

Set method for IncludeSuccessMessages.

See IncludeSuccessMessages.

Parameters:

Value - Value to set IncludeSuccessMessages to.

Throws:

PluginException

getIncludeWarningMessages

public boolean getIncludeWarningMessages()
                                  throws PluginException

Include log entries of Type "Warning" (warning events) in the query results.

See also the setIncludeWarningMessages method.

Throws:

PluginException

setIncludeWarningMessages

public void setIncludeWarningMessages(boolean Value)
                               throws PluginException

Set method for IncludeWarningMessages.

See IncludeWarningMessages.

Parameters:

Value - Value to set IncludeWarningMessages to.

Throws:

PluginException

getIncludeErrorMessages

public boolean getIncludeErrorMessages()
                                throws PluginException

Include log entries of Type "Error" (both marked and unmarked) in the query results.

See also the setIncludeErrorMessages method.

Throws:

PluginException

setIncludeErrorMessages

public void setIncludeErrorMessages(boolean Value)
                             throws PluginException

Set method for IncludeErrorMessages.

See IncludeErrorMessages.

Parameters:

Value - Value to set IncludeErrorMessages to.

Throws:

PluginException

getIncludeMarkedErrorMessages

public boolean getIncludeMarkedErrorMessages()
                                      throws PluginException

Include log entries of Type "Error" that are marked in the query results. An error can be marked (acknowledged) through Iguana dashboard by an administrator.

See also the setIncludeMarkedErrorMessages method.

Throws:

PluginException

setIncludeMarkedErrorMessages

public void setIncludeMarkedErrorMessages(boolean Value)
                                   throws PluginException

Set method for IncludeMarkedErrorMessages.

See IncludeMarkedErrorMessages.

Parameters:

Value - Value to set IncludeMarkedErrorMessages to.

Throws:

PluginException

getIncludeUnmarkedErrorMessages

public boolean getIncludeUnmarkedErrorMessages()
                                        throws PluginException

Include log entries of Type "Error" that are not marked in the query results.

See also the setIncludeUnmarkedErrorMessages method.

Throws:

PluginException

setIncludeUnmarkedErrorMessages

public void setIncludeUnmarkedErrorMessages(boolean Value)
                                     throws PluginException

Set method for IncludeUnmarkedErrorMessages.

See IncludeUnmarkedErrorMessages.

Parameters:

Value - Value to set IncludeUnmarkedErrorMessages to.

Throws:

PluginException

getIncludeInfoMessages

public boolean getIncludeInfoMessages()
                               throws PluginException

Include log entries of Type "Info" (info events) in the query results.

See also the setIncludeInfoMessages method.

Throws:

PluginException

setIncludeInfoMessages

public void setIncludeInfoMessages(boolean Value)
                            throws PluginException

Set method for IncludeInfoMessages.

See IncludeInfoMessages.

Parameters:

Value - Value to set IncludeInfoMessages to.

Throws:

PluginException

getIncludeDebugMessages

public boolean getIncludeDebugMessages()
                                throws PluginException

Include log entries of Type "Debug" (debug events) in the query results.

See also the setIncludeDebugMessages method.

Throws:

PluginException

setIncludeDebugMessages

public void setIncludeDebugMessages(boolean Value)
                             throws PluginException

Set method for IncludeDebugMessages.

See IncludeDebugMessages.

Parameters:

Value - Value to set IncludeDebugMessages to.

Throws:

PluginException

getIncludeDeleted

public boolean getIncludeDeleted()
                          throws PluginException

Include log entries that are deleted in the query results. A log message can be deleted through Iguana dashboard by an administrator.

See also the setIncludeDeleted method.

Throws:

PluginException

setIncludeDeleted

public void setIncludeDeleted(boolean Value)
                       throws PluginException

Set method for IncludeDeleted.

See IncludeDeleted.

Parameters:

Value - Value to set IncludeDeleted to.

Throws:

PluginException

getIncludeNonDeleted

public boolean getIncludeNonDeleted()
                             throws PluginException

Include log entries that are not deleted in the query results.

See also the setIncludeNonDeleted method.

Throws:

PluginException

setIncludeNonDeleted

public void setIncludeNonDeleted(boolean Value)
                          throws PluginException

Set method for IncludeNonDeleted.

See IncludeNonDeleted.

Parameters:

Value - Value to set IncludeNonDeleted to.

Throws:

PluginException

getIncludeSourceLogs

public boolean getIncludeSourceLogs()
                             throws PluginException

Indicates that messages associated with the source channel should be included.

See also the setIncludeSourceLogs method.

Throws:

PluginException

setIncludeSourceLogs

public void setIncludeSourceLogs(boolean Value)
                          throws PluginException

Set method for IncludeSourceLogs.

See IncludeSourceLogs.

Parameters:

Value - Value to set IncludeSourceLogs to.

Throws:

PluginException

getAfter

public java.util.Date getAfter()
                        throws PluginException

Specifies the starting timestamp for the search. (Optional)

See also the setAfter method.

Throws:

PluginException

setAfter

public void setAfter(java.util.Date Value)
              throws PluginException

Set method for After.

See After.

Parameters:

Value - Value to set After to.

Throws:

PluginException

getBefore

public java.util.Date getBefore()
                         throws PluginException

Specifies the ending timestamp for the search. (Optional)

See also the setBefore method.

Throws:

PluginException

setBefore

public void setBefore(java.util.Date Value)
               throws PluginException

Set method for Before.

See Before.

Parameters:

Value - Value to set Before to.

Throws:

PluginException

execute

public LogQueryResult execute()
                       throws PluginException

Perform a query on the configured Iguana server. Note that this method will block while the query is performed.

Throws:

PluginException