Package org.jenkinsci.plugins.ownership.model.folders

Class FolderOwnershipProperty

java.lang.Object

hudson.model.AbstractDescribableImpl<com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<?>>

com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>>

org.jenkinsci.plugins.ownership.model.folders.FolderOwnershipProperty

All Implemented Interfaces:

IOwnershipItem<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>>, ExtensionPoint, Describable<com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<?>>, ReconfigurableDescribable<com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<?>>

public class FolderOwnershipProperty
extends com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>>
implements IOwnershipItem<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>>

Ownership property for AbstractFolders.

Since:

0.9

Author:

Oleg Nenashev, Rustam Atai

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FolderOwnershipProperty.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.cloudbees.hudson.plugins.folder.AbstractFolderProperty

owner

Constructor Summary

Constructors

Constructor	Description
FolderOwnershipProperty(OwnershipDescription ownership)
FolderOwnershipProperty(OwnershipDescription ownership, FolderSpecificSecurity itemSpecificSecurity)

Method Summary

Modifier and Type	Method	Description
com.cloudbees.hudson.plugins.folder.AbstractFolder<?>	getDescribedItem()	Gets item, which is being described by action.
FolderSpecificSecurity	getItemSpecificSecurity()	Gets current configuration of folder-specific security.
OwnershipDescription	getOwnership()	Gets ownership description.
boolean	hasItemSpecificSecurity()	Checks if folder-specific security is configured locally.
IOwnershipHelper<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>>	helper()	Gets a helper for typical operations.
com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<?>	reconfigure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject form)
void	setItemSpecificSecurity(FolderSpecificSecurity security)
void	setOwnershipDescription(OwnershipDescription description)	Sets the new ownership description.

Methods inherited from class com.cloudbees.hudson.plugins.folder.AbstractFolderProperty

getDescriptor, getHealthMetrics, getHealthReports, getItemContainerOverrides, getOwner, reconfigure, setOwner

Methods inherited from class java.lang.Object

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

Constructor Details

FolderOwnershipProperty

public FolderOwnershipProperty(@CheckForNull
 OwnershipDescription ownership)

FolderOwnershipProperty

public FolderOwnershipProperty(@CheckForNull
 OwnershipDescription ownership,
 @CheckForNull
 FolderSpecificSecurity itemSpecificSecurity)

Method Details

helper

public IOwnershipHelper<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>> helper()

Description copied from interface: IOwnershipItem

Gets a helper for typical operations.

Specified by:

helper in interface IOwnershipItem<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>>

Returns:

Helper

getDescribedItem

public com.cloudbees.hudson.plugins.folder.AbstractFolder<?> getDescribedItem()

Description copied from interface: IOwnershipItem

Gets item, which is being described by action.

Specified by:

getDescribedItem in interface IOwnershipItem<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>>

Returns:

Described item

getOwnership

public OwnershipDescription getOwnership()

Description copied from interface: IOwnershipItem

Gets ownership description. By default, returns OwnershipDescription.DISABLED_DESCR

Specified by:

getOwnership in interface IOwnershipItem<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>>

Returns:

Ownership Description (not null)

getItemSpecificSecurity

@CheckForNull
public FolderSpecificSecurity getItemSpecificSecurity()

Gets current configuration of folder-specific security. Falls back to global defaults when not configured locally. Use hasItemSpecificSecurity() to check an origin of permissions.

Returns:

FolderSpecificSecurity or null if neither local nor global is set

hasItemSpecificSecurity

public boolean hasItemSpecificSecurity()

Checks if folder-specific security is configured locally.

Returns:

true if folder-specific security is configured on this property

setOwnershipDescription

public void setOwnershipDescription(@CheckForNull
 OwnershipDescription description)
                             throws IOException

Sets the new ownership description.

Parameters:

description - Description to be set. Use null to drop settings.

Throws:

IOException - Property cannot be saved.

setItemSpecificSecurity

public void setItemSpecificSecurity(@CheckForNull
 FolderSpecificSecurity security)
                             throws IOException

Throws:

IOException

reconfigure

public com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<?> reconfigure(org.kohsuke.stapler.StaplerRequest req,
 net.sf.json.JSONObject form)
                                                                          throws Descriptor.FormException

Specified by:

reconfigure in interface ReconfigurableDescribable<com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<?>>

Overrides:

reconfigure in class com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>>

Throws:

Descriptor.FormException