Package com.sun.enterprise.admin.servermgmt.stringsubs

Interface AttributePreprocessor

All Known Implementing Classes:
AttributePreprocessorImpl
public interface AttributePreprocessor
An object to pre-process the input string. This input string can either b

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    substituteAfter(String afterValue)
    Process the after value of the change-pair element and retrieve its value.
    String
    substituteBefore(String beforeValue)
    Process the before value of the change-pair element and retrieve its value.
    String
    substitutePath(String path)
    Process the file name/member entry path.

  • Method Details

    • substituteBefore

      String substituteBefore(String beforeValue)
      Process the before value of the change-pair element and retrieve its value.

      Note: A change-pair element is a macro definition that specifies the string to be substituted ("before") and the replacement ("after") value.
      E.g. <change-pair id="pair1" before="@JAVA_HOME" after="$JAVA_HOME$"/>

      Parameters:
      beforeValue - The before value of change-pair.
      Returns:
      Substituted String.
      See Also:
      • invalid reference 
        ChangePair#getBefore()

    • substituteAfter

      String substituteAfter(String afterValue)
      Process the after value of the change-pair element and retrieve its value.

      Note: A change-pair element is a macro definition that specifies the string to be substituted ("before") and the replacement ("after") value.
      E.g. <change-pair id="pair1" before="@JAVA_HOME" after="$JAVA_HOME$"/>

      Parameters:
      afterValue - The after value of change-pair.
      Returns:
      Substituted String.
      See Also:
      • invalid reference 
        ChangePair#getAfter()

    • substitutePath

      String substitutePath(String path)
      Process the file name/member entry path. The name value of file-entry can contain the substitutable variable for e.g.

      <file-entry name="$DOMAIN_DIRECTORY$/start.cmd"/>

      Path pointing to the domain directory. The value of these variable will be retrieved.

      Note: A file-entry defines a text file or set of files where substitution has to be performed.

      Parameters:
      path - The file path.
      Returns:
      Substituted String.
      See Also:
      • invalid reference 
        FileEntry#getName()