com.sonyericsson.hudson.plugins.metadata.search
Class MetadataSearchPage

java.lang.Object
  com.sonyericsson.hudson.plugins.metadata.search.MetadataSearchPage

All Implemented Interfaces:

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

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

A Metadata Search page for searching metadata in Jenkins jobs, this page will search and list the jobs having the metadata entered by user.

Author:

Shemeer Sulaiman <shemeer.x.sulaiman@sonymobile.com>

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

MetadataSearchPage()
Default constructor.

Method Summary

void	doSearchMetadata(String queryString, org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response) Search the query entered on the Metadata Search page.
String	getDisplayName()
String	getIconFileName()
hudson.security.Permission	getRequiredPermission() Serves the permission required to perform this action.
String	getUrlName()
boolean	isEnabled() Check whether the project is enabled or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataSearchPage

public MetadataSearchPage()

Default constructor.

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.

isEnabled

public boolean isEnabled()

Check whether the project is enabled or not.

Returns:

true if enabled, false if not.

doSearchMetadata

public void doSearchMetadata(@QueryParameter(value="metadata.search.queryString")
                             String queryString,
                             org.kohsuke.stapler.StaplerRequest request,
                             org.kohsuke.stapler.StaplerResponse response)
                      throws Exception

Search the query entered on the Metadata Search page.

Parameters:

queryString - the search query.

request - the current HTTP request.

response - the response from this operation.

Throws:

Exception - if an error occur.