hydra

Class SecurityPrms

java.lang.Object

hydra.BasePrms

hydra.SecurityPrms

public class SecurityPrms
extends BasePrms

A class used to store keys for configuration settings related to security. The settings are used to create instances of SecurityDescription, and can be referenced from a gemfire configuration via GemFirePrms.securityName.

The number of description instances is gated by names. For other parameters, if fewer values than names are given, the remaining instances will use the last value in the list. See $JTESTS/hydra/hydra.txt for more details.

Unused parameters default to null, except where noted. This uses the product default, except where noted.

Values and fields of a parameter can be set to BasePrms.DEFAULT, except where noted. This uses the product default, except where noted.

Values and fields can be set to BasePrms.NONE where noted, with the documented effect.

Values and fields of a parameter can use oneof, range, or robing except where noted, but each description created will use a fixed value chosen at test configuration time. Use as a task attribute is illegal.

Field Summary

Fields

Modifier and Type	Field and Description
static Long	clientAccessor (String(s)) Method creating the client implementation of the interface AccessControl for each security configuration, passed in as the distributed system property SECURITY_CLIENT_ACCESSOR_NAME.
static Long	clientAccessorPP (String(s)) Method creating the client implementation of the interface AccessControl for each security configuration, passed in as the distributed system property SECURITY_CLIENT_ACCESSOR_PP_NAME.
static Long	clientAuthenticator (String(s)) Method creating the client implementation of the interface Authenticator for each security configuration, passed in as the distributed system property SECURITY_CLIENT_AUTHENTICATOR_NAME.
static Long	clientAuthInit (String(s)) Method creating the client implementation of the interface AuthInitialize for each security configuration, passed in as the distributed system property SECURITY_CLIENT_AUTH_INIT_NAME.
static Long	clientExtraProperties (String(s)) Class holding client extra security- properties for clientAuthInit for each security configuration.
static Long	logLevel (String(s)) Log level for the security log file for each security configuration, passed in as the distributed system property SECURITY_LOG_LEVEL_NAME.
static Long	names (String(s)) Logical names of the security descriptions.
static Long	peerAuthenticator (String(s)) Method creating peer implementation of the interface Authenticator for each security configuration, passed in as the distributed system property SECURITY_PEER_AUTHENTICATOR_NAME.Can be specified as BasePrms.NONE, which uses the product default.
static Long	peerAuthInit (String(s)) Method creating peer implementation of the interface AuthInitialize for each security configuration, passed in as the distributed system property SECURITY_PEER_AUTH_INIT_NAME.
static Long	peerExtraProperties (String(s)) Class holding peer extra security- properties for peerAuthInit for each security configuration.
static Long	peerVerifymemberTimeout (int(s)) Peer verifymember timeout for each security configuration, in milliseconds, passed in as the distributed system property SECURITY_PEER_VERIFYMEMBER_TIMEOUT_NAME.

Fields inherited from class hydra.BasePrms

DASH, DEFAULT, NONE

Constructor Summary

Constructors

Constructor and Description
SecurityPrms()

Method Summary

Modifier and Type	Method and Description
static void	main(String[] args)

Methods inherited from class hydra.BasePrms

dumpKeys, keyForName, nameForKey, setValues, tab, tasktab

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

names

public static Long names

(String(s)) Logical names of the security descriptions. Each name must be unique. Defaults to null. Not for use with oneof, range, or robing.

clientAccessor

public static Long clientAccessor

(String(s)) Method creating the client implementation of the interface AccessControl for each security configuration, passed in as the distributed system property SECURITY_CLIENT_ACCESSOR_NAME. Can be specified as BasePrms.NONE, which uses the product default.

clientAccessorPP

public static Long clientAccessorPP

(String(s)) Method creating the client implementation of the interface AccessControl for each security configuration, passed in as the distributed system property SECURITY_CLIENT_ACCESSOR_PP_NAME. Can be specified as BasePrms.NONE, which uses the product default.

clientAuthInit

public static Long clientAuthInit

