OOP LoginManager Version 3.7
A B C D E F G I L M N P R S U

A

AccessToHostDeniedException - Exception in com.bentofw.login
Thrown if the access to the host is denied.
AccessToUrlDeniedException - Exception in com.bentofw.login
Thrown by LoginManager if the user is not allowed to access the URL.
AccessToUrlDeniedException() - Constructor for exception com.bentofw.login.AccessToUrlDeniedException
LoginManager throws this exception if the user is not allowed to access the URL.
activateUser(String, String) - Method in class com.bentofw.login.UserGroupMap
Mark the user activated.
addGroup(String, String, String) - Method in class com.bentofw.login.UserGroupMap
Make the user to belong to the specified group.
addGroup(String) - Method in class com.bentofw.util.UserInfo
The user will belong to the specified group.
addUser(String, String, String, String[]) - Method in class com.bentofw.login.UserGroupMap
Add the new user.
addUser(String, String, String[]) - Method in class com.bentofw.login.UserGroupMap
Add the new user.
addUser(String, String[]) - Method in class com.bentofw.login.UserGroupMap
Add the new user.
addUserByFirstEmail(String, String, String[]) - Method in class com.bentofw.login.UserGroupMap
Add the new user associated with the first e-mail address.
addUserBySecondEmail(String, String, String[]) - Method in class com.bentofw.login.UserGroupMap
Add the new user associated with the second e-mail address.

B

belongsTo(String) - Method in class com.bentofw.util.UserInfo
If the user belongs to the specified group, this method returns true.

C

CartIdGenerator - Class in com.bentofw.login
Generate the unique transaction ID.
CartIdGenerator() - Constructor for class com.bentofw.login.CartIdGenerator
 
