Package com.uc4.communication
Class ConnectionAttributes
java.lang.Object
com.uc4.communication.ConnectionAttributes
This class contains information about the connection to the UC4 Server.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAccess token that will be verified in JWP and used for auto-login.int
Returns the default JobPlan task ELSE Action.Returns the encoding used for communication between API and CP.byte[]
Returns the kerberos token.getKicks()
This connection is registered to receive the kick messages returned by this procedure.Returns the type of the secret if the defined in the Connection.open() method.Refresh token that will be verified in JWP and used for auto-login.Returns the host name of the API user.Returns the remote ID.Returns the saml token.Returns the version of the the Automation Engine.Gets the session time zone.Returns the browser token.getToken()
Returns a logon token which can be used instead of a password.Returns the Agent name if the API is used within an UC4 Agent.com.uc4.translate.Message
Returns the message translator.long
Returns the ARA Workflow ID.boolean
Returnstrue
if this user is allowed to execute the AdoptTask request.boolean
Returnstrue
if this user is allowed to create and modify backend variables.boolean
Returnstrue
if this user is allowed to access selective statistics.boolean
Returnstrue
if this user is allowed to read the system overview.boolean
Returnstrue
if deployment is enabled for this connection otherwisefalse
.boolean
Returnstrue
if internal test are enabled.boolean
isSSO()
Returnstrue
if single sign on is active.boolean
isValid()
Returnstrue
if this connection is valid.void
setAccessToken
(String accessToken) Access token that will be verified in JWP and used for auto-login.protected void
setAgentName
(String agentName) Sets the name of the Agentprotected void
Sets the UC4 Clientprotected void
setDefaultJobPlanElse
(int defaultJobPlanElse) protected void
setDepartment
(String string) Sets the UC4 Departmentprotected void
setDeploymentClient
(boolean deploymentClient) Sets the deployment client flagprotected void
setEncoding
(String encoding) Set the Encoding for communication between API and CP.protected void
setKerberosToken
(byte[] token) Sets the kerberos token.protected void
This connection is registered to receive the specified kick messages.protected void
setLanguage
(String lang) Sets the UC4 Language, allowed Values are D,E or Fprotected void
setPassword
(String string) Set the UC4 Passwordprotected void
setPasswordType
(String passwordType) Sets the type of the secret.protected void
setPrivilege
(long privilege) void
setRefreshToken
(String refreshToken) Refresh token that will be verified in JWP and used for auto-login.protected void
setRemoteID
(String remoteID) Sets the remote IDprotected void
setRequesetTest
(boolean requestTest) Performs additional checks onRequest
objects.void
setSamlToken
(String samltoken) Sets the saml tokenvoid
setServerName
(String serverName) Set the UC4 Server Name - the name of the server processprotected void
setServerVersion
(String version) Sets the version of Automation Engine.protected void
setSessionId
(String string) Set the Session IDprotected void
setSessionTimeZone
(TimeZone sessionTimeZone) Sets the session time zone.protected void
setSettings
(Settings settings) protected void
setSpnegoToken
(String token) Sets the browser token.protected void
setSSLContext
(SSLContext sslContext) The ssl-context that was used to establish this connectionprotected void
setSystemName
(String string) Set the UC4 System Namesettings()
protected void
Sets the logon tokenprotected void
setTranslator
(com.uc4.translate.Message translator) protected void
setUserIdnr
(String string) Set the internal User IDprotected void
setUserName
(String string) Set the UC4 Usernameprotected void
setValid
(boolean valid) Sets the valid flagprotected void
setWFRunID
(long runID) Sets the ARA Workflow RunID.
-
Constructor Details
-
ConnectionAttributes
public ConnectionAttributes()CreatesConnectionAttributes
.
-
-
Method Details
-
isRequestTest
public boolean isRequestTest()Returnstrue
if internal test are enabled. To enable internal request tests call the methodConnection#setDebug
and set the second parameter totrue
.- Returns:
- Boolean indicating if internal test are enabled or not.
-
settings
- Returns:
- User Interface settings
-
isDeploymentClient
public boolean isDeploymentClient()Returnstrue
if deployment is enabled for this connection otherwisefalse
.- Returns:
- true if deployment is enabled
-
getSamlToken
Returns the saml token.- Returns:
- samltoken
-
setSamlToken
Sets the saml token- Parameters:
samltoken
- set token for saml
-
setValid
protected void setValid(boolean valid) Sets the valid flag- Parameters:
valid
- true if this connection is valid
-
getTokenAgent
Returns the Agent name if the API is used within an UC4 Agent.- Returns:
- Agentname or
null
if not set
-
setDeploymentClient
protected void setDeploymentClient(boolean deploymentClient) Sets the deployment client flag- Parameters:
deploymentClient
- Is Deployment Client?
-
getToken
Returns a logon token which can be used instead of a password.- Returns:
- Logon token
-
setAgentName
Sets the name of the Agent- Parameters:
agentName
- Agent name
-
setRequesetTest
protected void setRequesetTest(boolean requestTest) Performs additional checks onRequest
objects. This method is used internally.- Parameters:
requestTest
- Enable additional tests
-
setSettings
-
getRemoteHost
Returns the host name of the API user. This name will be shown in the system overview.- Returns:
- Remote host name
-
setServerVersion
Sets the version of Automation Engine.- Parameters:
version
- Version of the Automation Engine
-
getServerVersion
Returns the version of the the Automation Engine.- Returns:
- Server version
-
hasSystemOverviewPrivilege
public boolean hasSystemOverviewPrivilege()Returnstrue
if this user is allowed to read the system overview.- Returns:
- Boolean indicating if the user is allowed to read the system overview
-
hasAdoptPrivilege
public boolean hasAdoptPrivilege()Returnstrue
if this user is allowed to execute the AdoptTask request.- Returns:
- Boolean indicating if the user is allowed to execute the AdoptTask request
-
hasSelectiveStatisticsPrivilege
public boolean hasSelectiveStatisticsPrivilege()Returnstrue
if this user is allowed to access selective statistics.- Returns:
- true if the selective statistics privilege is held by the user
-
hasBackendVariablePrivilege
public boolean hasBackendVariablePrivilege()Returnstrue
if this user is allowed to create and modify backend variables.- Returns:
- Boolean indicating if the user is allowed to create and modify backend variables.
-
setPrivilege
protected void setPrivilege(long privilege) -
getTranslator
public com.uc4.translate.Message getTranslator()Returns the message translator.- Returns:
- message translator
-
setTranslator
protected void setTranslator(com.uc4.translate.Message translator) -
getClient
- Returns:
- UC4 Client
-
getDepartment
- Returns:
- UC4 Department
-
getLanguage
- Returns:
- Language: D,E or F
-
isValid
public boolean isValid()Returnstrue
if this connection is valid.- Returns:
- Connection status
-
getPassword
- Returns:
- Password of the UC4 User
-
getKerberosToken
public byte[] getKerberosToken()Returns the kerberos token.- Returns:
- Token for SSO
-
getSpnegoToken
Returns the browser token.- Returns:
- Token for SSO
-
getWFRunID
public long getWFRunID()Returns the ARA Workflow ID. Internal use only.- Returns:
- RunID of a Workflow
-
getSessionId
- Returns:
- SessionId
-
getSystemName
- Returns:
- Name of the UC4 System
-
getServerName
- Returns:
- Name of the UC4 Server name - the name of the server process
-
getUserIdnr
- Returns:
- Internal User ID
-
getUserName
- Returns:
- Name of the UC4 User
-
setClient
Sets the UC4 Client- Parameters:
string
- UC4 Client
-
setToken
Sets the logon token- Parameters:
token
- Token
-
setDepartment
Sets the UC4 Department- Parameters:
string
- UC4 Department
-
setLanguage
Sets the UC4 Language, allowed Values are D,E or F- Parameters:
lang
- Language
-
setPassword
Set the UC4 Password- Parameters:
string
- Password of the UC4 User
-
setKerberosToken
protected void setKerberosToken(byte[] token) Sets the kerberos token.- Parameters:
token
- Token
-
setSpnegoToken
Sets the browser token.- Parameters:
token
- base64 encoded token
-
setWFRunID
protected void setWFRunID(long runID) Sets the ARA Workflow RunID.- Parameters:
runID
- RunID
-
setSessionId
Set the Session ID- Parameters:
string
- Session ID
-
setSystemName
Set the UC4 System Name- Parameters:
string
- System Name
-
setServerName
Set the UC4 Server Name - the name of the server process- Parameters:
serverName
- Server Name - the name of the server process
-
setUserIdnr
Set the internal User ID- Parameters:
string
- Internal User ID
-
setUserName
Set the UC4 Username- Parameters:
string
- User name
-
getEncoding
Returns the encoding used for communication between API and CP.- Returns:
- used encoding
-
setEncoding
Set the Encoding for communication between API and CP.- Parameters:
encoding
- Name of the character set
-
getDefaultJobPlanElse
public int getDefaultJobPlanElse()Returns the default JobPlan task ELSE Action.- Returns:
- Integer containing the JobPlan Task ELSE Action.
-
setDefaultJobPlanElse
protected void setDefaultJobPlanElse(int defaultJobPlanElse) -
isSSO
public boolean isSSO()Returnstrue
if single sign on is active.- Returns:
- Single sign on
-
getRemoteID
Returns the remote ID.- Returns:
- remote ID
-
getPasswordType
Returns the type of the secret if the defined in the Connection.open() method.- Returns:
- ET (Exit token), TK (Token) or PW (Password) or
null
if not set.
-
setRemoteID
Sets the remote ID- Parameters:
remoteID
- Remote ID
-
setPasswordType
Sets the type of the secret.- Parameters:
passwordType
- ET (Exit token), TK (Token) or PW (Password)
-
getSessionTimeZone
Gets the session time zone.- Returns:
- the session time zone
-
setSessionTimeZone
Sets the session time zone.- Parameters:
sessionTimeZone
- the new session time zone
-
getKicks
This connection is registered to receive the kick messages returned by this procedure. Kick messages are sent from the AE to the connected client when certain events occur in the AE.- Returns:
- Comma separated list of kick messages.
-
setKicks
This connection is registered to receive the specified kick messages.- Parameters:
kicks
- Comma separated list of kick messages.
-
getAccessToken
Access token that will be verified in JWP and used for auto-login.- Returns:
- token as string
-
setAccessToken
Access token that will be verified in JWP and used for auto-login.- Parameters:
accessToken
- token as string
-
getRefreshToken
Refresh token that will be verified in JWP and used for auto-login.- Returns:
- token as string
-
setRefreshToken
Refresh token that will be verified in JWP and used for auto-login.- Parameters:
refreshToken
- token as string
-
setSSLContext
The ssl-context that was used to establish this connection- Parameters:
sslContext
-
-
getSslContext
- Returns:
- The ssl-context that was used to establish this connection
-