Management API Reference for jsse=classic

JSSE configuration. Configures attributes for keystores that can be used for setting up SSL.

Deprecated Since 1.3.0

The Security subsystem is deprecated and may be removed, significantly revised, or limited to managed domain legacy server use in future versions.

Attributes (11)

additional-properties - Additional properties that may be necessary to configure JSSE.

Type	OBJECT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Additional properties that may be necessary to configure JSSE.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

cipher-suites - Comma separated list of cipher suites to enable on SSLSockets.

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?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Comma separated list of cipher suites to enable on SSLSockets.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

client-alias - Preferred alias to use when the KeyManager chooses the client alias.

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?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Preferred alias to use when the KeyManager chooses the client alias.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

client-auth - Boolean attribute to indicate if client's certificates should also be authenticated on the server side.

Type	BOOLEAN
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Boolean attribute to indicate if client's certificates should also be authenticated on the server side.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

key-manager - JSEE Key Manager factory

Type	OBJECT
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "JSEE Key Manager factory", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "algorithm" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Algorithm to use when creating the KeyManagerFactory.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "provider" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Provider class name to use when creating the KeyManagerFactory.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

keystore - Configures a JSSE key store

Type	OBJECT
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Configures a JSSE key store", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "password" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Sets the password of the keystore. Either this or 'truststore-password' must be present otherwise the security domain will be useless.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Type of the keystore. If not set, type defaults to 'JKS'.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "url" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "URL of the keystore.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "provider" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Provider class name to use when creating the KeyStore.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "provider-argument" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "String argument to pass to the keystore Provider constructor when instantiating it.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

protocols - Comma separated list of protocols to enable on SSLSockets.

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?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Comma separated list of protocols to enable on SSLSockets.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

server-alias - Preferred alias to use when the KeyManager chooses the server alias.

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?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Preferred alias to use when the KeyManager chooses the server alias.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

service-auth-token - Token to retrieve PrivateKeys from the KeyStore.

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?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Token to retrieve PrivateKeys from the KeyStore.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

trust-manager - JSEE Trust Manager factory

Type	OBJECT
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "JSEE Trust Manager factory", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "algorithm" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Algorithm to use when creating the TrustManagerFactory.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "provider" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Provider class name to use when creating the TrustManagerFactory.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

truststore - Configures a JSSE trust store

Type	OBJECT
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Configures a JSSE trust store", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "password" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Sets the password of the truststore. Either this or 'keystore-password' must be present otherwise the security domain will be useless.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Type of the truststore. If not set, type defaults to 'JKS'.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "url" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "URL of the truststore.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "provider" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Provider class name to use when creating the truststore.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "provider-argument" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "String argument to pass to the truststore Provider constructor when instantiating it.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

Operations (2)

add - Adds a JSSE configuration

Request Parameter	Type	Required	Expressions Allowed	Description
additional-properties	OBJECT	false	true	Additional properties that may be necessary to configure JSSE.
cipher-suites	STRING	false	true	Comma separated list of cipher suites to enable on SSLSockets.
client-alias	STRING	false	true	Preferred alias to use when the KeyManager chooses the client alias.
client-auth	BOOLEAN	false	true	Boolean attribute to indicate if client's certificates should also be authenticated on the server side.
key-manager	OBJECT	false	false	JSEE Key Manager factory
keystore	OBJECT	false	false	Configures a JSSE key store
protocols	STRING	false	true	Comma separated list of protocols to enable on SSLSockets.
server-alias	STRING	false	true	Preferred alias to use when the KeyManager chooses the server alias.
service-auth-token	STRING	false	true	Token to retrieve PrivateKeys from the KeyStore.
trust-manager	OBJECT	false	false	JSEE Trust Manager factory
truststore	OBJECT	false	false	Configures a JSSE trust store

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a JSSE configuration",
    "request-properties" : {
        "additional-properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Additional properties that may be necessary to configure JSSE.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "cipher-suites" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Comma separated list of cipher suites to enable on SSLSockets.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "client-alias" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Preferred alias to use when the KeyManager chooses the client alias.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "client-auth" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Boolean attribute to indicate if client's certificates should also be authenticated on the server side.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "key-manager" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "JSEE Key Manager factory",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "algorithm" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Algorithm to use when creating the KeyManagerFactory.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "provider" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Provider class name to use when creating the KeyManagerFactory.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "keystore" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Configures a JSSE key store",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "password" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Sets the password of the keystore. Either this or 'truststore-password' must be present otherwise the security domain will be useless.",
                    "expressions-allowed" : true,
                    "required" : true,
                    "nillable" : false,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "type" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Type of the keystore. If not set, type defaults to 'JKS'.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "url" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "URL of the keystore.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "provider" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Provider class name to use when creating the KeyStore.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "provider-argument" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "String argument to pass to the keystore Provider constructor when instantiating it.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "protocols" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Comma separated list of protocols to enable on SSLSockets.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "server-alias" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Preferred alias to use when the KeyManager chooses the server alias.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "service-auth-token" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Token to retrieve PrivateKeys from the KeyStore.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "trust-manager" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "JSEE Trust Manager factory",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "algorithm" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Algorithm to use when creating the TrustManagerFactory.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "provider" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Provider class name to use when creating the TrustManagerFactory.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "truststore" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Configures a JSSE trust store",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "password" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Sets the password of the truststore. Either this or 'keystore-password' must be present otherwise the security domain will be useless.",
                    "expressions-allowed" : true,
                    "required" : true,
                    "nillable" : false,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "type" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Type of the truststore. If not set, type defaults to 'JKS'.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "url" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "URL of the truststore.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "provider" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Provider class name to use when creating the truststore.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "provider-argument" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "String argument to pass to the truststore Provider constructor when instantiating it.",
                    "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 a JSSE configuration.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes a JSSE configuration.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

Galleon Features

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

subsystem.security.security-domain.jsse.classic

        
<feature spec="subsystem.security.security-domain.jsse.classic">
  <param name="security-domain" value="{resource name}"/>
  <param name="additional-properties" value="{value}"/>
  <param name="cipher-suites" value="{value}"/>
  <param name="client-alias" value="{value}"/>
  <param name="client-auth" value="{value}"/>
  <param name="key-manager" value="{value}"/>
  <param name="keystore" value="{value}"/>
  <param name="protocols" value="{value}"/>
  <param name="server-alias" value="{value}"/>
  <param name="service-auth-token" value="{value}"/>
  <param name="trust-manager" value="{value}"/>
  <param name="truststore" value="{value}"/>
<feature/>