|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ESUsersession
User session for a given ESServer
. Can be used with multiple projects.
An user session is gained by calling ESServer.login(String, String)
Method Summary | |
---|---|
void |
delete()
Deletes this usersession. |
String |
getPassword()
Returns the password. |
ESServer |
getServer()
Returns the usersession's server. |
ESSessionId |
getSessionId()
Returns the session id of this session. |
String |
getUsername()
Returns the name of the user this user session is associated with. |
boolean |
isLoggedIn()
Checks whether the user session has a ESSessionId . |
boolean |
isSavePassword()
Whether the password that is used by this session will be saved. |
void |
logout()
Logs out the user session. |
void |
refresh()
Relogins into the server using the same credentials in order to update the ESSessionId . |
void |
setSavePassword(boolean shouldSavePassword)
Whether the password that is used by this session should be saved. |
Method Detail |
---|
ESServer getServer()
String getUsername()
String getPassword()
boolean isLoggedIn()
ESSessionId
.
void refresh() throws ESException
ESSessionId
.
ESException
- in case renewal of the session failedvoid logout() throws ESException
ESException
- in case an error occurred during logoutESSessionId getSessionId()
void setSavePassword(boolean shouldSavePassword)
shouldSavePassword
- true
if the password should be saved, false
otherwiseboolean isSavePassword()
true
if the password is saved, false
otherwisevoid delete() throws ESException
ESException
- in case removing the session fails
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |