com.sonyericsson.hudson.plugins.metadata.model
Class MetadataConfigurationPage

java.lang.Object
  com.sonyericsson.hudson.plugins.metadata.model.MetadataConfigurationPage

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Action, hudson.model.ModelObject, hudson.model.RootAction

@Extension
public class MetadataConfigurationPage
extends Object
implements hudson.model.RootAction

A configuration page for setting preset metadata definitions that end up on the job configuration page.

Author:

Tomas Westling <thomas.westling@sonyericsson.com>

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

MetadataConfigurationPage()
Default constructor.

MetadataConfigurationPage(List<AbstractMetadataDefinition> definitions)
Standard DataBound Constructor.

Method Summary

void	doConfigureSubmit(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response) Save the metadata entered on the configuration page.
List<AbstractMetadataDefinition.AbstractMetaDataDefinitionDescriptor>	getDefinitionDescriptors(org.kohsuke.stapler.StaplerRequest request) All registered metadata definition descriptors.
List<? extends MetadataDefinition>	getDefinitions() The list of preset metadata definitions.
String	getDisplayName()
String	getIconFileName()
hudson.security.Permission	getRequiredPermission() Serves the permission required to perform this action.
String	getUrlName()

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataConfigurationPage

@DataBoundConstructor
public MetadataConfigurationPage(List<AbstractMetadataDefinition> definitions)

Standard DataBound Constructor.

Parameters:

definitions - the meta data definitions.

MetadataConfigurationPage

public MetadataConfigurationPage()

Default constructor. Do not use unless you are a serializer.

Method Detail

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface hudson.model.Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.Action

Specified by:

getDisplayName in interface hudson.model.ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface hudson.model.Action

getRequiredPermission

public hudson.security.Permission getRequiredPermission()

Serves the permission required to perform this action. Used by index.jelly

Returns:

the permission.

getDefinitionDescriptors

public List<AbstractMetadataDefinition.AbstractMetaDataDefinitionDescriptor> getDefinitionDescriptors(org.kohsuke.stapler.StaplerRequest request)

All registered metadata definition descriptors. To be used by a hetero-list.

Parameters:

request - the current http request.

Returns:

the list of descriptors.

getDefinitions

public List<? extends MetadataDefinition> getDefinitions()

The list of preset metadata definitions.

Returns:

the list.

doConfigureSubmit

public void doConfigureSubmit(org.kohsuke.stapler.StaplerRequest request,
                              org.kohsuke.stapler.StaplerResponse response)
                       throws javax.servlet.ServletException,
                              hudson.model.Descriptor.FormException,
                              IOException

Save the metadata entered on the configuration page.

Parameters:

request - the current http request.

response - the response from this operation.

Throws:

javax.servlet.ServletException - if there is a problem in getting the submitted form.

Descriptor.FormException - if there is a problem creating the descriptor instances

IOException - if there is a problem in the save or redirect.