Package com.uc4.api.objects

Class LoginDefinition

java.lang.Object
com.uc4.api.objects.LoginDefinition
public class LoginDefinition extends Object
This class represents a single entry a Login object.

  • Constructor Details

    • LoginDefinition

      protected LoginDefinition(Element row)

    • LoginDefinition

      public LoginDefinition(UC4HostName host, String hostType, String loginInfo)
      Constructs a new LoginDefinition using the specified values.
      Parameters:
      host - Host name, use an empty UC4HostName to add the login definition for all host of this host type
      hostType - Host type
      loginInfo - Login information

    • LoginDefinition

      public LoginDefinition(UC4HostName host, String hostType, String loginInfo, boolean makeHostTypeUpperCase)
      Constructs a new LoginDefinition using the specified values.
      Parameters:
      host - Host name, use an empty UC4HostName to add the login definition for all host of this host type
      hostType - Host type
      loginInfo - Login information
      makeHostTypeUpperCase - flag for making the host type string upper case

  • Method Details

    • setPassword

      public void setPassword(String passw)
      Sets the password. This method must be called after setHost
      Parameters:
      passw - Password

    • setPasswords

      public void setPasswords(String password1, String password2, String password3)
      Sets up to 3 passwords. This is used for JMX only. The parameter password1 is required, other parameters are optional and can be set to null.
      Parameters:
      password1 - Password1
      password2 - Password2
      password3 - Password3

    • getHost

      public UC4HostName getHost()
      Returns the name of the Agent or a generic host name.
      Returns:
      Name of the Agent

    • setHost

      public void setHost(UC4HostName host)
      Sets the name of the Agent or a generic host name. This method resets a stored password. After this method is called use setPassword or setPasswords to set the password(s) again.
      Parameters:
      host - Name of the Agent

    • getHostType

      public String getHostType()
      Returns the host type.
      Returns:
      Host type

    • setHostType

      public void setHostType(String hostType)
      Sets the host type. Throws IllegalArgumentException if hostType is a String with zero length.
      Parameters:
      hostType - Host type

    • setHostType

      public void setHostType(String hostType, boolean makeUpperCase)
      Sets the host type. Throws IllegalArgumentException if hostType is a String with zero length.
      Parameters:
      hostType - Host type
      makeUpperCase - flag for making the host type string upper case.

    • setVault

      public void setVault(String vault)
      Sets External vault.
      Parameters:
      vault - String

    • getVault

      public String getVault()
      Returns the External vault.
      Returns:
      vault

    • getLoginInfo

      public String getLoginInfo()
      Returns the login information.
      Returns:
      Login information

    • setLoginInfo

      public void setLoginInfo(String loginInfo)
      Sets the login information.
      Parameters:
      loginInfo - Login information

    • store

      protected void store(com.uc4.util.XMLDocument doc, Element logins, ConnectionAttributes sessionInfo)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object