Package hudson.logging

Class LogRecorderManager

java.lang.Object

hudson.model.AbstractModelObject

hudson.logging.LogRecorderManager

All Implemented Interfaces:

ModelObject, SearchableModelObject, SearchItem, ModelObjectWithChildren, org.kohsuke.stapler.StaplerProxy

public class LogRecorderManager
extends AbstractModelObject
implements ModelObjectWithChildren, org.kohsuke.stapler.StaplerProxy

Owner of LogRecorders, bound to "/log".

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field	Description
final Map<String,LogRecorder>	logRecorders	Deprecated. use getRecorders() instead
static boolean	SKIP_PERMISSION_CHECK	Escape hatch for StaplerProxy-based access control

Constructor Summary

Constructors

Constructor	Description
LogRecorderManager()

Method Summary

Modifier and Type	Method	Description
FormValidation	doCheckNewName(String name)
ModelObjectWithContextMenu.ContextMenu	doChildrenContextMenu(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 response)	Generates the context menu to list up all the children.
org.kohsuke.stapler.HttpResponse	doConfigLogger(String name, String level)	Configure the logging level.
org.kohsuke.stapler.HttpResponse	doNewLogRecorder(String name)	Creates a new log recorder.
void	doRss(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	RSS feed for log entries.
String	getDisplayName()
LogRecorder	getDynamic(String token)
LogRecorder	getLogRecorder(String token)
List<LogRecorder>	getRecorders()
String	getSearchUrl()	Returns the URL of this item relative to the parent SearchItem.
Object	getTarget()
static void	init(Jenkins h)
void	load()	Loads the configuration from disk.
void	setRecorders(List<LogRecorder> recorders)

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Methods inherited from interface jenkins.model.ModelObjectWithChildren

doChildrenContextMenu

Methods inherited from interface hudson.search.SearchItem

getSearchIcon

Field Details

logRecorders

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@RestrictedSince("2.323")
public final transient Map<String,LogRecorder> logRecorders

Deprecated.

use getRecorders() instead

LogRecorders keyed by their LogRecorder.getName() name}.

SKIP_PERMISSION_CHECK

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static boolean SKIP_PERMISSION_CHECK

Escape hatch for StaplerProxy-based access control

Constructor Details

LogRecorderManager

@DataBoundConstructor
public LogRecorderManager()

Method Details

getRecorders

public List<LogRecorder> getRecorders()

setRecorders

@DataBoundSetter
public void setRecorders(List<LogRecorder> recorders)

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

getSearchUrl

public String getSearchUrl()

Description copied from interface: SearchItem

Returns the URL of this item relative to the parent SearchItem.

Specified by:

getSearchUrl in interface SearchItem

Returns:

URL like "foo" or "foo/bar". The path can end with '/'. The path that starts with '/' will be interpreted as the absolute path (within the context path of Jenkins.)

getDynamic

public LogRecorder getDynamic(String token)

getLogRecorder

public LogRecorder getLogRecorder(String token)

load

public void load()
          throws IOException

Loads the configuration from disk.

Throws:

IOException

doNewLogRecorder

public org.kohsuke.stapler.HttpResponse doNewLogRecorder(@QueryParameter
 String name)

Creates a new log recorder.

doCheckNewName

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public FormValidation doCheckNewName(@QueryParameter
 String name)

doChildrenContextMenu

public ModelObjectWithContextMenu.ContextMenu doChildrenContextMenu(org.kohsuke.stapler.StaplerRequest2 request,
 org.kohsuke.stapler.StaplerResponse2 response)
                                                             throws Exception

Description copied from interface: ModelObjectWithChildren

Generates the context menu to list up all the children.

Specified by:

doChildrenContextMenu in interface ModelObjectWithChildren

Throws:

Exception

doConfigLogger

public org.kohsuke.stapler.HttpResponse doConfigLogger(@QueryParameter
 String name,
 @QueryParameter
 String level)

Configure the logging level.

doRss

public void doRss(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
           throws IOException,
jakarta.servlet.ServletException

RSS feed for log entries.

Throws:

IOException

jakarta.servlet.ServletException

init

@Initializer(before=PLUGINS_PREPARED)
public static void init(Jenkins h)
                 throws IOException

Throws:

IOException

getTarget

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public Object getTarget()

Specified by:

getTarget in interface org.kohsuke.stapler.StaplerProxy