ConnectionAttributes (java-api 21.0.11 API)

java.lang.Object
- com.uc4.communication.ConnectionAttributes

```
public class ConnectionAttributes
extends java.lang.Object
```
This class contains information about the connection to the UC4 Server.

Constructor Summary

Constructors
Constructor and Description

ConnectionAttributes()
Creates ConnectionAttributes.

Constructors
Constructor and Description
`ConnectionAttributes()` Creates `ConnectionAttributes`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAccessToken()` Access token that will be verified in JWP and used for auto-login.
`java.lang.String`	`getClient()`
`int`	`getDefaultJobPlanElse()` Returns the default JobPlan task ELSE Action.
`java.lang.String`	`getDepartment()`
`java.lang.String`	`getEncoding()` Returns the encoding used for communication between API and CP.
`byte[]`	`getKerberosToken()` Returns the kerberos token.
`java.lang.String`	`getKicks()` This connection is registered to receive the kick messages returned by this procedure.
`java.lang.String`	`getLanguage()`
`java.lang.String`	`getPassword()`
`java.lang.String`	`getPasswordType()` Returns the type of the secret if the defined in the Connection.open() method.
`java.lang.String`	`getRefreshToken()` Refresh token that will be verified in JWP and used for auto-login.
`java.lang.String`	`getRemoteHost()` Returns the host name of the API user.
`java.lang.String`	`getRemoteID()` Returns the remote ID.
`java.lang.String`	`getSamlToken()` Returns the saml token.
`java.lang.String`	`getServerName()`
`java.lang.String`	`getServerVersion()` Returns the version of the the Automation Engine.
`java.lang.String`	`getSessionId()`
`java.util.TimeZone`	`getSessionTimeZone()` Gets the session time zone.
`java.lang.String`	`getSpnegoToken()` Returns the browser token.
`javax.net.ssl.SSLContext`	`getSslContext()` The ssl-context that was used to establish this connection
`java.lang.String`	`getSystemName()`
`java.lang.String`	`getToken()` Returns a logon token which can be used instead of a password.
`java.lang.String`	`getTokenAgent()` Returns the Agent name if the API is used within an UC4 Agent.
`com.uc4.translate.Message`	`getTranslator()` Returns the message translator.
`java.lang.String`	`getUserIdnr()`
`java.lang.String`	`getUserName()`
`long`	`getWFRunID()` Returns the ARA Workflow ID.
`boolean`	`hasAdoptPrivilege()` Returns `true` if this user is allowed to execute the AdoptTask request.
`boolean`	`hasBackendVariablePrivilege()` Returns `true` if this user is allowed to create and modify backend variables.
`boolean`	`hasSelectiveStatisticsPrivilege()` Returns `true` if this user is allowed to access selective statistics.
`boolean`	`hasSystemOverviewPrivilege()` Returns `true` if this user is allowed to read the system overview.
`boolean`	`isDeploymentClient()` Returns `true` if deployment is enabled for this connection otherwise `false`.
`boolean`	`isRequestTest()` Returns `true` if internal test are enabled.
`boolean`	`isSSO()` Returns `true` if single sign on is active.
`boolean`	`isValid()` Returns `true` if this connection is valid.
`void`	`setAccessToken(java.lang.String accessToken)` Access token that will be verified in JWP and used for auto-login.
`protected void`	`setAgentName(java.lang.String agentName)` Sets the name of the Agent
`protected void`	`setClient(java.lang.String string)` Sets the UC4 Client
`protected void`	`setDefaultJobPlanElse(int defaultJobPlanElse)`
`protected void`	`setDepartment(java.lang.String string)` Sets the UC4 Department
`protected void`	`setDeploymentClient(boolean deploymentClient)` Sets the deployment client flag
`protected void`	`setEncoding(java.lang.String encoding)` Set the Encoding for communication between API and CP.
`protected void`	`setKerberosToken(byte[] token)` Sets the kerberos token.
`protected void`	`setKicks(java.lang.String kicks)` This connection is registered to receive the specified kick messages.
`protected void`	`setLanguage(java.lang.String lang)` Sets the UC4 Language, allowed Values are D,E or F
`protected void`	`setPassword(java.lang.String string)` Set the UC4 Password
`protected void`	`setPasswordType(java.lang.String passwordType)` Sets the type of the secret.
`protected void`	`setPrivilege(long privilege)`
`void`	`setRefreshToken(java.lang.String refreshToken)` Refresh token that will be verified in JWP and used for auto-login.
`protected void`	`setRemoteID(java.lang.String remoteID)` Sets the remote ID
`protected void`	`setRequesetTest(boolean requestTest)` Performs additional checks on `Request` objects.
`void`	`setSamlToken(java.lang.String samltoken)` Sets the saml token
`void`	`setServerName(java.lang.String serverName)` Set the UC4 Server Name - the name of the server process
`protected void`	`setServerVersion(java.lang.String version)` Sets the version of Automation Engine.
`protected void`	`setSessionId(java.lang.String string)` Set the Session ID
`protected void`	`setSessionTimeZone(java.util.TimeZone sessionTimeZone)` Sets the session time zone.
`protected void`	`setSettings(Settings settings)`
`protected void`	`setSpnegoToken(java.lang.String token)` Sets the browser token.
`protected void`	`setSSLContext(javax.net.ssl.SSLContext sslContext)` The ssl-context that was used to establish this connection
`protected void`	`setSystemName(java.lang.String string)` Set the UC4 System Name
`Settings`	`settings()`
`protected void`	`setToken(java.lang.String token)` Sets the logon token
`protected void`	`setTranslator(com.uc4.translate.Message translator)`
`protected void`	`setUserIdnr(java.lang.String string)` Set the internal User ID
`protected void`	`setUserName(java.lang.String string)` Set the UC4 Username
`protected void`	`setValid(boolean valid)` Sets the valid flag
`protected void`	`setWFRunID(long runID)` Sets the ARA Workflow RunID.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ConnectionAttributes
```
public ConnectionAttributes()
```
    Creates ConnectionAttributes.
- Method Detail
  - isRequestTest
```
public boolean isRequestTest()
```
    Returns true if internal test are enabled. To enable internal request tests call the method Connection#setDebug and set the second parameter to true.
    
    Returns:
    
    Boolean indicating if internal test are enabled or not.
  - settings
```
public Settings settings()
```
    Returns:
    
    User Interface settings
  - isDeploymentClient
```
public boolean isDeploymentClient()
```
    Returns true if deployment is enabled for this connection otherwise false.
    
    Returns:
    
    true if deployment is enabled
  - getSamlToken
```
public java.lang.String getSamlToken()
```
    Returns the saml token.
    
    Returns:
    
    samltoken
  - setSamlToken
```
public void setSamlToken(java.lang.String samltoken)
```
    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
```
public java.lang.String 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
```
public java.lang.String getToken()
```
    Returns a logon token which can be used instead of a password.
    
    Returns:
    
    Logon token
  - setAgentName
