Package org.jenkinsci.plugins.cas

Class CasProtocol

java.lang.Object

hudson.model.AbstractDescribableImpl<CasProtocol>

org.jenkinsci.plugins.cas.CasProtocol

All Implemented Interfaces:

ExtensionPoint, Describable<CasProtocol>

Direct Known Subclasses:

Cas10Protocol, Cas20Protocol, Cas30Protocol, Saml11Protocol

public abstract class CasProtocol
extends AbstractDescribableImpl<CasProtocol>
implements ExtensionPoint

CAS protocol extension point. The protocol determines how to validate a server response, and may define specific configuration options.

Author:

Fabien Crespel

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
protected String	artifactParameter
final String	authoritiesAttribute
protected List<String>	authoritiesAttributes
final String	customValidationParams
protected Map<String,String>	customValidationParamsMap
final String	emailAttribute
final String	fullNameAttribute

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CasProtocol()
protected	CasProtocol(String authoritiesAttribute)
protected	CasProtocol(String authoritiesAttribute, String fullNameAttribute, String emailAttribute)
protected	CasProtocol(String authoritiesAttribute, String fullNameAttribute, String emailAttribute, String customValidationParams)

Method Summary

Modifier and Type	Method	Description
static DescriptorExtensionList<CasProtocol,Descriptor<CasProtocol>>	all()	Returns all the registered CasProtocol descriptors.
org.springframework.security.cas.ServiceProperties	createServiceProperties()	Create a ServiceProperties object describing the CAS service.
abstract org.apereo.cas.client.validation.TicketValidator	createTicketValidator(String casServerUrl)	Create a TicketValidator used to validate a CAS response.
String	getArtifactParameter()
String	getAuthoritiesAttribute()
List<String>	getAuthoritiesAttributes()
String	getCustomValidationParams()
Map<String,String>	getCustomValidationParamsMap()
String	getEmailAttribute()
String	getFullNameAttribute()

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Field Details

authoritiesAttribute

public final String authoritiesAttribute

fullNameAttribute

public final String fullNameAttribute

emailAttribute

public final String emailAttribute

customValidationParams

public final String customValidationParams

artifactParameter

protected transient String artifactParameter

authoritiesAttributes

protected transient List<String> authoritiesAttributes

customValidationParamsMap

protected transient Map<String,String> customValidationParamsMap

Constructor Details

CasProtocol

protected CasProtocol()

CasProtocol

protected CasProtocol(String authoritiesAttribute)

CasProtocol

protected CasProtocol(String authoritiesAttribute,
 String fullNameAttribute,
 String emailAttribute)

CasProtocol

protected CasProtocol(String authoritiesAttribute,
 String fullNameAttribute,
 String emailAttribute,
 String customValidationParams)

Method Details

getArtifactParameter

public String getArtifactParameter()

Returns:

the artifactParameter

getAuthoritiesAttribute

public String getAuthoritiesAttribute()

Returns:

the authoritiesAttribute

getAuthoritiesAttributes

public List<String> getAuthoritiesAttributes()

Returns:

the authoritiesAttributes

getFullNameAttribute

public String getFullNameAttribute()

Returns:

the fullNameAttribute

getEmailAttribute

public String getEmailAttribute()

Returns:

the emailAttribute

getCustomValidationParams

public String getCustomValidationParams()

Returns:

the customValidationParams

getCustomValidationParamsMap

public Map<String,String> getCustomValidationParamsMap()

Returns:

the customValidationParamsMap

createServiceProperties

public org.springframework.security.cas.ServiceProperties createServiceProperties()

Create a ServiceProperties object describing the CAS service.

Returns:

ServiceProperties

createTicketValidator

public abstract org.apereo.cas.client.validation.TicketValidator createTicketValidator(String casServerUrl)

Create a TicketValidator used to validate a CAS response.

Parameters:

casServerUrl - CAS server URL prefix

Returns:

TicketValidator

all

public static DescriptorExtensionList<CasProtocol,Descriptor<CasProtocol>> all()

Returns all the registered CasProtocol descriptors.

Returns:

all CasProtocol descriptors