Package com.synopsys.arc.jenkins.plugins.ownership.nodes

Class ComputerOwnerHelper

java.lang.Object

com.synopsys.arc.jenkins.plugins.ownership.util.AbstractOwnershipHelper<Computer>

com.synopsys.arc.jenkins.plugins.ownership.nodes.ComputerOwnerHelper

All Implemented Interfaces:

IOwnershipHelper<Computer>

public class ComputerOwnerHelper
extends AbstractOwnershipHelper<Computer>

Provides ownership helper for Computer. The class implements a wrapper of NodeOwnerHelper.

Author:

Oleg Nenashev

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ComputerOwnerHelper.LocatorImpl

Constructor Summary

Constructors

Constructor	Description
ComputerOwnerHelper()

Method Summary

Modifier and Type	Method	Description
static ComputerOwnerHelper	getInstance()
String	getItemDisplayName(Computer item)	Gets a short classifier.
String	getItemTypeName(Computer item)	Gets a type of the item to be displayed.
String	getItemURL(Computer item)	Gets a relative URL to the item.
OwnershipDescription	getOwnershipDescription(Computer item)	Gets ownership description of the requested item.
OwnershipInfo	getOwnershipInfo(Computer item)	Gets ownership info of the requested item.
Collection<User>	getPossibleOwners(Computer computer)	Get list of users, who can be item's owner.
Permission	getRequiredPermission()	Gets permission required to manage ownership for the item.
boolean	hasLocallyDefinedOwnership(Computer computer)	Check if the objeck has locally defined ownership info.
static void	setOwnership(Computer computer, OwnershipDescription descr)

Methods inherited from class com.synopsys.arc.jenkins.plugins.ownership.util.AbstractOwnershipHelper

filterPossibleOwners, getDisplayName, getOwner, getOwnerEmail, getOwnerLongString, hasItemSpecificPermission, isDisplayOwnershipSummaryBox, isOwnerExists

Methods inherited from class java.lang.Object

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

Constructor Details

ComputerOwnerHelper

public ComputerOwnerHelper()

Method Details

getInstance

public static ComputerOwnerHelper getInstance()

getOwnershipDescription

public OwnershipDescription getOwnershipDescription(@Nonnull
 Computer item)

Description copied from interface: IOwnershipHelper

Gets ownership description of the requested item.

Parameters:

item - Item to be described

Returns:

Ownership description. The method returns a OwnershipDescription.DISABLED_DESCR

getOwnershipInfo

public OwnershipInfo getOwnershipInfo(Computer item)

Description copied from class: AbstractOwnershipHelper

Gets ownership info of the requested item.

Specified by:

getOwnershipInfo in class AbstractOwnershipHelper<Computer>

Parameters:

item - Item to be described

Returns:

Ownership description. The method returns a OwnershipDescription.DISABLED_DESCR

getPossibleOwners

public Collection<User> getPossibleOwners(@Nonnull
 Computer computer)

Description copied from interface: IOwnershipHelper

Get list of users, who can be item's owner.

Specified by:

getPossibleOwners in interface IOwnershipHelper<Computer>

Overrides:

getPossibleOwners in class AbstractOwnershipHelper<Computer>

Parameters:

computer - Item to be described

Returns:

List of users, who can be item's owner (always non-null). By default, the method returns an empty list in AbstractOwnershipHelper.

setOwnership

public static void setOwnership(@Nonnull
 Computer computer,
 @CheckForNull
 OwnershipDescription descr)
                         throws IOException

Throws:

IOException

getRequiredPermission

public Permission getRequiredPermission()

Description copied from class: AbstractOwnershipHelper

Gets permission required to manage ownership for the item. Jenkins.ADMINISTER by default if not overridden.

Overrides:

getRequiredPermission in class AbstractOwnershipHelper<Computer>

Returns:

Permission which is needed to change ownership.

hasLocallyDefinedOwnership

public boolean hasLocallyDefinedOwnership(@Nonnull
 Computer computer)

Description copied from class: AbstractOwnershipHelper

Check if the objeck has locally defined ownership info.

Overrides:

hasLocallyDefinedOwnership in class AbstractOwnershipHelper<Computer>

Parameters:

computer - Item

Returns:

true if the object has ownership defined locally. false will be returned otherwise, even if ownership is inherited.

getItemTypeName

public String getItemTypeName(Computer item)

Description copied from interface: IOwnershipHelper

Gets a type of the item to be displayed.

Parameters:

item -

Returns:

Display name of the item type

getItemDisplayName

public String getItemDisplayName(Computer item)

Description copied from interface: IOwnershipHelper

Gets a short classifier. Usage example: e-mail headers

Parameters:

item -

Returns:

Short description of the object

getItemURL

public String getItemURL(Computer item)

Description copied from interface: IOwnershipHelper

Gets a relative URL to the item.

Parameters:

item -

Returns:

Relative URL or null if it is not available