Management API Reference for setting=crawler-session-management

Configures special session handling for crawler bots

Attributes (2)

session-timeout - The session timeout for sessions that are owned by crawlers

Type	INT
Unit	SECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The session timeout for sessions that are owned by crawlers", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "SECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

user-agents - Regular expression that is used to match the user agent of a crawler

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Regular expression that is used to match the user agent of a crawler", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (2)

add - Adds special session handling for crawler bots

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
session-timeout	INT	false	true		The session timeout for sessions that are owned by crawlers
user-agents	STRING	false	true		Regular expression that is used to match the user agent of a crawler

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds special session handling for crawler bots",
    "request-properties" : {
        "session-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The session timeout for sessions that are owned by crawlers",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "unit" : "SECONDS",
            "stability" : "default"
        },
        "user-agents" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Regular expression that is used to match the user agent of a crawler",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes special session handling for crawler bots

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes special session handling for crawler bots",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.undertow.servlet-container.setting.crawler-session-management

        
<feature spec="subsystem.undertow.servlet-container.setting.crawler-session-management">
  <param name="servlet-container" value="{resource name}"/>
  <param name="session-timeout" value="{value}"/>
  <param name="user-agents" value="{value}"/>
<feature/>