Package com.ptc.windchill.esi.map

Class ESIGroupInfoManager

java.lang.Object
com.ptc.windchill.esi.map.ESIGroupInfoManager
public final class ESIGroupInfoManager extends Object
Manages all ESIGroupInfo objects in a virtual machine. Implements the Singleton pattern to insure that only one instance exists in a VM.

Supported API: true

Extendable: false

  • Constructor Details

    • ESIGroupInfoManager

      protected ESIGroupInfoManager()
      Hide the constructor to force access via the class' instance method.

      Supported API: true

  • Method Details

    • getGroupInfo

      public ESIGroupInfo getGroupInfo(String groupName)
      Returns the ESIGroupInfo for the supplied group name.

      Supported API: true
      Parameters:
      groupName -
      Returns:
      ESIGroupInfo

    • getGroupInfos

      public Collection getGroupInfos()
      Returns an ordered collection of all ESIGroupInfo objects.

      Supported API: true
      Returns:
      Collection

    • buildTargetGroupMapInfo

      public void buildTargetGroupMapInfo()
      Initializes the ESIGroupInfoManager instance with target specific ESI response meta information.

      Supported API: true

    • refreshTargetGroupMapInfo

      public boolean refreshTargetGroupMapInfo(ESITarget target)
      Refreshes (or re-initializes) the ESIGroupInfoManager instance with the ESI response meta information for the input target.

      Supported API: true
      Parameters:
      target - The distribution target for which to perform the refresh operation.
      Returns:
      true, if the refresh operation was successful; false, otherwise.

    • clearTargetGroupMapInfo

      public void clearTargetGroupMapInfo(ESITarget target)
      Clears the group information from the ESIGroupInfoManager instance for the input distribution target.

      Supported API: true
      Parameters:
      target - The distribution target for which to clear the group information.

    • getGroupInfo

      public ESIGroupInfo getGroupInfo(String groupName, ESITarget target)
      Returns the ESIGroupInfo object for the supplied group name and distribution target.

      Supported API: true Note: As of R10.0, this class uses the ESITarget attribute "responseMetaInfoPath" for fetching the ESI response meta information file path.
      Parameters:
      groupName - The input group name
      target - The input distribution target
      Returns:
      ESIGroupInfo

    • getGroupInfos

      public Collection<ESIGroupInfo> getGroupInfos(ESITarget target)
      Returns an ordered collection of all ESIGroupInfo objects for the supplied distribution target.

      Supported API: true Note: As of R10.0, this class uses the ESITarget attribute "responseMetaInfoPath" for fetching the ESI Response meta information file path.
      Parameters:
      target - The input distribution target
      Returns:
      Collection

    • addToGroupsTransformInfoTgtMap

      public void addToGroupsTransformInfoTgtMap(ESITarget tgt, ESIGroupsTransformationInfo groupsTransformationInfo)
      Adds an entry to ESIGroupInfoManager instance internal map using the input arguments. It generates an ESITargetResponseMetaInfo object for the input target and adds it to internal map as a key along with the input value. Supported API: true
      Parameters:
      tgt - - The input distribution target.
      groupsTransformationInfo - - ESIGroupsTransformationInfo object that constitutes the transformation information.

    • clearTargetGroupsTransformMapInfo

      public void clearTargetGroupsTransformMapInfo(ESITarget target)
      Clears the group transformation information from the ESIGroupInfoManager instance for the input distribution target.

      Supported API: true
      Parameters:
      target - The distribution target for which to clear the group transformation information.

    • getGroupsTransformationInfo

      public ESIGroupsTransformationInfo getGroupsTransformationInfo(ESITarget target)
      Returns an ESIGroupsTransformationInfo object for the supplied distribution target. The method obtains a key for the input target and attempts to fetch the value for this key from the HashMap in groupTransformInfoTargetMap. If no value could be fetched for the key (meaning the key does not exist in the said HashMap as yet), the method invokes the refreshTargetGroupMapInfo() API for the input target, thereby ensuring that an entry is created in the HashMap for the said key, and then returns the corresponding value to the caller.

      Supported API: true
      Parameters:
      target - The input distribution target.
      Returns:
      An ESIGroupsTransformationInfo instance for the input distribution target.