Package com.uc4.communication

Class ConnectProperties

  • public class ConnectProperties
extends java.lang.Object
    Contains all properties which are required to connect to the Automation Engine.

    • Constructor Summary

      Constructors 
      Constructor Description
      ConnectProperties​(int client, java.lang.String user, java.lang.String department, java.lang.String secret)
      Creates a new ConnectProperties instance with default values for the CP connection (localhost) and language (english).

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      int hashCode()  
      void setCPConnection​(java.lang.String hostname, int port)
      Sets the connection parameters of the communication process.
      protected void setKicks​(java.lang.String kicks)
      This connection is registered to receive the specified kick messages.
      void setLanguage​(char language)
      Sets the logon language.
      void setTraceListener​(TraceListener trace)
      Enables or disables the XML trace.
      void setTrustedCertFolderPath​(java.lang.String trustedCertFolderPath)
      Sets an optional trustedCertFolderPath, which will be used to load additional certificates before opening the connection
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • ConnectProperties

        public ConnectProperties​(int client,
                         java.lang.String user,
                         java.lang.String department,
                         java.lang.String secret)
        Creates a new ConnectProperties instance with default values for the CP connection (localhost) and language (english).
        Parameters:
        client - Client
        user - User name
        department - Department
        secret - Password or token

    • Method Detail

      • setTrustedCertFolderPath

        public void setTrustedCertFolderPath​(java.lang.String trustedCertFolderPath)
        Sets an optional trustedCertFolderPath, which will be used to load additional certificates before opening the connection
        Parameters:
        trustedCertFolderPath - path to the folder where additional trusted certs are located

      • setTraceListener

        public void setTraceListener​(TraceListener trace)
        Enables or disables the XML trace.
        Parameters:
        trace - TraceListener instance or null to disable the trace.

      • setLanguage

        public void setLanguage​(char language)
        Sets the logon language.
        Parameters:
        language - Allowed values are 'E'(=English), 'D' (=German) and 'F' (=French)

      • setCPConnection

        public void setCPConnection​(java.lang.String hostname,
                            int port)
        Sets the connection parameters of the communication process.
        Parameters:
        hostname - Hostname or IP address
        port - Port of the communication process

      • 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.

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object