APEREO CASDocumentation

Enterprise Authentication for All Earthlings and Beyond

Identity, Single Sign-On and Access Management
View on GitHub

Memcached Monitoring

Show in CAS Initializr Generate CAS Server WAR Overlay 


1
2
3
4
5



<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-memcached-monitor</artifactId>
    <version>${cas.version}</version>
</dependency>





1



implementation "org.apereo.cas:cas-server-support-memcached-monitor:${project.'cas.version'}"





1
2
3
4
5
6
7
8
9



dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-memcached-monitor"
}





1
2
3
4
5
6
7
8
9
10



dependencies {
    /*
        The following platform references are included automatically and are listed for reference only.

        implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
        implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
        
    */
    implementation "org.apereo.cas:cas-server-support-memcached-monitor"
}
:warning: Usage

This feature is deprecated and is scheduled to be removed in the future.

The following settings and properties are available from the CAS configuration catalog:

cas.monitor.memcached.serversComma-separated list of memcached servers.
localhost:11211
Required

Comma-separated list of memcached servers.

Type
String
Default
localhost:11211
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.daemonSet the daemon state of the IO thread (defaults to true).
true

Set the daemon state of the IO thread (defaults to true).

Type
Boolean
Default
true
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.failure-modeFailure mode.
Redistribute

Failure mode. Acceptable values are Redistribute,Retry,Cancel.

Type
String
Default
Redistribute
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.hash-algorithmHash algorithm.
FNV1_64_HASH

Hash algorithm. Acceptable values are NATIVE_HASH,CRC_HASH,FNV1_64_HASH,FNV1A_64_HASH,FNV1_32_HASH,FNV1A_32_HASH,KETAMA_HASH.

Type
String
Default
FNV1_64_HASH
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.kryo-auto-resetIf true, reset is called automatically after an entire object graph has been read or written.
false

If true, reset is called automatically after an entire object graph has been read or written. If false, reset must be called manually, which allows unregistered class names, references, and other information to span multiple object graphs.

Type
Boolean
Default
false
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.kryo-objects-by-referenceIf true, each appearance of an object in the graph after the first is stored as an integer ordinal.
false

If true, each appearance of an object in the graph after the first is stored as an integer ordinal. When set to true, MapReferenceResolver is used. This enables references to the same object and cyclic graphs to be serialized, but typically adds overhead of one byte per object.

Type
Boolean
Default
false
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.kryo-registration-requiredIf true, an exception is thrown when an unregistered class is encountered.
true

If true, an exception is thrown when an unregistered class is encountered.

If false, when an unregistered class is encountered, its fully qualified class name will be serialized and the default serializer for the class used to serialize the object. Subsequent appearances of the class within the same object graph are serialized as an int id. Registered classes are serialized as an int id, avoiding the overhead of serializing the class name, but have the drawback of needing to know the classes to be serialized up front. See ComponentSerializationPlan for help here.

Type
Boolean
Default
true
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.locator-typeLocator mode.
ARRAY_MOD

Locator mode. Acceptable values are ARRAY_MOD, CONSISTENT, VBUCKET.

Type
String
Default
ARRAY_MOD
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.max-idleSet the value for the maxTotal configuration attribute for pools created with this configuration instance.
8

Set the value for the maxTotal configuration attribute for pools created with this configuration instance.

Type
Integer
Default
8
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.max-reconnect-delaySet the maximum reconnect delay.
-1

Set the maximum reconnect delay.

Type
Long
Default
-1
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.max-totalSets the cap on the number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time.
20

Sets the cap on the number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time. Use a negative value for no limit.

Type
Integer
Default
20
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.min-idleGet the value for the minIdle configuration attribute for pools created with this configuration instance.
0

Get the value for the minIdle configuration attribute for pools created with this configuration instance.

Type
Integer
Default
0
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.op-timeoutSet the default operation timeout in milliseconds.
-1

Set the default operation timeout in milliseconds.

