WildFly 35 Model Reference

The configuration of a protocol within a protocol stack.

Provided capabilities(1)

Name	Dynamic	Other provider points
org.wildfly.clustering.jgroups.protocol	true	/subsystem=jgroups/channel=/fork=/protocol=SYM_ENCRYPT /subsystem=jgroups/stack=/protocol=org.jgroups.protocols.TCPGOSSIP /subsystem=jgroups/stack=/protocol=org.jgroups.protocols.ASYM_ENCRYPT /subsystem=jgroups/stack=/protocol=JDBC_PING /subsystem=jgroups/channel=/fork=/protocol=ASYM_ENCRYPT /subsystem=jgroups/stack=/protocol=TCPPING /subsystem=jgroups/channel=/fork=/protocol=FD /subsystem=jgroups/channel=/fork=/protocol=TCPPING /subsystem=jgroups/channel=/fork=/protocol=MPING /subsystem=jgroups/stack=/protocol=org.jgroups.protocols.AUTH /subsystem=jgroups/channel=/fork=/protocol=FD_SOCK /subsystem=jgroups/stack=/protocol=FD_SOCK /subsystem=jgroups/stack=/protocol=MPING /subsystem=jgroups/channel=/fork=/protocol=FD_SOCK2 /subsystem=jgroups/channel=/fork=/protocol=org.jgroups.protocols.TCPGOSSIP /subsystem=jgroups/stack=/protocol=* /subsystem=jgroups/channel=/fork=/protocol=AUTH /subsystem=jgroups/channel=/fork=/protocol=org.jgroups.protocols.AUTH /subsystem=jgroups/stack=/protocol=FD_SOCK2 /subsystem=jgroups/stack=/protocol=org.jgroups.protocols.SYM_ENCRYPT /subsystem=jgroups/channel=/fork=/protocol=* /subsystem=jgroups/stack=/protocol=TCPGOSSIP /subsystem=jgroups/channel=/fork=/protocol=org.jgroups.protocols.SYM_ENCRYPT /subsystem=jgroups/channel=/fork=/protocol=org.jgroups.protocols.TCPPING /subsystem=jgroups/channel=/fork=/protocol=org.jgroups.protocols.ASYM_ENCRYPT /subsystem=jgroups/stack=/protocol=org.jgroups.protocols.TCPPING /subsystem=jgroups/stack=/protocol=ASYM_ENCRYPT /subsystem=jgroups/stack=/protocol=AUTH /subsystem=jgroups/stack=/protocol=FD /subsystem=jgroups/channel=/fork=/protocol=JDBC_PING /subsystem=jgroups/channel=/fork=/protocol=TCPGOSSIP /subsystem=jgroups/channel=/fork=/protocol=org.jgroups.protocols.JDBC_PING /subsystem=jgroups/stack=/protocol=org.jgroups.protocols.JDBC_PING

Attributes (6)

key-alias The alias of the encryption key from the specified key store

Attribute	Value
Type	STRING
Nillable	false
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services
Stability	default

key-credential-reference The credentials required to obtain the encryption key from the key store.

Attribute	Value
Type	OBJECT
Nillable	false
Expressions Allowed	false
Storage	configuration
Access Type	read-write
Restart Required	no-services
Stability	default

key-store A reference to a key store containing the encryption key

Attribute	Value
Capability reference	/subsystem=elytron/key-store=* /subsystem=elytron/ldap-key-store=* /subsystem=elytron/filtering-key-store=*
Type	STRING
Nillable	false
Expressions Allowed	false
Storage	configuration
Access Type	read-write
Restart Required	resource-services
Stability	default

module The module with which to resolve the protocol type.

Attribute	Value
Default Value	org.jgroups
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services
Stability	default

properties The properties of this protocol.

Attribute	Value
Type	OBJECT
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services
Stability	default

statistics-enabled Indicates whether or not this protocol will collect statistics overriding stack configuration.

Attribute	Value
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services
Stability	default

Operations (11)

add Add a protocol to a protocol stack.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
add-index	INT	false	false		If specified inserts the protocol at the given (zero-based) index. If null it will add at the end.
key-alias	STRING	true	true		The alias of the encryption key from the specified key store
key-credential-reference	OBJECT	true	false		The credentials required to obtain the encryption key from the key store.
key-store	STRING	true	false		A reference to a key store containing the encryption key
module	STRING	false	true	org.jgroups	The module with which to resolve the protocol type.
properties	OBJECT	false	true		The properties of this protocol.
statistics-enabled	BOOLEAN	false	true		Indicates whether or not this protocol will collect statistics overriding stack configuration.

list-add Add entry to list attribute

Request Parameter	Type	Required	Expressions Allowed	Description
name	STRING	true	false	Name of list attribute to add entry to
value	STRING	false	false	Value to add to list
index	INT	false	false	Optional 0 based index where to insert value to

list-clear Clear all entries from list attribute

Request Parameter Type Required Expressions Allowed Default value Description

name STRING true false Name of list attribute
list-get Get entry from list attribute

Request Parameter Type Required Expressions Allowed Default value Description

name STRING true false Name of list attribute

index INT false false Index entry to get

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		Name of list attribute

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		Name of list attribute
index	INT	false	false		Index entry to get

list-remove Remove entry from list attribute

Request Parameter	Type	Required	Expressions Allowed	Description
name	STRING	true	false	Name of list attribute to remove entry from
value	STRING	false	false	Value remove from list
index	INT	false	false	Optional 0 based index to tell what element to remove

map-clear Clear all entries from map attribute

Request Parameter Type Required Expressions Allowed Default value Description

name STRING true false Name of list attribute
map-get Get entry from map attribute

Request Parameter Type Required Expressions Allowed Default value Description

name STRING true false Name of map attribute

key STRING true false Key of entry to return

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		Name of list attribute

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		Name of map attribute
key	STRING	true	false		Key of entry to return

map-put Add entry to map attribute

Request Parameter	Type	Required	Expressions Allowed	Description
name	STRING	true	false	Name of map attribute to add entry to
key	STRING	true	false	Key under which value will be added
value	STRING	false	false	Value to be added

map-remove Remove entry from map attribute

Request Parameter Type Required Expressions Allowed Default value Description

name STRING true false Name of map attribute

key STRING true false Key of entry to remove
remove Remove a protocol from a protocol stack.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		Name of map attribute
key	STRING	true	false		Key of entry to remove

write-attribute Sets the value of an attribute for the selected resource

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		The name of the attribute to set the value for under the selected resource
value	STRING	false	false		The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.