```
protected void setAgentName(java.lang.String agentName)
```
    Sets the name of the Agent
    
    Parameters:
    
    agentName - Agent name
  - setRequesetTest
```
protected void setRequesetTest(boolean requestTest)
```
    Performs additional checks on Request objects. This method is used internally.
    
    Parameters:
    
    requestTest - Enable additional tests
  - setSettings
```
protected void setSettings(Settings settings)
```
  - getRemoteHost
```
public java.lang.String getRemoteHost()
```
    Returns the host name of the API user. This name will be shown in the system overview.
    
    Returns:
    
    Remote host name
  - setServerVersion
```
protected void setServerVersion(java.lang.String version)
```
    Sets the version of Automation Engine.
    
    Parameters:
    
    version - Version of the Automation Engine
  - getServerVersion
```
public java.lang.String getServerVersion()
```
    Returns the version of the the Automation Engine.
    
    Returns:
    
    Server version
  - hasSystemOverviewPrivilege
```
public boolean hasSystemOverviewPrivilege()
```
    Returns true 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()
```
    Returns true 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()
```
    Returns true 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()
```
    Returns true 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
```
public java.lang.String getClient()
```
    Returns:
    
    UC4 Client
  - getDepartment
```
public java.lang.String getDepartment()
```
    Returns:
    
    UC4 Department
  - getLanguage
```
public java.lang.String getLanguage()
```
    Returns:
    
    Language: D,E or F
  - isValid
```
public boolean isValid()
```
    Returns true if this connection is valid.
    
    Returns:
    
    Connection status
  - getPassword
```
public java.lang.String getPassword()
```
    Returns:
    
    Password of the UC4 User
  - getKerberosToken
```
public byte[] getKerberosToken()
```
    Returns the kerberos token.
    
    Returns:
    
    Token for SSO
  - getSpnegoToken
```
public java.lang.String 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
```
public java.lang.String getSessionId()
```
    Returns:
    
    SessionId
  - getSystemName
```
public java.lang.String getSystemName()
```
    Returns:
    
    Name of the UC4 System
  - getServerName
```
public java.lang.String getServerName()
```
    Returns:
    
    Name of the UC4 Server name - the name of the server process
  - getUserIdnr
```
public java.lang.String getUserIdnr()
```
    Returns:
    
    Internal User ID
  - getUserName
```
public java.lang.String getUserName()
```
    Returns:
    
    Name of the UC4 User
  - setClient
```
protected void setClient(java.lang.String string)
```
    Sets the UC4 Client
    
    Parameters:
    
    string - UC4 Client
  - setToken
```
protected void setToken(java.lang.String token)
```
    Sets the logon token
    
    Parameters:
    
    token - Token
  - setDepartment
```
protected void setDepartment(java.lang.String string)
```
    Sets the UC4 Department
    
    Parameters:
    
    string - UC4 Department
  - setLanguage
```
protected void setLanguage(java.lang.String lang)
```
    Sets the UC4 Language, allowed Values are D,E or F
    
    Parameters:
    
    lang - Language
  - setPassword
