Package com._1c.g5.v8.dt.platform.services.core.infobases

Interface IInfobaseAccessManager

  • public interface IInfobaseAccessManager
    Manages infobases access settings. Manager can store and load infobase access settings.

    • Method Detail

      • getSettings

        IInfobaseAccessSettings getSettings​(InfobaseReference infobase)
                             throws org.eclipse.core.runtime.CoreException
        Gets infobase access settings.
        Parameters:
        infobase - infobase to get infobase access settings for, cannot be null
        Returns:
        infobase access settings, never null
        Throws:
        org.eclipse.core.runtime.CoreException - if loading fails

      • getSettings

        IInfobaseAccessSettings getSettings​(InfobaseReference infobase,
                                    InfobaseAccess defaultAccess)
                             throws org.eclipse.core.runtime.CoreException
        Gets infobase access settings. If settings are not set, new settings will be created with the default access type.
        Parameters:
        infobase - infobase to get infobase access settings for, cannot be null
        defaultAccess - default infobase access type for new settings, cannot be null
        Returns:
        infobase access settings, never null
        Throws:
        org.eclipse.core.runtime.CoreException - if loading fails

      • getInstallation

        IResolvableRuntimeInstallation getInstallation​(org.eclipse.core.resources.IProject project,
                                               InfobaseReference infobase)
                                        throws org.eclipse.core.runtime.CoreException
        Gets 1C:Eterprise installation infobase access settings for the given project.
        Parameters:
        project - the project to get settings for, cannot be null
        infobase - infobase to get stored infobase access settings for, cannot be null
        Returns:
        installation infobase access settings for the given project or null if cannot get
        Throws:
        org.eclipse.core.runtime.CoreException - if loading fails

      • getInstallation

        IResolvableRuntimeInstallation getInstallation​(InfobaseReference infobase)
                                        throws org.eclipse.core.runtime.CoreException
        Gets 1C:Eterprise installation infobase access settings for the given infobase.
        Parameters:
        infobase - infobase to get stored infobase access settings for, cannot be null
        Returns:
        installation infobase access settings for the given project or null if cannot get
        Throws:
        org.eclipse.core.runtime.CoreException - if loading fails

      • getInstallation

        IResolvableRuntimeInstallation getInstallation​(InfobaseReference infobase,
                                               Version version)
                                        throws org.eclipse.core.runtime.CoreException
        Gets 1C:Eterprise installation infobase access settings for the given infobase and platform version.
        Parameters:
        infobase - infobase to get stored infobase access settings for, cannot be null
        version - the 1C:Enterprise runtime version, cannot be null
        Returns:
        installation infobase access settings for the given project or null if cannot get
        Throws:
        org.eclipse.core.runtime.CoreException - if loading fails

      • storeSettings

        void storeSettings​(InfobaseReference infobase,
                   IInfobaseAccessSettings settings)
            throws org.eclipse.core.runtime.CoreException
        Sets and stores the given infobase access settings.

        This method is equivalent to: 

         store(infobase, settings.access(), settings.userName(), settings.password(),
     settings.additionalParameter());
        Parameters:
        infobase - infobase to load stored infobase access settings for, cannot be null
        settings - infobase access settings, cannot be null
        Throws:
        org.eclipse.core.runtime.CoreException - if storing fails

      • storeSettings

        void storeSettings​(InfobaseReference infobase,
                   InfobaseAccess access,
                   String userName,
                   String password,
                   String additionalParameters)
            throws org.eclipse.core.runtime.CoreException
        Sets and stores the given infobase access settings.
        Parameters:
        infobase - infobase to store stored infobase access settings for, cannot be null
        access - infobase access type, cannot be null
        userName - infobase user name or null if not defined
        password - infobase user password or null if not defined
        additionalParameters - the infobase access additional properties or null if not defined
        Throws:
        org.eclipse.core.runtime.CoreException - if storing fails

      • storeInstallation

        void storeInstallation​(org.eclipse.core.resources.IProject project,
                       InfobaseReference infobase,
                       IResolvableRuntimeInstallation installation)
                throws org.eclipse.core.runtime.CoreException
        Sets and stores the given 1C:Eterprise installation infobase access settings for the given project.
        Parameters:
        project - the project to store settings for, cannot be null
        infobase - infobase to store stored infobase access settings for, cannot be null
        installation - the installation to store, cannot be null
        Throws:
        org.eclipse.core.runtime.CoreException - if storing fails

      • addInfobaseAccessSettingsChangeListener

        void addInfobaseAccessSettingsChangeListener​(IInfobaseAccessSettingsChangeListener listener)
        Adds infobase access settings change listener to the manager. Listener will be notified about infobase access settings changes.

        Causes no effect if given listener is already registered.

        Parameters:
        listener - the infobase access settings change listener to add, cannot be null

      • removeInfobaseAccessSettingsChangeListener

        void removeInfobaseAccessSettingsChangeListener​(IInfobaseAccessSettingsChangeListener listener)
        Removes registered infobase access settings change listener from service. Listener will no longer be notified about infobase access settings changes.
        Parameters:
        listener - the infobase access settings change listener to remove, cannot be null

      • updateSettings

        void updateSettings​(InfobaseReference infobase,
                    IInfobaseAccessSettings settings)
             throws org.eclipse.core.runtime.CoreException
        Updates the given infobase access settings.
        Parameters:
        infobase - infobase to load updated infobase access settings for, cannot be null
        settings - infobase access settings, cannot be null
        Throws:
        org.eclipse.core.runtime.CoreException - if storing fails