Package org.apache.jackrabbit.oak.spi.security

Interface SecurityConfiguration

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  SecurityConfiguration.Default
      Default implementation that provides empty initializers, validators, commit hooks and parameters.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      @NotNull List<? extends org.apache.jackrabbit.oak.spi.commit.CommitHook> getCommitHooks​(@NotNull String workspaceName)
      Returns the list of commit hooks that need to be executed for the specified workspace name.
      @NotNull List<org.apache.jackrabbit.oak.spi.commit.ThreeWayConflictHandler> getConflictHandlers()
      Returns the list of conflict handlers available for this security configuration.
      @NotNull Context getContext()  
      default @NotNull Iterable<org.apache.jackrabbit.oak.stats.Monitor<?>> getMonitors​(@NotNull org.apache.jackrabbit.oak.stats.StatisticsProvider statisticsProvider)  
      @NotNull String getName()
      Returns the name of this security configuration.
      @NotNull ConfigurationParameters getParameters()
      Returns the configuration parameters associated with this security configuration instance.
      @NotNull List<ProtectedItemImporter> getProtectedItemImporters()  
      @NotNull org.apache.jackrabbit.oak.spi.lifecycle.RepositoryInitializer getRepositoryInitializer()
      Returns a repository initializer for this security configuration.
      @NotNull List<? extends org.apache.jackrabbit.oak.spi.commit.ValidatorProvider> getValidators​(@NotNull String workspaceName, @NotNull Set<Principal> principals, @NotNull org.apache.jackrabbit.oak.spi.commit.MoveTracker moveTracker)
      Returns the list of validators that need to be executed for the specified workspace name.
      @NotNull org.apache.jackrabbit.oak.spi.lifecycle.WorkspaceInitializer getWorkspaceInitializer()
      Returns a workspace initializer for this security configuration.

    • Method Detail

      • getName

        @NotNull
@NotNull String getName()
        Returns the name of this security configuration.
        Returns:
        The name of this configuration.

      • getParameters

        @NotNull
@NotNull ConfigurationParameters getParameters()
        Returns the configuration parameters associated with this security configuration instance. If no parameters are present ConfigurationParameters.EMPTY should be returned.
        Returns:
        The configuration parameters.

      • getWorkspaceInitializer

        @NotNull
@NotNull org.apache.jackrabbit.oak.spi.lifecycle.WorkspaceInitializer getWorkspaceInitializer()
        Returns a workspace initializer for this security configuration. If this configuration doesn't require any specific workspace initialization WorkspaceInitializer.DEFAULT should be returned.
        Returns:
        An instance of WorkspaceInitializer.

      • getRepositoryInitializer

        @NotNull
@NotNull org.apache.jackrabbit.oak.spi.lifecycle.RepositoryInitializer getRepositoryInitializer()
        Returns a repository initializer for this security configuration. If this configuration doesn't require any specific repository initialization RepositoryInitializer.DEFAULT should be returned.
        Returns:
        An instance of RepositoryInitializer.

      • getCommitHooks

        @NotNull
@NotNull List<? extends org.apache.jackrabbit.oak.spi.commit.CommitHook> getCommitHooks​(@NotNull
                                                                                        @NotNull String workspaceName)
        Returns the list of commit hooks that need to be executed for the specified workspace name.
        Parameters:
        workspaceName - The name of the workspace.
        Returns:
        A list of commit hooks.

      • getValidators

        @NotNull
@NotNull List<? extends org.apache.jackrabbit.oak.spi.commit.ValidatorProvider> getValidators​(@NotNull
                                                                                              @NotNull String workspaceName,
                                                                                              @NotNull
                                                                                              @NotNull Set<Principal> principals,
                                                                                              @NotNull
                                                                                              @NotNull org.apache.jackrabbit.oak.spi.commit.MoveTracker moveTracker)
        Returns the list of validators that need to be executed for the specified workspace name.
        Parameters:
        workspaceName - The name of the workspace.
        principals - The set of principals associated with the subject that is committing modifications.
        moveTracker - The move tracker associated with the commit.
        Returns:
        A list of validators.

      • getConflictHandlers

        @NotNull
@NotNull List<org.apache.jackrabbit.oak.spi.commit.ThreeWayConflictHandler> getConflictHandlers()
        Returns the list of conflict handlers available for this security configuration.
        Returns:
        A list of ThreeWayConflictHandler.

      • getProtectedItemImporters

        @NotNull
@NotNull List<ProtectedItemImporter> getProtectedItemImporters()
        Returns:
        The list of protected item importers defined by this configuration.

      • getContext

        @NotNull
@NotNull Context getContext()
        Returns:
        The context defined by this configuration.

      • getMonitors

        @NotNull
default @NotNull Iterable<org.apache.jackrabbit.oak.stats.Monitor<?>> getMonitors​(@NotNull
                                                                                  @NotNull org.apache.jackrabbit.oak.stats.StatisticsProvider statisticsProvider)