Package hudson.plugins.createjobadvanced

Class JobConfigurer

java.lang.Object

hudson.plugins.createjobadvanced.AbstractConfigurer<Job<?,?>,AuthorizationMatrixProperty>

hudson.plugins.createjobadvanced.JobConfigurer

Direct Known Subclasses:

MavenConfigurer

public class JobConfigurer
extends AbstractConfigurer<Job<?,?>,AuthorizationMatrixProperty>

Changes the configuration of Job<?,?> items.

Author:

Laurent Coltat

Field Summary

Fields inherited from class hudson.plugins.createjobadvanced.AbstractConfigurer

log

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JobConfigurer()

Method Summary

Modifier and Type	Method	Description
protected final void	addAuthorizationMatrixProperty(Item item, AuthorizationMatrixProperty authProperty)	Assigne given authorization matrix property to given item.
protected final void	addPermission(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 final AuthorizationMatrixProperty	createAuthorizationMatrixProperty()	Create a fresh new authorization matrix property.
protected void	doCreate(Item item)	Update given Item according to plugin configuration.
protected final AuthorizationMatrixProperty	getAuthorizationMatrixProperty(Item item)	Fetch autorization matrix property from given item.
protected final Map<Permission,Set<org.jenkinsci.plugins.matrixauth.PermissionEntry>>	getGrantedPermissionEntries(AuthorizationMatrixProperty authProperty)	Fetch association of Jenkins permissions to permission entries from given authorization matrix.auth.
protected final void	removeProperty(Item item, AuthorizationMatrixProperty authProperty)	Remove given authorization matrix from given item.
protected final void	renameJob(Item item, String newName)	Rename given item with given name.
protected final void	setInheritanceStrategy(AuthorizationMatrixProperty authProperty, org.jenkinsci.plugins.matrixauth.inheritance.InheritanceStrategy inheritanceStrategy)	Assign given inheritance strategy to given authorization matrix property.
protected final 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

JobConfigurer

protected JobConfigurer()

Method Details

renameJob

protected final void renameJob(@Nullable
 Item item,
 @NonNull
 String newName)
                        throws IOException

Description copied from class: AbstractConfigurer

Rename given item with given name.

Specified by:

renameJob in class AbstractConfigurer<Job<?,?>,AuthorizationMatrixProperty>

Parameters:

item - Item to be updated

newName - New name to be assigned

Throws:

IOException

doCreate

protected void doCreate(Item item)

Description copied from class: AbstractConfigurer

Update given Item according to plugin configuration.

Overrides:

doCreate in class AbstractConfigurer<Job<?,?>,AuthorizationMatrixProperty>

Parameters:

item - item to be updated

getAuthorizationMatrixProperty

@Nullable
protected final AuthorizationMatrixProperty getAuthorizationMatrixProperty(@Nullable
 Item item)

Description copied from class: AbstractConfigurer

Fetch autorization matrix property from given item.

Specified by:

getAuthorizationMatrixProperty in class AbstractConfigurer<Job<?,?>,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 final void removeProperty(@Nullable
 Item item,
 @Nullable
 AuthorizationMatrixProperty authProperty)

Description copied from class: AbstractConfigurer

Remove given authorization matrix from given item.

Specified by:

removeProperty in class AbstractConfigurer<Job<?,?>,AuthorizationMatrixProperty>

Parameters:

item - item to be updated

authProperty - authorization matrix to be removed

getGrantedPermissionEntries

protected final Map<Permission,Set<org.jenkinsci.plugins.matrixauth.PermissionEntry>> getGrantedPermissionEntries(@Nullable
 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<Job<?,?>,AuthorizationMatrixProperty>

Parameters:

authProperty - authorization matrix to be updated.

Returns:

a Map of Jenkins permissions linked to their assigned permissions entries.

addAuthorizationMatrixProperty

protected final void addAuthorizationMatrixProperty(@Nullable
 Item item,
 @Nullable
 AuthorizationMatrixProperty authProperty)
                                             throws IOException

Description copied from class: AbstractConfigurer

Assigne given authorization matrix property to given item.

Specified by:

addAuthorizationMatrixProperty in class AbstractConfigurer<Job<?,?>,AuthorizationMatrixProperty>

Parameters:

item - Item to be updated

authProperty - authorization matrix property to be assigned

Throws:

IOException

createAuthorizationMatrixProperty

@Nullable
protected final AuthorizationMatrixProperty createAuthorizationMatrixProperty()

Description copied from class: AbstractConfigurer

Create a fresh new authorization matrix property.

Specified by:

createAuthorizationMatrixProperty in class AbstractConfigurer<Job<?,?>,AuthorizationMatrixProperty>

Returns:

created authorization matrix property

setInheritanceStrategy

protected final void setInheritanceStrategy(@Nullable
 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<Job<?,?>,AuthorizationMatrixProperty>

Parameters:

authProperty - authorization matrix property to be updated

inheritanceStrategy - inheritance strategy to be assigned

addPermission

protected final void addPermission(@Nullable
 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<Job<?,?>,AuthorizationMatrixProperty>

Parameters:

authProperty - authorization matrix property to be updated

perm - Jenkins permission to be assigned

permEntry - permission entry to be associated

showPermission

protected final 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<Job<?,?>,AuthorizationMatrixProperty>

Parameters:

perm - Jenkins permission

Returns:

true if parameter is available