(String(s)) Method creating the client implementation of the interface AuthInitialize for each security configuration, passed in as the distributed system property SECURITY_CLIENT_AUTH_INIT_NAME. Can be specified as BasePrms.NONE, which uses the product default.

clientAuthenticator

public static Long clientAuthenticator

(String(s)) Method creating the client implementation of the interface Authenticator for each security configuration, passed in as the distributed system property SECURITY_CLIENT_AUTHENTICATOR_NAME. Can be specified as BasePrms.NONE, which uses the product default.

clientExtraProperties

public static Long clientExtraProperties

(String(s)) Class holding client extra security- properties for clientAuthInit for each security configuration. Can be specified as BasePrms.NONE (default).

The extra properties are generated from all fields that are declared public static Long in the specified class. The required security- prefix is automatically added by hydra and must not be included in the field names. Hydra changes upper case letters to lower case preceded by a hyphen, to follow the GemFire property naming convention.

Default values for a property can be specified as public static final String for the field name (in upper case) prefixed with DEFAULT_, with words separated by an underscore.

For example:

     public static final String DEFAULT_USERNAME = "DefaultUser";
     public static Long username; // maps to "security-username"
     public static final String DEFAULT_PASSWORD_FILE = "$PWD/password.txt";
     public static Long passwordFile; // maps to "security-password-file"
   

Parameter values are treated much like other non-hydra parameters. They are read by the hydra client VM rather than the master. Use of oneof, range, or robing will cause each VM to obtain a possibly different value. Values can be overridden in task attributes. Note also that a VM might obtain a different value on restart.

If a parameter is left unset, the property value will default to the default given in the parameter class, if any, else to the the empty string.

Extra properties and their values are accessible to test code via SecurityDescription.getClientExtraProperties().

logLevel

public static Long logLevel

(String(s)) Log level for the security log file for each security configuration, passed in as the distributed system property SECURITY_LOG_LEVEL_NAME. Hydra automatically creates a security log file with the name security.log in the system directory.

peerAuthInit

public static Long peerAuthInit

(String(s)) Method creating peer implementation of the interface AuthInitialize for each security configuration, passed in as the distributed system property SECURITY_PEER_AUTH_INIT_NAME. Can be specified as BasePrms.NONE, which uses the product default.

peerAuthenticator

public static Long peerAuthenticator

(String(s)) Method creating peer implementation of the interface Authenticator for each security configuration, passed in as the distributed system property SECURITY_PEER_AUTHENTICATOR_NAME.Can be specified as BasePrms.NONE, which uses the product default.

peerExtraProperties

public static Long peerExtraProperties

(String(s)) Class holding peer extra security- properties for peerAuthInit for each security configuration. Can be specified as BasePrms.NONE (default).

The extra properties are generated from all fields that are declared public static Long in the specified class. The required security- prefix is automatically added by hydra and must not be included in the field names. Hydra changes upper case letters to lower case preceded by a hyphen, to follow the GemFire property naming convention.

Default values for a property can be specified as public static final String for the field name (in upper case) prefixed with DEFAULT_, with words separated by an underscore.

For example:

     public static final String DEFAULT_USERNAME = "DefaultUser";
     public static Long username; // maps to "security-username"
     public static final String DEFAULT_PASSWORD_FILE = "$PWD/password.txt";
     public static Long passwordFile; // maps to "security-password-file"
   

Parameter values are treated much like other non-hydra parameters. They are read by the hydra client VM rather than the master. Use of oneof, range, or robing will cause each VM to obtain a possibly different value. Values can be overridden in task attributes. Note also that a VM might obtain a different value on restart.

If a parameter is left unset, the property value will default to the default given in the parameter class, if any, else to the the empty string.

Extra properties and their values are accessible to test code via SecurityDescription.getPeerExtraProperties().

peerVerifymemberTimeout

public static Long peerVerifymemberTimeout

(int(s)) Peer verifymember timeout for each security configuration, in milliseconds, passed in as the distributed system property SECURITY_PEER_VERIFYMEMBER_TIMEOUT_NAME.

Constructor Detail

SecurityPrms

public SecurityPrms()

Method Detail

main

public static void main(String[] args)