Package com.zerog.ia.api.pub

Interface ReplayVariableService

  • public interface ReplayVariableService

    Use ReplayVariableService to define whether or not variables should be encrypted and how they should be recorded in the response files and install logs.

    Variables defined in custom code are not recorded in the response files by default. This class provides methods to define whether or not the variables should be recorded in the response files.

    This class also provides methods to define variables that should be encrypted or excluded from response files and install logs.

    The ReplayVariableService object is available only at install time. It can be obtained through the one of the custom code Proxy objects by a request for the ReplayVariableService class, as follows:

    ReplayVariableService replay = (ReplayVariableService) proxy.getService(ReplayVariableService.class);

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ENCRYPT_VALUE
      Type of exception which the variables are recorded with its value encrypted.
      static int EXCLUDE_ENTIRELY
      Type of exception which the variables are excluded from the response files and install logs.
      static int EXCLUDE_VALUE
      Type of exception which the variables are recorded with no value.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addVariableException​(java.lang.String variableName, int operation)
      This method adds an exception to a given variable.
      boolean isRegistered​(java.lang.String variableName, java.lang.String title)
      This method returns whether or not a specified variable is registered to be recorded in the response file with a given title.
      void register​(java.lang.String[] severalVariables, java.lang.String title)
      This method registers a group of variables to be recorded in the response file with a given title.
      void register​(java.lang.String variableName, java.lang.String title)
      This method registers a variable to be recorded in the response file with a given title.
      void removeVariableException​(java.lang.String variableName)
      This method removes the exception previously defined for a given variable.
      void unregister​(java.lang.String variableName, java.lang.String title)
      This method unregisters a variable that is registered to be recorded in the response file with a given title.

    • Method Detail

      • register

        void register​(java.lang.String[] severalVariables,
              java.lang.String title)

        This method registers a group of variables to be recorded in the response file with a given title.

        The title is used to group logically related variables.

        Parameters:
        severalVariables - The array of strings containing the name of the variables to be registered.
        title - The title which the variables should be registered with.

      • register

        void register​(java.lang.String variableName,
              java.lang.String title)

        This method registers a variable to be recorded in the response file with a given title.

        Parameters:
        variableName - The name of the variable to be registered.
        title - The title which the variable should be registered with.

      • unregister

        void unregister​(java.lang.String variableName,
                java.lang.String title)

        This method unregisters a variable that is registered to be recorded in the response file with a given title.

        Unregistered variables are not recorded in the response file.

        Parameters:
        variableName - The name of the variable to be unregistered.
        title - The title which the variable is registered with.

      • isRegistered

        boolean isRegistered​(java.lang.String variableName,
                     java.lang.String title)

        This method returns whether or not a specified variable is registered to be recorded in the response file with a given title.

        Parameters:
        variableName - The String representation of the variable to be registered.
        title - The title which the variable is registered.
        Returns:
        Whether or not the variable is registered with the given title.

      • addVariableException

        void addVariableException​(java.lang.String variableName,
                          int operation)

        This method adds an exception to a given variable. Exceptions can be used to define variables that should be encrypted, excluded from the response files, install logs, and other options.

        The operation argument defines the type of exception that should be performed in the given variable. The following operations are valid:

        ENCRYPT_VALUE - The variable is recorded with its value encrypted.
        EXCLUDE_VALUE - The variable is recorded with no value.
        EXCLUDE_ENTIRELY - The variable is excluded from the response files and install logs.

        Parameters:
        variableName - The name of the variable which the exception should be created.
        operation - The type of exception. The valid values are ENCRYPT_VALUE, EXCLUDE_VALUE or EXCLUDE_ENTIRELY.
        See Also:
        ENCRYPT_VALUE, EXCLUDE_VALUE, EXCLUDE_ENTIRELY, removeVariableException(java.lang.String)

      • removeVariableException

        void removeVariableException​(java.lang.String variableName)

        This method removes the exception previously defined for a given variable.

        Parameters:
        variableName - The name of the variable which the exception should be removed.
        See Also:
        addVariableException(java.lang.String, int)