Package hudson.plugins.createjobadvanced

Class FolderConfigurer

java.lang.Object
hudson.plugins.createjobadvanced.AbstractConfigurer<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>,com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty>
hudson.plugins.createjobadvanced.FolderConfigurer
public final class FolderConfigurer extends AbstractConfigurer<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>,com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty>
Changes the configuration of com.cloudbees.hudson.plugins.folder.AbstractFolder<?> items.
Author:
Laurent Coltat

  • Field Summary

    Fields inherited from class hudson.plugins.createjobadvanced.AbstractConfigurer

    log

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    FolderConfigurer()
    Class contructor

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    addAuthorizationMatrixProperty(Item item, com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty authProperty)
    Assigne given authorization matrix property to given item.
    protected void
    addPermission(com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty authProperty, Permission perm, org.jenkinsci.plugins.matrixauth.PermissionEntry permEntry)
    Associate given Jenkins permission to given permission entry and assign it to given authorization property.
    protected com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty
    createAuthorizationMatrixProperty()
    Create a fresh new authorization matrix property.
    protected void
    doCreate(Item item)
    Update given Item according to plugin configuration.
    protected com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty
    getAuthorizationMatrixProperty(Item item)
    Fetch autorization matrix property from given item.
    protected Map<Permission,Set<org.jenkinsci.plugins.matrixauth.PermissionEntry>>
    getGrantedPermissionEntries(com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty authProperty)
    Fetch association of Jenkins permissions to permission entries from given authorization matrix.auth.
    protected void
    removeProperty(Item item, com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty authProperty)
    Remove given authorization matrix from given item.
    protected void
    renameJob(Item item, String newName)
    Rename given item with given name.
    protected void
    setInheritanceStrategy(com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty authProperty, org.jenkinsci.plugins.matrixauth.inheritance.InheritanceStrategy inheritanceStrategy)
    Assign given inheritance strategy to given authorization matrix property.
    protected boolean
    showPermission(Permission perm)
    Check if given Jenkins permission is handled by this object.

    Methods inherited from class hudson.plugins.createjobadvanced.AbstractConfigurer

    configurePermission, doRename, getPlugin, initPermissions, securityGrantPermissions, setupAuthorizationMatrixProperty

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • FolderConfigurer

      protected FolderConfigurer()
      Class contructor

  • Method Details

    • doCreate

      protected void doCreate(@Nullable Item item)
      Description copied from class: AbstractConfigurer
      Update given Item according to plugin configuration.
      Overrides:
      doCreate in class AbstractConfigurer<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>,com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty>
      Parameters:
      item - item to be updated

    • renameJob

      protected void renameJob(@Nullable Item item, @Nullable String newName) throws IOException
      Description copied from class: AbstractConfigurer
      Rename given item with given name.
      Specified by:
      renameJob in class AbstractConfigurer<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>,com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty>
      Parameters:
      item - Item to be updated
      newName - New name to be assigned
      Throws:
      IOException

    • getGrantedPermissionEntries

      protected Map<Permission,Set<org.jenkinsci.plugins.matrixauth.PermissionEntry>> getGrantedPermissionEntries(@Nullable com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty authProperty)
      Description copied from class: AbstractConfigurer
      Fetch association of Jenkins permissions to permission entries from given authorization matrix.auth.
      Specified by:
      getGrantedPermissionEntries in class AbstractConfigurer<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>,com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty>
      Parameters:
      authProperty - authorization matrix to be updated.
      Returns:
      a Map of Jenkins permissions linked to their assigned permissions entries.

    • getAuthorizationMatrixProperty

      @Nullable protected com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty getAuthorizationMatrixProperty(@Nullable Item item)
      Description copied from class: AbstractConfigurer
      Fetch autorization matrix property from given item.
      Specified by:
      getAuthorizationMatrixProperty in class AbstractConfigurer<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>,com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty>
      Parameters:
      item - owner of the autorization matrix property to be fetched
      Returns:
      autorization matrix property of given item if any, null otherwize

    • removeProperty

      protected void removeProperty(@Nullable Item item, @Nullable com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty authProperty)
      Description copied from class: AbstractConfigurer
      Remove given authorization matrix from given item.
      Specified by:
      removeProperty in class AbstractConfigurer<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>,com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty>
      Parameters:
      item - item to be updated
      authProperty - authorization matrix to be removed

    • addAuthorizationMatrixProperty

      protected void addAuthorizationMatrixProperty(@Nullable Item item, @Nullable com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty authProperty) throws IOException
      Description copied from class: AbstractConfigurer
      Assigne given authorization matrix property to given item.
      Specified by:
      addAuthorizationMatrixProperty in class AbstractConfigurer<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>,com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty>
      Parameters:
      item - Item to be updated
      authProperty - authorization matrix property to be assigned
      Throws:
      IOException

    • createAuthorizationMatrixProperty

      @Nullable protected com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty createAuthorizationMatrixProperty()
      Description copied from class: AbstractConfigurer
      Create a fresh new authorization matrix property.
      Specified by:
      createAuthorizationMatrixProperty in class AbstractConfigurer<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>,com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty>
      Returns:
      created authorization matrix property

    • setInheritanceStrategy

      protected void setInheritanceStrategy(@Nullable com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty authProperty, @Nullable org.jenkinsci.plugins.matrixauth.inheritance.InheritanceStrategy inheritanceStrategy)
      Description copied from class: AbstractConfigurer
      Assign given inheritance strategy to given authorization matrix property.
      Specified by:
      setInheritanceStrategy in class AbstractConfigurer<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>,com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty>
      Parameters:
      authProperty - authorization matrix property to be updated
      inheritanceStrategy - inheritance strategy to be assigned

    • addPermission

      protected void addPermission(@Nullable com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty authProperty, @Nullable Permission perm, @Nullable org.jenkinsci.plugins.matrixauth.PermissionEntry permEntry)
      Description copied from class: AbstractConfigurer
      Associate given Jenkins permission to given permission entry and assign it to given authorization property.
      Specified by:
      addPermission in class AbstractConfigurer<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>,com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty>
      Parameters:
      authProperty - authorization matrix property to be updated
      perm - Jenkins permission to be assigned
      permEntry - permission entry to be associated

    • showPermission

      protected boolean showPermission(@Nullable Permission perm)
      Description copied from class: AbstractConfigurer
      Check if given Jenkins permission is handled by this object.
      Specified by:
      showPermission in class AbstractConfigurer<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>,com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty>
      Parameters:
      perm - Jenkins permission
      Returns:
      true if parameter is available