DefaultConsoleUrlProvider (Jenkins core 2.452.4 API)

java.lang.Object
- jenkins.console.DefaultConsoleUrlProvider

All Implemented Interfaces:

Describable<ConsoleUrlProvider>, ConsoleUrlProvider
```
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class DefaultConsoleUrlProvider
extends Object
implements ConsoleUrlProvider
```
Default implementation of ConsoleUrlProvider that uses the standard Jenkins console view.
Exists so that users have a way to override ConsoleUrlProviderGlobalConfiguration and specify the default console view if desired via ConsoleUrlProviderUserProperty.

Since:

2.433

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DefaultConsoleUrlProvider.DescriptorImpl

Field Summary
- Fields inherited from interface jenkins.console.ConsoleUrlProvider
  LOGGER

Constructor Summary

Constructors
Constructor Description

DefaultConsoleUrlProvider()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getConsoleUrl(Run<?,?> run)`	Get a URL relative to the context path of Jenkins which should be used to link to the console for the specified build.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jenkins.console.ConsoleUrlProvider
getDescriptor

- Constructor Detail
  - DefaultConsoleUrlProvider
```
@DataBoundConstructor
public DefaultConsoleUrlProvider()
```
- Method Detail
  - getConsoleUrl
```
public String getConsoleUrl(Run<?,?> run)
```
    Description copied from interface: ConsoleUrlProvider
    
    Get a URL relative to the context path of Jenkins which should be used to link to the console for the specified build.
    Should only be used in the context of serving an HTTP request.
    
    Specified by:
    
    getConsoleUrl in interface ConsoleUrlProvider
    
    Parameters:
    
    run - the build
    
    Returns:
    
    the URL for the console for the specified build, relative to the context of Jenkins, or null if this implementation does not want to server a special console view for this build.