Package ch.ivyteam.ivy.security.synch

Interface ISynchronizableSecuritySystem

  • All Known Subinterfaces:
    ISecurityContext
    public interface ISynchronizableSecuritySystem
    API:
    This is a public API.

    • Method Detail

      • triggerSynchronization

        default void triggerSynchronization()
        Triggers a synchronization of the internal security state with the state of the external security system
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • triggerSynchronization

        void triggerSynchronization​(SynchronizationListener listener)
        Triggers a synchronization of the internal security state with the state of the external security system
        Parameters:
        listener - that retrieves state notifications from the asynchronous executed synchronization.
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.
        Security:
        SESSION OWNS SecurityTriggerSynchronization PERMISSION OR OWNS SecurityTriggerSynchronization@SYSTEM PERMISSION

      • isSynchronizationRunning

        boolean isSynchronizationRunning()
        Is the synchronization of the internal security state with the state of the external security system running
        Returns:
        true if synchronization is running, false if not.
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • synchronizeUser

        UserSynchResult synchronizeUser​(String userName)
        Synchronizes the user with the name userName with the external security system. If the user is not yet known in Axon.ivy it will be imported.
        The result contains information whether:
        • The operation was successful. In which case the user and update statistics are provided.
        • The user was not found in the external security system.
        • Or the operation failed. In which case the error exception is provided.
        Parameters:
        userName - The name of the user to synchronize
        Returns:
        The user synchronization result.
        Since:
        8.0.2
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.