hudson.security

Class GlobalSecurityConfiguration

java.lang.Object

hudson.model.ManagementLink

hudson.security.GlobalSecurityConfiguration

All Implemented Interfaces:

ExtensionPoint, Action, Describable<GlobalSecurityConfiguration>, ModelObject

@Extension(ordinal=2.147483437E9)
public class GlobalSecurityConfiguration
extends ManagementLink
implements Describable<GlobalSecurityConfiguration>

Security configuration. For historical reasons, most of the actual configuration values are stored in Jenkins.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GlobalSecurityConfiguration.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Predicate<GlobalConfigurationCategory>	FILTER

Fields inherited from class hudson.model.ManagementLink

LIST

Constructor Summary

Constructors

Constructor and Description
GlobalSecurityConfiguration()

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
void	doConfigure(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
String	getDescription() Returns a short description of what this link does.
Descriptor<GlobalSecurityConfiguration>	getDescriptor() Gets the descriptor for this instance.
String	getDisplayName() Gets the string to be displayed.
String	getIconFileName() Mostly works like Action.getIconFileName(), except that the expected icon size is 48x48, not 24x24.
MarkupFormatter	getMarkupFormatter()
Permission	getRequiredPermission()
int	getSlaveAgentPort()
String	getUrlName() Gets the URL path name.
boolean	isDisableRememberMe()

Methods inherited from class hudson.model.ManagementLink

all, getRequiresConfirmation, getRequiresPOST

Methods inherited from class java.lang.Object

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

Field Detail

FILTER

public static com.google.common.base.Predicate<GlobalConfigurationCategory> FILTER

Constructor Detail

GlobalSecurityConfiguration

public GlobalSecurityConfiguration()

Method Detail

getMarkupFormatter

public MarkupFormatter getMarkupFormatter()

getSlaveAgentPort

public int getSlaveAgentPort()

isDisableRememberMe

public boolean isDisableRememberMe()

doConfigure

public void doConfigure(org.kohsuke.stapler.StaplerRequest req,
                        org.kohsuke.stapler.StaplerResponse rsp)
                 throws IOException,
                        javax.servlet.ServletException,
                        Descriptor.FormException

Throws:

IOException

javax.servlet.ServletException

Descriptor.FormException

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject json)
                  throws Descriptor.FormException

Throws:

Descriptor.FormException

getDisplayName

public String getDisplayName()

Description copied from interface: Action

Gets the string to be displayed. The convention is to capitalize the first letter of each word, such as "Test Result".

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getDescription

public String getDescription()

Description copied from class: ManagementLink

Returns a short description of what this link does. This text is the one that's displayed in grey. This can include HTML, although the use of block tags is highly discouraged. Optional.

Overrides:

getDescription in class ManagementLink

getIconFileName

public String getIconFileName()

Description copied from class: ManagementLink

Mostly works like Action.getIconFileName(), except that the expected icon size is 48x48, not 24x24. So if you give just a file name, "/images/48x48" will be assumed.

Specified by:

getIconFileName in interface Action

Specified by:

getIconFileName in class ManagementLink

Returns:

As a special case, return null to exclude this object from the management link. This is useful for defining ManagementLink that only shows up under certain circumstances.

See Also:

Functions.isAnonymous(), Functions.getIconFilePath(Action)

getUrlName

public String getUrlName()

Description copied from class: ManagementLink

Gets the URL path name.

For example, if this method returns "xyz", and if the parent object (that this action is associated with) is bound to /foo/bar/zot, then this action object will be exposed to /foo/bar/zot/xyz.

This method should return a string that's unique among other Actions.

The returned string can be an absolute URL, like "http://www.sun.com/", which is useful for directly connecting to external systems.

If the returned string starts with '/', like '/foo', then it's assumed to be relative to the context path of the Jenkins webapp.

In case of ManagementLink, this value is put straight into the href attribute, so relative paths are interpreted against the root Jenkins object.

Specified by:

getUrlName in interface Action

Specified by:

getUrlName in class ManagementLink

Returns:

null if this action object doesn't need to be bound to web (when you do that, be sure to also return null from Action.getIconFileName().

See Also:

Functions.getActionUrl(String, Action)

getRequiredPermission

public Permission getRequiredPermission()

Overrides:

getRequiredPermission in class ManagementLink

Returns:

permission required for user to access this management link, in addition to Jenkins.ADMINISTER

getDescriptor

public Descriptor<GlobalSecurityConfiguration> getDescriptor()

Description copied from interface: Describable

Gets the descriptor for this instance.

Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

Specified by:

getDescriptor in interface Describable<GlobalSecurityConfiguration>

Returns:

See Also:

Describable.getDescriptor()