org.jenkinsci.plugins.cas
Class CasProtocol

java.lang.Object
  hudson.model.AbstractDescribableImpl<CasProtocol>
      org.jenkinsci.plugins.cas.CasProtocol

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<CasProtocol>

Direct Known Subclasses:

Cas10Protocol, Cas20Protocol, Saml11Protocol

public abstract class CasProtocol
extends hudson.model.AbstractDescribableImpl<CasProtocol>
implements hudson.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

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

protected String	artifactParameter
protected String	authoritiesAttribute
protected String[]	authoritiesAttributes
protected String	emailAttribute
protected String	fullNameAttribute

Constructor Summary

CasProtocol()

Method Summary

static hudson.DescriptorExtensionList<CasProtocol,hudson.model.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.jasig.cas.client.validation.TicketValidator	createTicketValidator(String casServerUrl) Create a TicketValidator used to validate a CAS response.
String	getArtifactParameter()
String	getAuthoritiesAttribute()
String[]	getAuthoritiesAttributes()
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 Detail

artifactParameter

protected transient String artifactParameter

authoritiesAttributes

protected transient String[] authoritiesAttributes

authoritiesAttribute

protected String authoritiesAttribute

fullNameAttribute

protected String fullNameAttribute

emailAttribute

protected String emailAttribute

Constructor Detail

CasProtocol

public CasProtocol()

Method Detail

getArtifactParameter

public String getArtifactParameter()

Returns:

the artifactParameter

getAuthoritiesAttribute

public String getAuthoritiesAttribute()

Returns:

the authoritiesAttribute

getAuthoritiesAttributes

public String[] getAuthoritiesAttributes()

Returns:

the authoritiesAttributes

getFullNameAttribute

public String getFullNameAttribute()

Returns:

the fullNameAttribute

getEmailAttribute

public String getEmailAttribute()

Returns:

the emailAttribute

createServiceProperties

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

Create a ServiceProperties object describing the CAS service.

Returns:

ServiceProperties

createTicketValidator

public abstract org.jasig.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 hudson.DescriptorExtensionList<CasProtocol,hudson.model.Descriptor<CasProtocol>> all()

Returns all the registered CasProtocol descriptors.