```
protected void setPassword(java.lang.String string)
```
    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
```
protected void setSpnegoToken(java.lang.String token)
```
    Sets the browser token.
    
    Parameters:
    
    token - base64 encoded token
  - setWFRunID
```
protected void setWFRunID(long runID)
```
    Sets the ARA Workflow RunID.
    
    Parameters:
    
    runID - RunID
  - setSessionId
```
protected void setSessionId(java.lang.String string)
```
    Set the Session ID
    
    Parameters:
    
    string - Session ID
  - setSystemName
```
protected void setSystemName(java.lang.String string)
```
    Set the UC4 System Name
    
    Parameters:
    
    string - System Name
  - setServerName
```
public void setServerName(java.lang.String serverName)
```
    Set the UC4 Server Name - the name of the server process
    
    Parameters:
    
    serverName - Server Name - the name of the server process
  - setUserIdnr
```
protected void setUserIdnr(java.lang.String string)
```
    Set the internal User ID
    
    Parameters:
    
    string - Internal User ID
  - setUserName
```
protected void setUserName(java.lang.String string)
```
    Set the UC4 Username
    
    Parameters:
    
    string - User name
  - getEncoding
```
public java.lang.String getEncoding()
```
    Returns the encoding used for communication between API and CP.
    
    Returns:
    
    used encoding
  - setEncoding
```
protected void setEncoding(java.lang.String encoding)
```
    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()
```
    Returns true if single sign on is active.
    
    Returns:
    
    Single sign on
  - getRemoteID
```
public java.lang.String getRemoteID()
```
    Returns the remote ID.
    
    Returns:
    
    remote ID
  - getPasswordType
```
public java.lang.String 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
```
protected void setRemoteID(java.lang.String remoteID)
```
    Sets the remote ID
    
    Parameters:
    
    remoteID - Remote ID
  - setPasswordType
```
protected void setPasswordType(java.lang.String passwordType)
```
    Sets the type of the secret.
    
    Parameters:
    
    passwordType - ET (Exit token), TK (Token) or PW (Password)
  - getSessionTimeZone
```
public java.util.TimeZone getSessionTimeZone()
```
    Gets the session time zone.
    
    Returns:
    
    the session time zone
  - setSessionTimeZone
```
protected void setSessionTimeZone(java.util.TimeZone sessionTimeZone)
```
    Sets the session time zone.
    
    Parameters:
    
    sessionTimeZone - the new session time zone
  - getKicks
```
public java.lang.String 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
```
protected void setKicks(java.lang.String kicks)
```
    This connection is registered to receive the specified kick messages.
    
    Parameters:
    
    kicks - Comma separated list of kick messages.
  - getAccessToken
```
public java.lang.String getAccessToken()
```
    Access token that will be verified in JWP and used for auto-login.
    
    Returns:
    
    token as string
  - setAccessToken
```
public void setAccessToken(java.lang.String accessToken)
```
    Access token that will be verified in JWP and used for auto-login.
    
    Parameters:
    
    accessToken - token as string
  - getRefreshToken
```
public java.lang.String getRefreshToken()
```
    Refresh token that will be verified in JWP and used for auto-login.
    
    Returns:
    
    token as string
  - setRefreshToken
```
public void setRefreshToken(java.lang.String refreshToken)
```
    Refresh token that will be verified in JWP and used for auto-login.
    
    Parameters:
    
    refreshToken - token as string
  - setSSLContext
```
protected void setSSLContext(javax.net.ssl.SSLContext sslContext)
```
    The ssl-context that was used to establish this connection
    
    Parameters:
    
    sslContext -
  - getSslContext
```
public javax.net.ssl.SSLContext getSslContext()
```
    The ssl-context that was used to establish this connection
    
    Parameters:
    
    sslContext -

Class ConnectionAttributes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConnectionAttributes

Method Detail

isRequestTest

settings

isDeploymentClient

getSamlToken

setSamlToken

setValid

getTokenAgent

setDeploymentClient

getToken

setAgentName

setRequesetTest

setSettings

getRemoteHost

setServerVersion

getServerVersion

hasSystemOverviewPrivilege

hasAdoptPrivilege

hasSelectiveStatisticsPrivilege

hasBackendVariablePrivilege

setPrivilege

getTranslator

setTranslator

getClient

getDepartment

getLanguage

isValid

getPassword

getKerberosToken

getSpnegoToken

getWFRunID

getSessionId

getSystemName

getServerName

getUserIdnr

getUserName

setClient

setToken

setDepartment

setLanguage

setPassword

setKerberosToken

setSpnegoToken

setWFRunID

setSessionId

setSystemName

setServerName

setUserIdnr

setUserName

getEncoding

setEncoding

getDefaultJobPlanElse

setDefaultJobPlanElse

isSSO

getRemoteID

getPasswordType

setRemoteID

setPasswordType

getSessionTimeZone

setSessionTimeZone

getKicks

setKicks

getAccessToken

setAccessToken

getRefreshToken

setRefreshToken

setSSLContext

getSslContext