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 |
---|---|
protected void |
createRequest(com.uc4.util.XMLDocument doc,
org.w3c.dom.Element req,
ConnectionAttributes session)
Creates the XML Document for the request.
|
java.lang.String |
getClient() |
java.lang.String |
getEncoding()
Returns the encoding of the XML messages.
|
java.lang.String |
getRedirectUrl()
When trying to login via SAML this returns you the URL to the SAML IDP
|
java.lang.String |
getSessionID()
Returns the ID this session.
|
protected java.lang.String |
getSrc()
Returns the request source.
|
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.
|
protected void |
handleContent(com.uc4.util.XMLDocument doc,
ConnectionAttributes session) |
protected boolean |
ignoreMessageBox() |
protected boolean |
isAllowedInClientZero()
This method is used internally.
|
boolean |
isLdapLogin()
Returns if user logged in through LDAP
|
boolean |
isLoginSuccessful()
Tests if the log in was successful.
|
boolean |
isPasswordChangeRequired()
Returns
true if the next action must be a change of the password. |
protected void |
setClientType(java.lang.String type) |
void |
setKicks(java.lang.String kicks)
Registers this connection to receive the specified kick messages.
|
protected void |
setOS(java.lang.String os) |
assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send, setMessageBox, showQuarantineNotification
public CreateSession(MessageBox box)
box
- Message Boxpublic CreateSession()
protected void setClientType(java.lang.String type)
protected void setOS(java.lang.String os)
protected java.lang.String getSrc()
XMLRequest
getSrc
in class XMLRequest
protected void createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element req, ConnectionAttributes session)
XMLRequest
createRequest
in class XMLRequest
doc
- Document, used to create new Elementsreq
- Request Element - classes append information to this request elementsession
- Information about the sessionprotected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
handleContent
in class XMLRequest
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.protected boolean isAllowedInClientZero()
XMLRequest
XMLRequest
is allowed in client 0.
The default implementation returns false
, subclasses may override.isAllowedInClientZero
in class XMLRequest
true
if this request is allowed in client 0, false
otherwiseprotected boolean ignoreMessageBox()
ignoreMessageBox
in class XMLRequest
public void setKicks(java.lang.String kicks)
kicks
- Comma separated list of kick messages.public java.lang.String getRedirectUrl()
public boolean isLdapLogin()
public java.lang.String getClient()