Package org.apereo.cas.configuration.model.support.rest

Class RestAuthenticationProperties

java.lang.Object

org.apereo.cas.configuration.model.support.rest.RestAuthenticationProperties

All Implemented Interfaces:

Serializable, CasFeatureModule

@RequiresModule(name="cas-server-support-rest-authentication")
public class RestAuthenticationProperties
extends Object
implements Serializable, CasFeatureModule

This is RestAuthenticationProperties.

Since:

5.0.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apereo.cas.configuration.features.CasFeatureModule

CasFeatureModule.FeatureCatalog

Constructor Summary

Constructors

Constructor	Description
RestAuthenticationProperties()

Method Summary

Modifier and Type	Method	Description
String	getMethod()	HTTP method to use when contacting the REST API for authentication.
String	getName()	Name of the authentication handler.
Integer	getOrder()	Order of the authentication handler in the chain.
PasswordEncoderProperties	getPasswordEncoder()	Password encoder settings for REST authentication.
AuthenticationHandlerStates	getState()	Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated.
String	getUri()	Endpoint URI to use for verification of credentials.
RestAuthenticationProperties	setMethod(String method)	HTTP method to use when contacting the REST API for authentication.
RestAuthenticationProperties	setName(String name)	Name of the authentication handler.
RestAuthenticationProperties	setOrder(Integer order)	Order of the authentication handler in the chain.
RestAuthenticationProperties	setPasswordEncoder(PasswordEncoderProperties passwordEncoder)	Password encoder settings for REST authentication.
RestAuthenticationProperties	setState(AuthenticationHandlerStates state)	Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated.
RestAuthenticationProperties	setUri(String uri)	Endpoint URI to use for verification of credentials.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apereo.cas.configuration.features.CasFeatureModule

isDefined, isUndefined

Constructor Details

RestAuthenticationProperties

public RestAuthenticationProperties()

Method Details

getUri

public String getUri()

Endpoint URI to use for verification of credentials.

getMethod

public String getMethod()

HTTP method to use when contacting the REST API for authentication.

getPasswordEncoder

public PasswordEncoderProperties getPasswordEncoder()

Password encoder settings for REST authentication.

getName

public String getName()

Name of the authentication handler.

getOrder

public Integer getOrder()

Order of the authentication handler in the chain.

getState

public AuthenticationHandlerStates getState()

Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated.

setUri

public RestAuthenticationProperties setUri(String uri)

Endpoint URI to use for verification of credentials.

Returns:

this.

setMethod

public RestAuthenticationProperties setMethod(String method)

HTTP method to use when contacting the REST API for authentication.

Returns:

this.

setPasswordEncoder

public RestAuthenticationProperties setPasswordEncoder(PasswordEncoderProperties passwordEncoder)

Password encoder settings for REST authentication.

Returns:

this.

setName

public RestAuthenticationProperties setName(String name)

Name of the authentication handler.

Returns:

this.

setOrder

public RestAuthenticationProperties setOrder(Integer order)

Order of the authentication handler in the chain.

Returns:

this.

setState

public RestAuthenticationProperties setState(AuthenticationHandlerStates state)

Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated.

Returns:

this.