Type
Long
Default
-1
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.protocolProtocol.
TEXT

Protocol. Acceptable values are TEXT, BINARY.

Type
String
Default
TEXT
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.should-optimizeSet to false if the default operation optimization is not desirable.
false

Set to false if the default operation optimization is not desirable.

Type
Boolean
Default
false
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.shutdown-timeout-secondsThe number of seconds to wait for connections to finish before shutting down the client.
-1

The number of seconds to wait for connections to finish before shutting down the client.

Type
Long
Default
-1
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.timeout-exception-thresholdSet the maximum timeout exception threshold.
2

Set the maximum timeout exception threshold.

Type
Integer
Default
2
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.transcoderIndicate the transcoder type.
KRYO
Indicate the transcoder type. Available values are as follows:
  • KRYO: CAS transcoder implementation based on Kryo fast serialization framework suited for efficient serialization of tickets. Provides pooling mechanisms as well as control over object registration and sequences.
  • SERIAL: Kryo native transcoder that serializes and compresses objects.
  • WHALIN: Transcoder that provides compatibility with Greg Whalin's memcached client.
  • WHALINV1: Handles old whalin encoding: data type is in the first byte of the value.
Type
BaseMemcachedProperties.TranscoderTypes
Default
KRYO
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.transcoder-compression-thresholdFor transcoders other than kryo, determines the compression threshold.
16384

For transcoders other than kryo, determines the compression threshold. Does not apply to kryo.

Type
Integer
Default
16384
Defined by
MemcachedMonitorProperties
cas.monitor.memcached.use-nagle-algorithmSet to true if you'd like to enable the Nagle algorithm.
false

Set to true if you'd like to enable the Nagle algorithm.

Type
Boolean
Default
false
Defined by
MemcachedMonitorProperties

Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.

Notes on configuration

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

:information_source: Note

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

The actual memcached implementation may be supported via one of the following options, expected to be defined in the overlay.

health
Third-party endpoint2 operationsExposed by default
1

Turn the endpoint on and expose it over the web. One entry covers every operation. By default only info, health and status are exposed.



1
2



management.endpoint.health.access=UNRESTRICTED
management.endpoints.web.exposure.include=health

Endpoints may be mapped to other paths. For example, to serve health at healthcheck:



1



management.endpoints.web.path-mapping.health=healthcheck

Spymemcached

Enable support via the spymemcached library.

Support is enabled by including the following dependency in the WAR overlay:

Show in CAS Initializr Generate CAS Server WAR Overlay 


1
2
3
4
5



<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-memcached-spy</artifactId>
    <version>${cas.version}</version>
</dependency>





1



implementation "org.apereo.cas:cas-server-support-memcached-spy:${project.'cas.version'}"





1
2
3
4
5
6
7
8
9



dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-memcached-spy"
}





1
2
3
4
5
6
7
8
9
10



dependencies {
    /*
        The following platform references are included automatically and are listed for reference only.

        implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
        implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
        
    */
    implementation "org.apereo.cas:cas-server-support-memcached-spy"
}

AWS ElastiCache

For clusters running the Memcached engine, ElastiCache supports Auto Discovery—the ability for client programs to automatically identify all of the nodes in a cache cluster, and to initiate and maintain connections to all of these nodes.

Support is enabled by including the following dependency in the WAR overlay:

Show in CAS Initializr Generate CAS Server WAR Overlay 


1
2
3
4
5



<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-memcached-aws-elasticache</artifactId>
    <version>${cas.version}</version>
</dependency>





1



implementation "org.apereo.cas:cas-server-support-memcached-aws-elasticache:${project.'cas.version'}"





1
2
3
4
5
6
7
8
9



dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-memcached-aws-elasticache"
}





1
2
3
4
5
6
7
8
9
10



dependencies {
    /*
        The following platform references are included automatically and are listed for reference only.

        implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
        implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
        
    */
    implementation "org.apereo.cas:cas-server-support-memcached-aws-elasticache"
}