org.jenkinsci.plugins.saml

Class SamlSecurityRealm

java.lang.Object

hudson.model.AbstractDescribableImpl<hudson.security.SecurityRealm>

hudson.security.SecurityRealm

org.jenkinsci.plugins.saml.SamlSecurityRealm

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.security.SecurityRealm>

public class SamlSecurityRealm
extends hudson.security.SecurityRealm

Authenticates the user via SAML. This class is the main entry point to the plugin. Uses Stapler (stapler.kohsuke.org) to bind methods to URLs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SamlSecurityRealm.DescriptorImpl

Nested classes/interfaces inherited from class hudson.security.SecurityRealm

hudson.security.SecurityRealm.SecurityComponents

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.security.SecurityRealm

AUTHENTICATED_AUTHORITY, LIST, NO_AUTHENTICATION

Constructor Summary

Constructors

Constructor and Description
SamlSecurityRealm(String signOnUrl, String certificate) Jenkins passes these parameters in when you update the settings.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowsSignup()
hudson.security.SecurityRealm.SecurityComponents	createSecurityComponents()
org.kohsuke.stapler.HttpResponse	doCommenceLogin(org.kohsuke.stapler.StaplerRequest request, String referer) /securityRealm/commenceLogin
org.kohsuke.stapler.HttpResponse	doFinishLogin(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response) /securityRealm/finishLogin
String	getCertificate()
String	getLoginUrl()
String	getSignOnUrl()
void	setCertificate(String certificate)
void	setSignOnUrl(String signOnUrl)

Methods inherited from class hudson.security.SecurityRealm

all, canLogOut, commenceSignup, createCliAuthenticator, createFilter, doCaptcha, doLogout, findBean, getAuthenticationGatewayUrl, getCaptchaSupport, getCaptchaSupportDescriptors, getDescriptor, getGroupIdStrategy, getPostLogOutUrl, getSecurityComponents, getUserIdStrategy, loadGroupByGroupname, loadGroupByGroupname, loadUserByUsername, setCaptchaSupport, validateCaptcha

Methods inherited from class java.lang.Object

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

Constructor Detail

SamlSecurityRealm

@DataBoundConstructor
public SamlSecurityRealm(String signOnUrl,
                                      String certificate)

Jenkins passes these parameters in when you update the settings. It does this because of the @DataBoundConstructor

Method Detail

allowsSignup

public boolean allowsSignup()

Overrides:

allowsSignup in class hudson.security.SecurityRealm

createSecurityComponents

public hudson.security.SecurityRealm.SecurityComponents createSecurityComponents()

Specified by:

createSecurityComponents in class hudson.security.SecurityRealm

getLoginUrl

public String getLoginUrl()

Overrides:

getLoginUrl in class hudson.security.SecurityRealm

doCommenceLogin

public org.kohsuke.stapler.HttpResponse doCommenceLogin(org.kohsuke.stapler.StaplerRequest request,
                                               @Header(value="Referer")
                                               String referer)

/securityRealm/commenceLogin

doFinishLogin

public org.kohsuke.stapler.HttpResponse doFinishLogin(org.kohsuke.stapler.StaplerRequest request,
                                             org.kohsuke.stapler.StaplerResponse response)

/securityRealm/finishLogin

getSignOnUrl

public String getSignOnUrl()

setSignOnUrl

public void setSignOnUrl(String signOnUrl)

getCertificate

public String getCertificate()

setCertificate

public void setCertificate(String certificate)