Package com.uc4.communication

Class ConnectionAttributes

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

  • Constructor Details

    • ConnectionAttributes

      public ConnectionAttributes()
      Creates ConnectionAttributes.

  • Method Details

    • 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 String getSamlToken()
      Returns the saml token.
      Returns:
      samltoken

    • setSamlToken

      public void setSamlToken(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 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 String getToken()
      Returns a logon token which can be used instead of a password.
      Returns:
      Logon token

    • setAgentName

      protected void setAgentName(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 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(String version)
      Sets the version of Automation Engine.
      Parameters:
      version - Version of the Automation Engine

    • getServerVersion

      public 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 String getClient()
      Returns:
      UC4 Client

    • getDepartment

      public String getDepartment()
      Returns:
      UC4 Department

    • getLanguage

      public String getLanguage()
      Returns:
      Language: D,E or F

    • isValid

      public boolean isValid()
      Returns true if this connection is valid.
      Returns:
      Connection status

    • getPassword

      public String getPassword()
      Returns:
      Password of the UC4 User

    • getKerberosToken

      public byte[] getKerberosToken()
      Returns the kerberos token.
      Returns:
      Token for SSO

    • getSpnegoToken

      public 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 String getSessionId()
      Returns:
      SessionId

    • getSystemName

      public String getSystemName()
      Returns:
      Name of the UC4 System

    • getServerName

      public String getServerName()
      Returns:
      Name of the UC4 Server name - the name of the server process

    • getUserIdnr

      public String getUserIdnr()
      Returns:
      Internal User ID

    • getUserName

      public String getUserName()
      Returns:
      Name of the UC4 User

    • setClient

      protected void setClient(String string)
      Sets the UC4 Client
      Parameters:
      string - UC4 Client

    • setToken

      protected void setToken(String token)
      Sets the logon token
      Parameters:
      token - Token

    • setDepartment

      protected void setDepartment(String string)
      Sets the UC4 Department
      Parameters:
      string - UC4 Department

    • setLanguage

      protected void setLanguage(String lang)
      Sets the UC4 Language, allowed Values are D,E or F
      Parameters:
      lang - Language

    • setPassword

      protected void setPassword(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(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(String string)
      Set the Session ID
      Parameters:
      string - Session ID

    • setSystemName

      protected void setSystemName(String string)
      Set the UC4 System Name
      Parameters:
      string - System Name

    • setServerName

      public void setServerName(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(String string)
      Set the internal User ID
      Parameters:
      string - Internal User ID

    • setUserName

      protected void setUserName(String string)
      Set the UC4 Username
      Parameters:
      string - User name

    • getEncoding

      public String getEncoding()
      Returns the encoding used for communication between API and CP.
      Returns:
      used encoding

    • setEncoding

      protected void setEncoding(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 String getRemoteID()
      Returns the remote ID.
      Returns:
      remote ID

    • getPasswordType

      public 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(String remoteID)
      Sets the remote ID
      Parameters:
      remoteID - Remote ID

    • setPasswordType

      protected void setPasswordType(String passwordType)
      Sets the type of the secret.
      Parameters:
      passwordType - ET (Exit token), TK (Token) or PW (Password)

    • getSessionTimeZone

      public TimeZone getSessionTimeZone()
      Gets the session time zone.
      Returns:
      the session time zone

    • setSessionTimeZone

      protected void setSessionTimeZone(TimeZone sessionTimeZone)
      Sets the session time zone.
      Parameters:
      sessionTimeZone - the new session time zone

    • getKicks

      public 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(String kicks)
      This connection is registered to receive the specified kick messages.
      Parameters:
      kicks - Comma separated list of kick messages.

    • getAccessToken

      public String getAccessToken()
      Access token that will be verified in JWP and used for auto-login.
      Returns:
      token as string

    • setAccessToken

      public void setAccessToken(String accessToken)
      Access token that will be verified in JWP and used for auto-login.
      Parameters:
      accessToken - token as string

    • getRefreshToken

      public String getRefreshToken()
      Refresh token that will be verified in JWP and used for auto-login.
      Returns:
      token as string

    • setRefreshToken

      public void setRefreshToken(String refreshToken)
      Refresh token that will be verified in JWP and used for auto-login.
      Parameters:
      refreshToken - token as string

    • setSSLContext

      protected void setSSLContext(SSLContext sslContext)
      The ssl-context that was used to establish this connection
      Parameters:
      sslContext -

    • getSslContext

      public SSLContext getSslContext()
      Returns:
      The ssl-context that was used to establish this connection