Class AutoAdministrationHelper


  • public abstract class AutoAdministrationHelper
    extends java.lang.Object
    Class to help calculate information regarding auto-administration.
    Since:
    7.0.0
    Version:
    $Revision: 25303 $ $Date: 2022-10-22 22:48:02 -0300 (Sat, 22 Oct 2022) $
    • Constructor Detail

      • AutoAdministrationHelper

        public AutoAdministrationHelper()
    • Method Detail

      • findTargetChannelId

        public static java.lang.String findTargetChannelId​(java.lang.String startingChannelId)
                                                    throws PortalException
        Retrieves the channelId of the closets auto-administration service instance for the startingChannelId.
        Parameters:
        startingChannelId - current channel id.
        Returns:
        the the channelId of the closets auto-administration service instance for the startingChannelId, returns null if it doesn't find one.
        Throws:
        PortalException
        Since:
        7.0.0
      • findBestAccessibleServiceInstance

        public static ServiceInstanceConfig findBestAccessibleServiceInstance​(java.lang.String startingChannelId)
                                                                       throws PortalException
        Finds the channelId of the best matching accessible auto-administration service instance relative to the given channel identifier.
        Parameters:
        startingChannelId - the identifier of the channel used as reference for finding the best matching auto-administration.
        Returns:
        the identifier of the channel of the best matched auto-administration service instance, or null if the is no accessible service instance.
        Throws:
        PortalException
        Since:
        14.2.0
      • findCurrentAutoAdministrationServiceInstance

        public static ServiceInstanceConfig findCurrentAutoAdministrationServiceInstance​(SessionConfig sessionConfig,
                                                                                         java.lang.String channelId,
                                                                                         java.util.Collection<java.lang.String> serviceInstanceIds,
                                                                                         ITransaction transaction)
                                                                                  throws PortalException
        Discovers the current auto administration service instance.
        Parameters:
        sessionConfig - session for the current user.
        channelId - channel id of the channel in which you want to discover the nearest service instance of the auto administration service.
        serviceInstanceIds - list of auto administration services available.
        transaction - in which the method should be part of.
        Returns:
        auto administration service instance config 'nearest' to the given channel.
        Throws:
        PortalException
        Since:
        7.0.0
      • getAutoAdministrationPageId

        public static java.lang.String getAutoAdministrationPageId​(java.lang.String channelId)
                                                            throws PortalException
        Discovers the pageId from the nearest auto administration service instance.
        Parameters:
        channelId - channel id of the channel in which you want to discover the nearest service instance of the auto administration service.
        Returns:
        pageId of the auto administration founded.
        Throws:
        PortalException - if any error occurs during the process.
        Since:
        7.1.0
      • getAutoAdministrationPageIdForServiceInstance

        public static java.lang.String getAutoAdministrationPageIdForServiceInstance​(java.lang.String serviceInstanceId)
                                                                              throws ManagerException,
                                                                                     PortalException
        Returns the page identifier to be used for the specified auto administration service instance.
        Parameters:
        serviceInstanceId - the service instance identifier.
        Returns:
        the page identifier.
        Throws:
        ManagerException
        PortalException
        Since:
        12.4.0