com.prosyst.mprm.admin.login

Interface LoginLogManager

public interface LoginLogManager

Provides capability for retrieving history of login of users to mPRM.

Method Summary

Modifier and Type	Method and Description
void	deleteUserLogins(java.lang.String userName, java.lang.String url, long from, long to) Deletes user login records of a specified user, which has logged from a specified address, in the specified period.
long	getExpireDate(byte[] sessionId, long createDate) Returns the time of logout of a user login entry in milliseconds.
Enumerator	listActiveSessions() Returns a list of active sessions.
Enumerator	listActiveUsers() Returns a list of active users.
Enumerator	listUserLogins(java.lang.String userName, java.lang.String url, long time) Lists history of logins of a specified user logged to mPRM from a specified address at a specified moment.
Enumerator	listUserLogins(java.lang.String userName, java.lang.String url, long from, long to) Lists history of logins of a specified user logged to mPRM.
void	logoutActiveUser(byte[] sessionId) Logouts currently logged to mPRM user specifying id of user session.

Method Detail

listActiveSessions

Enumerator listActiveSessions()
                       throws ManagementException

Returns a list of active sessions.

Returns:

Enumerator of LoginEntry objects, containing only information about the currently active sessions. LoginEntry.getSessionId() will return the id of the session, all other methods of object will return null If no sessions are currently active, null is returned.

Throws:

ManagementException - if system error occurs or error while retrieving data occurs.

listActiveUsers

Enumerator listActiveUsers()
                    throws ManagementException

Returns a list of active users.

Returns:

Enumerator of LoginEntry, with information about the currently logged users. If there are no currently logged users, null is returned.

Throws:

ManagementException - if system error occurs or error while retrieving data occurs.

listUserLogins

Enumerator listUserLogins(java.lang.String userName,
                          java.lang.String url,
                          long from,
                          long to)
                   throws ManagementException

Lists history of logins of a specified user logged to mPRM. This method returns information of all logins of the specified user in the specified period, including the logins which have ended or started in the specified period. The LoginEntry objects, containing information about the user logins, will be returned sorted by time of login in descending order - i.e information about the latest login should be returned first.

Parameters:

userName - name of user.If null login records for all users, matching the other criterion, will be listed.

url - address from which the user logged. If null login records for all addresses, matching the other criterion, will be listed.

from - the beginning of period.

to - the end of period.

Returns:

Enumerator of LoginEntry objects with information about the user that have been logged to mPRM in specified period.

Throws:

ManagementException - if system error occurs or if error while retrieving data occurs.

java.lang.IllegalArgumentException - if the end of the search period is specified to be before its beginning or if any from the beginning or end of the search period is less than zero, or the beginning of the search period is after the current time of database.

listUserLogins

Enumerator listUserLogins(java.lang.String userName,
                          java.lang.String url,
                          long time)
                   throws ManagementException

Lists history of logins of a specified user logged to mPRM from a specified address at a specified moment. The LoginEntry objects, containing information about the user logins, will be returned sorted by time of login in descending order - i.e information about the latest login should be returned first.

Parameters:

userName - name of user.If null login records of all users, matching the other criterion, will be listed.

url - address from which the user logged. If null login records for all addresses, matching the other criterion, will be listed.

time - time when users were logged in to mPRM in milliseconds.

Returns:

Enumerator of LoginEntry objects with information about the users that have been logged at specified moment.

Throws:

ManagementException - if system error occurs or if error while retrieving data occurs.

java.lang.IllegalArgumentException - if specified time is less than zero or if the specified time is later than the current time of database.

deleteUserLogins

void deleteUserLogins(java.lang.String userName,
                      java.lang.String url,
                      long from,
                      long to)
               throws ManagementException

Deletes user login records of a specified user, which has logged from a specified address, in the specified period. Only records that are entirely in the specified period, will be deleted.

Parameters:

userName - name of user. If null login records for all users, matching the other criterion, will be deleted.

url - address from which the user logged. If null login records for all addresses, matching the other criterion, will be deleted.

from - the beginning of period.

to - the end of period.

Throws:

ManagementException - if system error occurs or if error while removing data occurs.

java.lang.IllegalArgumentException - will be thrown if the beginning or the end of the period is defined to be less than zero or if the end of the period is specified to be before its beginning.

logoutActiveUser

void logoutActiveUser(byte[] sessionId)
               throws ManagementException

Logouts currently logged to mPRM user specifying id of user session.

Parameters:

sessionId - id of user session.

Throws:

ManagementException - if error while logging user out or while removing data from list of logged database occurs.

getExpireDate

long getExpireDate(byte[] sessionId,
                   long createDate)
            throws ManagementException

Returns the time of logout of a user login entry in milliseconds.

Parameters:

createDate - time of creation of the userlogin entry in database.

sessionId - id of user session

Returns:

time of logout of user login entry in milliseconds. If user session is still active, -1 will be returned.

Throws:

ManagementException - if error while retrieving data from login database occurs.