Package org.apereo.cas.configuration.model

Class BaseRestEndpointProperties

java.lang.Object

org.apereo.cas.configuration.model.BaseRestEndpointProperties

All Implemented Interfaces:

Serializable, CasFeatureModule

Direct Known Subclasses:

RestAuthenticationPolicyProperties, RestEndpointProperties, RestfulAccountManagementRegistrationProvisioningProperties, RestfulConsentProperties, RestfulGoogleAuthenticatorMultifactorProperties, RestfulServiceRegistryProperties

@RequiresModule(name="cas-server-core-util",
                automated=true)
public class BaseRestEndpointProperties
extends Object
implements CasFeatureModule, Serializable

This is BaseRestEndpointProperties.

Since:

5.2.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
BaseRestEndpointProperties()

Method Summary

Modifier and Type	Method	Description
String	getBasicAuthPassword()	If REST endpoint is protected via basic authentication, specify the password for authentication.
String	getBasicAuthUsername()	If REST endpoint is protected via basic authentication, specify the username for authentication.
Map<String,String>	getHeaders()	Headers, defined as a Map, to include in the request when making the REST call.
String	getUrl()	The endpoint URL to contact and retrieve attributes.
BaseRestEndpointProperties	setBasicAuthPassword(String basicAuthPassword)	If REST endpoint is protected via basic authentication, specify the password for authentication.
BaseRestEndpointProperties	setBasicAuthUsername(String basicAuthUsername)	If REST endpoint is protected via basic authentication, specify the username for authentication.
BaseRestEndpointProperties	setHeaders(Map<String,String> headers)	Headers, defined as a Map, to include in the request when making the REST call.
BaseRestEndpointProperties	setUrl(String url)	The endpoint URL to contact and retrieve attributes.

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

BaseRestEndpointProperties

public BaseRestEndpointProperties()

Method Details

getUrl

public String getUrl()

The endpoint URL to contact and retrieve attributes.

getBasicAuthUsername

public String getBasicAuthUsername()

If REST endpoint is protected via basic authentication, specify the username for authentication.

getBasicAuthPassword

public String getBasicAuthPassword()

If REST endpoint is protected via basic authentication, specify the password for authentication.

getHeaders

public Map<String,String> getHeaders()

Headers, defined as a Map, to include in the request when making the REST call. Will overwrite any header that CAS is pre-defined to send and include in the request. Key in the map should be the header name and the value in the map should be the header value.

setUrl

public BaseRestEndpointProperties setUrl(String url)

The endpoint URL to contact and retrieve attributes.

Returns:

this.

setBasicAuthUsername

public BaseRestEndpointProperties setBasicAuthUsername(String basicAuthUsername)

If REST endpoint is protected via basic authentication, specify the username for authentication.

Returns:

this.

setBasicAuthPassword

public BaseRestEndpointProperties setBasicAuthPassword(String basicAuthPassword)

If REST endpoint is protected via basic authentication, specify the password for authentication.

Returns:

this.

setHeaders

public BaseRestEndpointProperties setHeaders(Map<String,String> headers)

Headers, defined as a Map, to include in the request when making the REST call. Will overwrite any header that CAS is pre-defined to send and include in the request. Key in the map should be the header name and the value in the map should be the header value.

Returns:

this.