com.bentofw.login - package com.bentofw.login
Java API for access privilege control and session management.
com.bentofw.util - package com.bentofw.util
The classes and interfaces required for APIs by OOP-Research.
compareTo(Object) - Method in class com.bentofw.login.LoginInfo
The member of Comparable interface.
containsKey(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Returns true if the request parameter for the key is available in this request.

D

deleteUser(String, String) - Method in class com.bentofw.login.UserGroupMap
Mark the user deleted.
DuplicateUserException - Exception in com.bentofw.login
Thrown by UserGroupMap if the user name is already registered.

E

ExpiredIdException - Exception in com.bentofw.login
If the user does not access to the system more than the specified period, this exception will be thrown.

F

FailedToGetDomainException - Exception in com.bentofw.login
Thrown by LoginManager if the host parameter is null.
FailedToGetDomainException() - Constructor for exception com.bentofw.login.FailedToGetDomainException
Some methods of LoginManager resolve the domain name from the host name.

G

GET - Static variable in interface com.bentofw.util.ParsedRequestParameters
 
getContextPath() - Method in interface com.bentofw.util.ParsedRequestParameters
Returns the context path.
getDecodedBytes(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the decoded byte array of the request parameter specified by the name.
getDecodedBytesInArray(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the array of the decoded byte arrays of the request parameter specified by the name.
getDecodedBytesInList(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the List of the decoded byte arrays of the request parameter specified by the name.
getDecodedString(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the decoded String of the request parameter specified by the name.
getDecodedString(String, String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the decoded String of the request parameter specified by the name.
getDecodedStringInArray(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the array of decoded Strings of the request parameter specified by the name.
getDecodedStringInArray(String, String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the array of decoded Strings of the request parameter specified by the name.
getDecodedStringInList(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the List of decoded Strings of the request parameter specified by the name.
getDecodedStringInList(String, String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the List of decoded Strings of the request parameter specified by the name.
getDomain() - Method in class com.bentofw.util.UserInfo
Returns the String representing domain.
getEncodedString(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the URL-encoded String of the request parameter specified by the name.
getEncodedStringInArray(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the array of URL-encoded Strings of the request parameter specified by the name.
getEncodedStringInList(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the List of URL-encoded Strings of the request parameter specified by the name.
getEncoding() - Method in interface com.bentofw.util.ParsedRequestParameters
Return the current character encoding of this HTTP request.
getGroups() - Method in class com.bentofw.util.UserInfo
Returns the long value that represents the groups where the user belongs to.
getHostHeader() - Method in interface com.bentofw.util.ParsedRequestParameters
Returns the host header of the HTTP request.
getHostName() - Method in class com.bentofw.util.UserInfo
Returns the host name on which this user logged.
getInfo(String, String) - Method in class com.bentofw.login.LoginManager
Return the instance of UserInfo associated with the given transaction ID.
getInfo(HttpServletRequest) - Method in class com.bentofw.login.LoginManager
Return the instance of UserInfo associated with the given transaction ID.
getInfo(ParsedRequestParameters) - Method in class com.bentofw.login.LoginManager
Return the instance of UserInfo associated with the given transaction ID.
getInfoByPath(HttpServletRequest, int) - Method in class com.bentofw.login.LoginManager
This method picks up the transaction ID from PathInformation and returns the associated UserInfo object.
getInstance() - Static method in class com.bentofw.login.LoginManager
Reads the property file and returns the instance of this class.
getInstance() - Static method in class com.bentofw.login.UserGroupMap
Reads the property file and returns the instance of this class.
getInstance() - Static method in class com.bentofw.util.GroupDefinition
Returns the instance of this class.
getKeysInArray() - Method in interface com.bentofw.util.ParsedRequestParameters
Return the array of the names of the available request parameters.
getKeysInList() - Method in interface com.bentofw.util.ParsedRequestParameters
Return the List of the names of the available request parameters.
getLastAccess() - Method in class com.bentofw.login.LoginInfo
Return the time when the user accessed.
getLastPathInfo() - Method in interface com.bentofw.util.ParsedRequestParameters
Returns the last element within the path information.
getLengthOfDecodedString(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the length of the decoded String for the specified parameter.
getLengthOfDecodedStringInArray(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the length of the decoded Strings for the specified parameter in the array.
getLengthOfEncodedString(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the length of the encoded String for the specified parameter.
getLengthOfEncodedStringInArray(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the length of the encoded Strings for the specified parameter in the array.
getLengthOfLongestDecodedString(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the length of the longest decoded Strings for the specified parameter.
getLengthOfLongestEncodedString(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Return the length of the longest encoded Strings for the specified parameter.
getListOfLogin(String) - Method in class com.bentofw.login.LoginManager
The List of LoginInfo who are currently on the system.
getLoginTime() - Method in class com.bentofw.login.LoginInfo
Return the time when the user logged in.
getLongValue(String, String) - Method in class com.bentofw.util.GroupDefinition
Returns the long value that represents the specified group.
getMessage() - Method in exception com.bentofw.util.NestedException
Returns the error message of original Throwable.
getMessage() - Method in exception com.bentofw.util.NoGroupDefinitionException
Returns the detail message string of this Exception.
getMethod() - Method in interface com.bentofw.util.ParsedRequestParameters
Returns the int value indicating the request method, that is GET, POST or MULTIPART.
getMissingUser() - Method in exception com.bentofw.login.UserNotFoundException
 
getObject(String, String, String) - Method in class com.bentofw.login.LoginManager
Given the key, return the Object that was associated by LoginManager.putObject(String,String,String,Object) or its variants.
getObject(UserInfo, String) - Method in class com.bentofw.login.LoginManager
With UserInfo object specified, return the Object that was associated by LoginManager.putObject(UserInfo,String,Object) or its variants.
getObject(HttpServletRequest, String) - Method in class com.bentofw.login.LoginManager
Given the key, return the Object that was associated by LoginManager.putObject(HttpServletRequest,String,Object) or its variants.
getObject(ParsedRequestParameters, String) - Method in class com.bentofw.login.LoginManager
Given the key, return the Object that was associated by LoginManager.putObject(ParsedRequestParameters,String,Object) or its variants.
getObjectByPath(HttpServletRequest, int, String) - Method in class com.bentofw.login.LoginManager
Given the key, return the Object that was associated by LoginManager.putObjectByPath(HttpServletRequest,int,String,Object) or its variants.
getObjectByPath(ParsedRequestParameters, int, String) - Method in class com.bentofw.login.LoginManager
Given the key, return the Object that was associated by LoginManager.putObjectByPath(ParsedRequestParameters,int,String,Object) or its variants.
getOriginal() - Method in exception com.bentofw.util.NestedException
Returns the original Throwable.
getParameterNameForEmail() - Method in class com.bentofw.login.LoginManager
Returns the parameter name for e-mail address in the HTTP request.
getParameterNameForPass() - Method in class com.bentofw.login.LoginManager
Returns the parameter name for password in the HTTP request.
getParameterNameForTransId() - Method in class com.bentofw.login.LoginManager
Returns the parameter name for transaction ID in the HTTP request.
getParameterNameForUser() - Method in class com.bentofw.login.LoginManager
Returns the parameter name for user name in the HTTP request.
getPassword() - Method in interface com.bentofw.login.RandomPasswordGenerator
Returns the password
getPassword() - Method in class com.bentofw.login.SimplePasswordGenerator
 
getPassword() - Method in class com.bentofw.login.UserPassword
 
getPasswordByFirstEmail(String, String) - Method in class com.bentofw.login.UserGroupMap
Return the password associated with the first e-mail address.
getPasswordBySecondEmail(String, String) - Method in class com.bentofw.login.UserGroupMap
Return the password associated with the second e-mail address.
getPathInfo() - Method in interface com.bentofw.util.ParsedRequestParameters
Returns the path information.
getServletPath() - Method in interface com.bentofw.util.ParsedRequestParameters
Return the servlet path of the requested URL.
getTimeMinutes() - Method in exception com.bentofw.login.ExpiredIdException
Return the time in minutes to be allowed without access.
getTransactionId() - Method in class com.bentofw.util.UserInfo
Returns the transaction ID for this user.
getUniqueId() - Method in class com.bentofw.login.CartIdGenerator
 
getUniqueId() - Method in class com.bentofw.login.SimpleIdGenerator
 
getUniqueId() - Method in interface com.bentofw.login.UniqueIdGenerator
Returns the unique ID.
getUser() - Method in exception com.bentofw.login.DuplicateUserException
 
getUser() - Method in exception com.bentofw.login.UserNotDeletedException
 
getUser() - Method in class com.bentofw.login.UserPassword
 
getUser() - Method in class com.bentofw.util.UserInfo
Returns the String representing user ID.
getUserId() - Method in interface com.bentofw.login.RandomUserIdGenerator
Returns the user ID.
getUserId() - Method in class com.bentofw.login.SimpleUserIdGenerator
 
getUserName() - Method in class com.bentofw.login.LoginInfo
Return the user name.
GroupDefinition - Class in com.bentofw.util
Read the list of the available group names from XML.

I

InvalidIdException - Exception in com.bentofw.login
If the given transaction ID is invalid, LoginManager will throw this Exception.
isAnonymous() - Method in class com.bentofw.util.UserInfo
Returns true if the this user is anonymous.
isGuest() - Method in class com.bentofw.util.UserInfo
Returns true if the this user is guest.
isRoot() - Method in class com.bentofw.util.UserInfo
Returns true if the this user is root.

L

login(String, String, String) - Method in class com.bentofw.login.LoginManager
Given the correct pair of the user name and password, the unique transaction ID will be returned.
login(HttpServletRequest) - Method in class com.bentofw.login.LoginManager
Given the correct pair of the user name and password, the unique transaction ID will be returned.
login(ParsedRequestParameters) - Method in class com.bentofw.login.LoginManager
Given the correct pair of the user name and password, the unique transaction ID will be returned.
loginAsGuest(String) - Method in class com.bentofw.login.LoginManager
Return the unique transaction ID associated with the instance of UserInfo.
loginAsGuest(HttpServletRequest) - Method in class com.bentofw.login.LoginManager
Return the unique transaction ID associated with the instance of UserInfo.
loginAsGuest(ParsedRequestParameters) - Method in class com.bentofw.login.LoginManager
Return the unique transaction ID associated with the instance of UserInfo.
loginByFirstEmail(HttpServletRequest) - Method in class com.bentofw.login.LoginManager
Given the first e-mail address, the unique transaction ID will be returned.
loginByFirstEmail(ParsedRequestParameters) - Method in class com.bentofw.login.LoginManager
Given the first e-mail address, the unique transaction ID will be returned.
loginByFirstEmail(String, String) - Method in class com.bentofw.login.LoginManager
Given the host name and the first e-mail address, the unique transaction ID will be returned.
loginBySecondEmail(HttpServletRequest) - Method in class com.bentofw.login.LoginManager
Given the second e-mail address, the unique transaction ID will be returned.
loginBySecondEmail(ParsedRequestParameters) - Method in class com.bentofw.login.LoginManager
Given the second e-mail address, the unique transaction ID will be returned.
loginBySecondEmail(String, String) - Method in class com.bentofw.login.LoginManager
Given the host name and the second e-mail address, the unique transaction ID will be returned.
LoginFailedException - Exception in com.bentofw.login
If the pair of user name and password is incorrect, LoginManager will throw this Exception.
LoginInfo - Class in com.bentofw.login
This class represents the user name, the login time and the last access time.
LoginManager - Class in com.bentofw.login
Given the user name and password, this class generates the unique transaction ID associated with the user information.
logout(String, String) - Method in class com.bentofw.login.LoginManager
Unbind the instance of UserInfo associated with the given ID.
logout(UserInfo) - Method in class com.bentofw.login.LoginManager
Unbind the instance of UserInfo.
logout(HttpServletRequest) - Method in class com.bentofw.login.LoginManager
Unbind the instance of UserInfo associated with the given ID.
logout(ParsedRequestParameters) - Method in class com.bentofw.login.LoginManager
Unbind the instance of UserInfo associated with the given ID.

M

main(String[]) - Static method in class com.bentofw.login.SimpleIdGenerator
 
main(String[]) - Static method in class com.bentofw.login.SimplePasswordGenerator
 
main(String[]) - Static method in class com.bentofw.login.SimpleUserIdGenerator
 
MULTIPART - Static variable in interface com.bentofw.util.ParsedRequestParameters
 

N

NestedException - Exception in com.bentofw.util
The exception for the system error.
NestedException(Throwable) - Constructor for exception com.bentofw.util.NestedException
The custructor.
NoGroupDefinitionException - Exception in com.bentofw.util
This Exception is thrown if the undefined group name is specified.
NoGroupDefinitionException(String, String) - Constructor for exception com.bentofw.util.NoGroupDefinitionException
Constructor.
NoPropertyFileException - Exception in com.bentofw.util
This exception will be thrown when the required property file is not found.
NoPropertyFileException(String) - Constructor for exception com.bentofw.util.NoPropertyFileException
The custructor.
NullEmailException - Exception in com.bentofw.login
Thrown by LoginManager if the e-mail parameter is null.
NullEmailException() - Constructor for exception com.bentofw.login.NullEmailException
Some methods of LoginManager require the e-mail parameter.
NullHostException - Exception in com.bentofw.login
Thrown by LoginManager if the host parameter is null.
NullHostException() - Constructor for exception com.bentofw.login.NullHostException
Some methods of LoginManager require the host parameter.
NullPasswordException - Exception in com.bentofw.login
Thrown by LoginManager if the password parameter is null.
NullPasswordException() - Constructor for exception com.bentofw.login.NullPasswordException
Some methods of LoginManager require the password parameter.
NullTransactionIdException - Exception in com.bentofw.login
Thrown by LoginManager if the transaction id parameter is null.
NullTransactionIdException() - Constructor for exception com.bentofw.login.NullTransactionIdException
Some methods of LoginManager require the transaction id parameter.
NullUserException - Exception in com.bentofw.login
Thrown by LoginManager if the user parameter is null.
NullUserException() - Constructor for exception com.bentofw.login.NullUserException
Some methods of LoginManager require the host parameter.

P

ParsedRequestParameters - Interface in com.bentofw.util
Interface for HTTP request parameters
POST - Static variable in interface com.bentofw.util.ParsedRequestParameters
 
prepare() - Method in class com.bentofw.util.GroupDefinition
Read the list of group names from XML.
printStackTrace() - Method in exception com.bentofw.util.NestedException
Print this Throwable and its backtrace to the standard error stream.
printStackTrace(PrintStream) - Method in exception com.bentofw.util.NestedException
Print this Throwable and its backtrace to the specified PrintStream.
printStackTrace(PrintWriter) - Method in exception com.bentofw.util.NestedException
Print this Throwable and its backtrace to the specified PrintWriter.
putObject(String, String, String, Object) - Method in class com.bentofw.login.LoginManager
Bind the Object with the given key name.
putObject(UserInfo, String, Object) - Method in class com.bentofw.login.LoginManager
Bind the Object with the given key name.
putObject(HttpServletRequest, String, Object) - Method in class com.bentofw.login.LoginManager
Bind the Object with the given key name.
putObject(ParsedRequestParameters, String, Object) - Method in class com.bentofw.login.LoginManager
Bind the Object with the given key name.
putObjectByPath(HttpServletRequest, int, String, Object) - Method in class com.bentofw.login.LoginManager
Bind the Object with the given key name.
putObjectByPath(ParsedRequestParameters, int, String, Object) - Method in class com.bentofw.login.LoginManager
Bind the Object with the given key name.

R

RandomPasswordGenerator - Interface in com.bentofw.login
The implementation of this imterface is responsible for generating the password randomly.
RandomUserIdGenerator - Interface in com.bentofw.login
The implementation of this imterface is responsible for generating the user ID randomly.
RealmMap - Class in com.bentofw.login
This class reads a set of XML, that define the mapping between the user groups and the URL.
RealmMap() - Constructor for class com.bentofw.login.RealmMap
 
removeGroup(String, String, String) - Method in class com.bentofw.login.UserGroupMap
Make the user to leave from the specified group.
removeGroup(String) - Method in class com.bentofw.util.UserInfo
The user will NOT belong to the specified group.
removeObject(String, String, String) - Method in class com.bentofw.login.LoginManager
Remove the Object for the given key name.
removeObject(UserInfo, String) - Method in class com.bentofw.login.LoginManager
Remove the Object for the given key name.
removeObject(HttpServletRequest, String) - Method in class com.bentofw.login.LoginManager
Remove the Object for the given key name.
removeObject(ParsedRequestParameters, String) - Method in class com.bentofw.login.LoginManager
Remove the Object for the given key name.
removeObjectByPath(HttpServletRequest, int, String) - Method in class com.bentofw.login.LoginManager
Remove the Object for the given key name.
removeObjectByPath(ParsedRequestParameters, int, String) - Method in class com.bentofw.login.LoginManager
Remove the Object for the given key name.
RequestNotVerified - Exception in com.bentofw.util
The sub-class of this exception will be thrown when the HTTP request is not verified.
RequestNotVerified() - Constructor for exception com.bentofw.util.RequestNotVerified
The sub-class of this exception will be thrown when the HTTP request is not verified.
RequestNotVerified(String) - Constructor for exception com.bentofw.util.RequestNotVerified
The sub-class of this exception will be thrown when the HTTP request is not verified.

S

setDebug(boolean) - Method in class com.bentofw.login.LoginManager
Set the debug mode or not.
setDebug(boolean) - Method in class com.bentofw.login.UserGroupMap
Set the debug mode or not.
setEncoding(String) - Method in interface com.bentofw.util.ParsedRequestParameters
Set the character encoding of this HTTP request.
setHostName(String) - Method in class com.bentofw.util.UserInfo
Set the host name on which this user logged.
setTransactionId(String) - Method in class com.bentofw.util.UserInfo
Set the transaction ID for this user.
SimpleException - Exception in com.bentofw.util
The exception for the logical error.
SimpleException(String) - Constructor for exception com.bentofw.util.SimpleException
The custructor.
SimpleIdGenerator - Class in com.bentofw.login
Generate the unique transaction ID.
SimpleIdGenerator() - Constructor for class com.bentofw.login.SimpleIdGenerator
 
SimplePasswordGenerator - Class in com.bentofw.login
Generate the password randomly.
SimplePasswordGenerator() - Constructor for class com.bentofw.login.SimplePasswordGenerator
 
SimpleUserIdGenerator - Class in com.bentofw.login
Generate the user ID randomly.
SimpleUserIdGenerator() - Constructor for class com.bentofw.login.SimpleUserIdGenerator
 
startClean() - Method in class com.bentofw.login.LoginManager
Start the background thread, which removes all the invalid transaction ID.
stopClean() - Method in class com.bentofw.login.LoginManager
Stop the background thread, which removes all the invalid transaction ID.

U

unbound(UserInfo, String) - Method in interface com.bentofw.login.UnboundListener
Called when this object is removed from the session, the user logout, or the session itself expired.
UnboundListener - Interface in com.bentofw.login
The object that implements this interface will be notified when it is removed from the session, the user logout, or the session itself expired.
UniqueIdGenerator - Interface in com.bentofw.login
The implementation of this imterface is responsible for generating the unique ID.
updateFirstEmail(String, String, String) - Method in class com.bentofw.login.UserGroupMap
Update the first e-mail address of the specified user.
updateGroups(String, String, String[]) - Method in class com.bentofw.login.UserGroupMap
Update the groups to which the user belongs to.
updateGroups(UserInfo) - Method in class com.bentofw.login.UserGroupMap
Update the groups to which the user belongs to.
updatePass(String, String, String) - Method in class com.bentofw.login.UserGroupMap
Update the password for the specified user.
updateSecondEmail(String, String, String) - Method in class com.bentofw.login.UserGroupMap
Update the second e-mail address of the specified user.
UserGroupMap - Class in com.bentofw.login
Used by LoginManager to get the instance of UserInfo.
UserInfo - Class in com.bentofw.util
The class which represents the user information.
UserInfo(String, String, long) - Constructor for class com.bentofw.util.UserInfo
Constructor.
UserNotDeletedException - Exception in com.bentofw.login
Thrown by UserGroupMap if the user is not deleted.
UserNotFoundException - Exception in com.bentofw.login
Thrown by UserGroupMap if the user is not found.
UserPassword - Class in com.bentofw.login
This class represents the user name and the password.

A B C D E F G I L M N P R S U
OOP LoginManager Version 3.7

ALL CONTENTS COPYRIGHT 2006, OOP-Research Corporation. All rights reserved.
Any questions and comments are welcome to OOP-Research Corporation.