Package com.cloudbees.jenkins.support.impl

Class ReverseProxy

java.lang.Object

com.cloudbees.jenkins.support.api.Component

com.cloudbees.jenkins.support.impl.ReverseProxy

All Implemented Interfaces:

ExtensionPoint

@Extension
public class ReverseProxy
extends Component

Attempts to detect reverse proxies in front of Jenkins.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ReverseProxy.Trilean

Nested classes/interfaces inherited from class com.cloudbees.jenkins.support.api.Component

Component.ComponentCategory

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ReverseProxy()

Method Summary

Modifier and Type	Method	Description
void	addContents(Container container)	Add contents to a container
boolean	canBeGeneratedAsync()	This method will indicate if the component can be generated asynchronously.
Component.ComponentCategory	getCategory()	Specify in which Component.ComponentCategory the current component is related.
protected org.kohsuke.stapler.StaplerRequest2	getCurrentRequest()
String	getDisplayName()
Set<Permission>	getRequiredPermissions()	Returns the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle.

Methods inherited from class com.cloudbees.jenkins.support.api.Component

getDisplayPermissions, getId, isApplicable, isEnabled, isSelectedByDefault, start, supersedes

Methods inherited from class java.lang.Object

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

Constructor Details

ReverseProxy

public ReverseProxy()

Method Details

canBeGeneratedAsync

public boolean canBeGeneratedAsync()

Description copied from class: Component

This method will indicate if the component can be generated asynchronously. This is useful for components that need request context info that only be available in a request thread. By default, it will return true.

Overrides:

canBeGeneratedAsync in class Component

Returns:

getRequiredPermissions

@NonNull
public Set<Permission> getRequiredPermissions()

Description copied from class: Component

Returns the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle. An empty list indicates that any user can include this bundle.

Specified by:

getRequiredPermissions in class Component

Returns:

the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle.

getDisplayName

@NonNull
public String getDisplayName()

Specified by:

getDisplayName in class Component

addContents

public void addContents(@NonNull
 Container container)

Description copied from class: Component

Add contents to a container

Specified by:

addContents in class Component

Parameters:

container - a Container

getCategory

@NonNull
public Component.ComponentCategory getCategory()

Description copied from class: Component

Specify in which Component.ComponentCategory the current component is related.

Overrides:

getCategory in class Component

Returns:

An enum value of Component.ComponentCategory.

getCurrentRequest

protected org.kohsuke.stapler.StaplerRequest2 getCurrentRequest()