Package hudson.security.csrf

Class CrumbIssuerDescriptor<T extends CrumbIssuer>

java.lang.Object

hudson.model.Descriptor<CrumbIssuer>

hudson.security.csrf.CrumbIssuerDescriptor<T>

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Direct Known Subclasses:

DefaultCrumbIssuer.DescriptorImpl

public abstract class CrumbIssuerDescriptor<T extends CrumbIssuer>
extends Descriptor<CrumbIssuer>

Describes global configuration for crumb issuers. Create subclasses to specify additional global configuration for custom crumb issuers.

Author:

dty

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CrumbIssuerDescriptor(String salt, String crumbRequestField)	Crumb issuers always take a salt and a request field name.

Method Summary

Modifier and Type	Method	Description
String	getCrumbRequestField()	Gets the request parameter name that contains the crumb generated from a previous response.
String	getCrumbSalt()	Get the salt value.
void	setCrumbRequestField(String requestField)	Set the request parameter name.
void	setCrumbSalt(String salt)	Set the salt value.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Details

CrumbIssuerDescriptor

protected CrumbIssuerDescriptor(String salt,
 String crumbRequestField)

Crumb issuers always take a salt and a request field name.

Parameters:

salt - Salt value

crumbRequestField - Request parameter name containing crumb from previous response

Method Details

getCrumbSalt

public String getCrumbSalt()

Get the salt value.

setCrumbSalt

public void setCrumbSalt(String salt)

Set the salt value. Must not be null.

getCrumbRequestField

public String getCrumbRequestField()

Gets the request parameter name that contains the crumb generated from a previous response.

setCrumbRequestField

public void setCrumbRequestField(String requestField)

Set the request parameter name. Must not be null.