public class CreateSession extends XMLRequest
Connection#setSession
must be called before this request
is sent.Constructor and Description |
---|
CreateSession()
Internal use.
|
CreateSession(MessageBox box)
Internal use.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getEncoding()
Returns the encoding of the XML messages.
|
java.lang.String |
getSessionID()
Returns the ID this session.
|
java.lang.String |
getSystemName()
Returns the name of the UC4 system.
|
java.lang.String |
getToken()
Returns a token which can be used instead of a passwort for future logons with the same UC4 user.
|
java.lang.String |
getUserIdnr()
Returns the ID of the connected user.
|
java.lang.String |
getUserName()
Returns the name of the logged on user.
|
UC4UserName |
getUserObject()
Returns the name of the User object (user/department).
|
java.lang.String |
getWelcomeMessage()
Returns the first message after logon.
|
boolean |
isLoginSuccessful()
Tests if the log in was successful.
|
boolean |
isPasswordChangeRequired()
Returns
true if the next action must be a change of the password. |
void |
setKicks(java.lang.String kicks)
Registers this connection to receive the specified kick messages.
|
getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send
public CreateSession(MessageBox box)
box
- Message Boxpublic CreateSession()
public java.lang.String getWelcomeMessage()
public java.lang.String getUserName()
public UC4UserName getUserObject()
public java.lang.String getEncoding()
public java.lang.String getSessionID()
public java.lang.String getSystemName()
public java.lang.String getUserIdnr()
public java.lang.String getToken()
public boolean isLoginSuccessful()
public boolean isPasswordChangeRequired()
true
if the next action must be a change of the password.public void setKicks(java.lang.String kicks)
kicks
- Comma separated list of kick messages.