Package cz.metacentrum.perun.core.entry
Class AuditMessagesManagerEntry
java.lang.Object
cz.metacentrum.perun.core.entry.AuditMessagesManagerEntry
- All Implemented Interfaces:
AuditMessagesManager
AuditMessagesManager manages audit messages (logs). Implementation of Entry Logic.
- Author:
- Michal Stava
-
Field Summary
Fields inherited from interface cz.metacentrum.perun.core.api.AuditMessagesManager
COUNTOFMESSAGES
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
createAuditerConsumer
(PerunSession perunSession, String consumerName) Creates new auditer consumer with last processed id which equals current auditer log max id.Return list of names of all possible eventsgetAllAuditerConsumers
(PerunSession perunSession) Get all registered auditer consumers as map name(String)=lastProcessedId(Integer).int
getAuditerMessagesCount
(PerunSession perunSession) Get count of all messages in auditLOG.Gets the AuditMessagesManagerBl for this instance.int
getLastMessageId
(PerunSession perunSession) Get ID of last (newest) message in audit log (max_id).getMessages
(PerunSession perunSession) Returns 100 newest audit messages from auditLOG.getMessages
(PerunSession perunSession, int count) Returns exact number of newest audit messages defined by 'count' param (disregarding message IDs).getMessagesByCount
(PerunSession perunSession, int count) Returns all messages with IDs within the range from max(ID) to (max(ID)-count), where number of returned messages is equal or less than 'count' param, because some IDs could be skipped in the sequence.getMessagesByIdAndCount
(PerunSession perunSession, int id, int count) Returns "count" number of messages that are more or equal than the given ID (ascending order), i.e. the method returns newer messages by provided ID.getMessagesPage
(PerunSession perunSession, MessagesPageQuery query) Returns page of audit messages.void
log
(PerunSession perunSession, String message) Log arbitrary audit message.pollConsumerEvents
(PerunSession perunSession, String consumerName) Returns list of AuditEvents from audit log with IDs > lastProcessedId for registered auditer consumer.pollConsumerEvents
(PerunSession perunSession, String consumerName, int lastProcessedId) Returns list of AuditEvents from audit log with IDs > lastProcessedId for registered auditer consumer.pollConsumerMessages
(PerunSession perunSession, String consumerName) Returns list of AuditMessages from audit log with IDs > lastProcessedId for registered auditer consumer.pollConsumerMessages
(PerunSession perunSession, String consumerName, int lastProcessedId) Returns list of AuditMessages from audit log with IDs > lastProcessedId given.void
setAuditMessagesManagerBl
(AuditMessagesManagerBl auditMessagesManagerBl) Sets the AuditMessagesManagerBl for this instance.void
setLastProcessedId
(PerunSession perunSession, String consumerName, int lastProcessedId) Set ID of last processed message for specified consumer.void
setPerunBl
(PerunBl perunBl) Sets the perunBl for this instance.
-
Constructor Details
-
AuditMessagesManagerEntry
public AuditMessagesManagerEntry()
-
-
Method Details
-
createAuditerConsumer
public void createAuditerConsumer(PerunSession perunSession, String consumerName) throws PrivilegeException Description copied from interface:AuditMessagesManager
Creates new auditer consumer with last processed id which equals current auditer log max id.- Specified by:
createAuditerConsumer
in interfaceAuditMessagesManager
- Parameters:
perunSession
- perun sessionconsumerName
- new name for consumer- Throws:
PrivilegeException
- When you are not authorized to create auditer consumer
-
findAllPossibleEvents
Description copied from interface:AuditMessagesManager
Return list of names of all possible events- Specified by:
findAllPossibleEvents
in interfaceAuditMessagesManager
- Parameters:
sess
- perun session- Returns:
- list of all possible events
-
getAllAuditerConsumers
Description copied from interface:AuditMessagesManager
Get all registered auditer consumers as map name(String)=lastProcessedId(Integer).- Specified by:
getAllAuditerConsumers
in interfaceAuditMessagesManager
- Parameters:
perunSession
- perun session- Returns:
- Mapping of auditer consumer names to their last processed ID.
-
getAuditMessagesManagerBl
Gets the AuditMessagesManagerBl for this instance.- Returns:
- The AuditMessagesManagerBl.
-
getAuditerMessagesCount
Description copied from interface:AuditMessagesManager
Get count of all messages in auditLOG.- Specified by:
getAuditerMessagesCount
in interfaceAuditMessagesManager
- Parameters:
perunSession
- perun session- Returns:
- Count of all messages in audit log
-
getLastMessageId
Description copied from interface:AuditMessagesManager
Get ID of last (newest) message in audit log (max_id).- Specified by:
getLastMessageId
in interfaceAuditMessagesManager
- Parameters:
perunSession
- perun session- Returns:
- ID of last (newest) message.
-
getMessages
Description copied from interface:AuditMessagesManager
Returns 100 newest audit messages from auditLOG. If there is a less messages than 100, then all of them are returned.- Specified by:
getMessages
in interfaceAuditMessagesManager
- Parameters:
perunSession
- perun session- Returns:
- List of 100 newest audit messages
-
getMessages
Description copied from interface:AuditMessagesManager
Returns exact number of newest audit messages defined by 'count' param (disregarding message IDs). If there is less messages present, then all of them are returned.- Specified by:
getMessages
in interfaceAuditMessagesManager
- Parameters:
perunSession
- perun sessioncount
- Count of returned messages.- Returns:
- List of audit messages
-
getMessagesByCount
Description copied from interface:AuditMessagesManager
Returns all messages with IDs within the range from max(ID) to (max(ID)-count), where number of returned messages is equal or less than 'count' param, because some IDs could be skipped in the sequence.- Specified by:
getMessagesByCount
in interfaceAuditMessagesManager
- Parameters:
perunSession
- perun sessioncount
- Number of IDs to subtract from max(ID)- Returns:
- List of audit messages
-
getMessagesByIdAndCount
public List<AuditMessage> getMessagesByIdAndCount(PerunSession perunSession, int id, int count) throws PrivilegeException Description copied from interface:AuditMessagesManager
Returns "count" number of messages that are more or equal than the given ID (ascending order), i.e. the method returns newer messages by provided ID.- Specified by:
getMessagesByIdAndCount
in interfaceAuditMessagesManager
- Parameters:
perunSession
- perun sessionid
- starting id from which the messages will be takencount
- Number of messages that will be returned- Returns:
- List of audit messages
- Throws:
PrivilegeException
- when the principal does not have sufficient rights
-
getMessagesPage
public Paginated<AuditMessage> getMessagesPage(PerunSession perunSession, MessagesPageQuery query) throws PrivilegeException Description copied from interface:AuditMessagesManager
Returns page of audit messages. Query parameter specifies offset and page size and allows filtering by name of event. Total count is only estimated.- Specified by:
getMessagesPage
in interfaceAuditMessagesManager
- Parameters:
perunSession
- perun session- Returns:
- Page of audit messages
- Throws:
PrivilegeException
-
getPerunBl
-
log
Description copied from interface:AuditMessagesManager
Log arbitrary audit message.- Specified by:
log
in interfaceAuditMessagesManager
- Parameters:
perunSession
- perun sessionmessage
- message to be logged- Throws:
PrivilegeException
- When you are not authorized to log arbitrary message
-
pollConsumerEvents
public List<AuditEvent> pollConsumerEvents(PerunSession perunSession, String consumerName) throws PrivilegeException Description copied from interface:AuditMessagesManager
Returns list of AuditEvents from audit log with IDs > lastProcessedId for registered auditer consumer. Number of returned events for one call is limited (by default 10 000). You might need to fetch additional events by repeating this call.- Specified by:
pollConsumerEvents
in interfaceAuditMessagesManager
- Parameters:
perunSession
- perun sessionconsumerName
- consumer to get messages for- Returns:
- List of audit messages
- Throws:
PrivilegeException
- When you are not authorized to poll events
-
pollConsumerEvents
public List<AuditEvent> pollConsumerEvents(PerunSession perunSession, String consumerName, int lastProcessedId) throws PrivilegeException Description copied from interface:AuditMessagesManager
Returns list of AuditEvents from audit log with IDs > lastProcessedId for registered auditer consumer. Number of returned events for one call is limited (by default 10 000). You might need to fetch additional events by repeating this call.- Specified by:
pollConsumerEvents
in interfaceAuditMessagesManager
- Parameters:
perunSession
- perun sessionconsumerName
- consumer to get messages forlastProcessedId
- id of the last event- Returns:
- List of audit messages
- Throws:
PrivilegeException
- When you are not authorized to poll events
-
pollConsumerMessages
public List<AuditMessage> pollConsumerMessages(PerunSession perunSession, String consumerName) throws PrivilegeException Description copied from interface:AuditMessagesManager
Returns list of AuditMessages from audit log with IDs > lastProcessedId for registered auditer consumer. Number of returned messages for one call is limited (by default 10 000). You might need to fetch additional messages by repeating this call.- Specified by:
pollConsumerMessages
in interfaceAuditMessagesManager
- Parameters:
perunSession
- perun sessionconsumerName
- consumer to get messages for- Returns:
- List of audit messages
- Throws:
PrivilegeException
- When you are not authorized to poll messages
-
pollConsumerMessages
public List<AuditMessage> pollConsumerMessages(PerunSession perunSession, String consumerName, int lastProcessedId) throws PrivilegeException Description copied from interface:AuditMessagesManager
Returns list of AuditMessages from audit log with IDs > lastProcessedId given. Number of returned messages for one call is limited (by default 10 000). You might need to fetch additional messages by repeating this call.- Specified by:
pollConsumerMessages
in interfaceAuditMessagesManager
- Parameters:
perunSession
- perun sessionconsumerName
- consumer to get messages forlastProcessedId
- id of the last message- Returns:
- List of audit messages
- Throws:
PrivilegeException
- When you are not authorized to poll messages
-
setAuditMessagesManagerBl
Sets the AuditMessagesManagerBl for this instance.- Parameters:
auditMessagesManagerBl
- The AuditMessagesManagerBl.
-
setLastProcessedId
public void setLastProcessedId(PerunSession perunSession, String consumerName, int lastProcessedId) throws PrivilegeException Description copied from interface:AuditMessagesManager
Set ID of last processed message for specified consumer.- Specified by:
setLastProcessedId
in interfaceAuditMessagesManager
- Parameters:
perunSession
- perun sessionconsumerName
- name of consumerlastProcessedId
- id of last processed message in consumer- Throws:
PrivilegeException
- When you are not authorized to set last processed id
-
setPerunBl
Sets the perunBl for this instance.- Parameters:
perunBl
- The perunBl.
-