SecurityConstants (IBM WebSphere eXtreme Scale API Specification)

Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

IBM WebSphere^TM eXtreme Scale, Release 8.6
API Specification

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.websphere.objectgrid.security
Class SecurityConstants

java.lang.Object
  com.ibm.websphere.objectgrid.security.SecurityConstants

public class SecurityConstants
extends Object
extends Object

This class contains the constants used for security configuration.

Since:: WAS XD 6.0, XC10

Field Summary
`static int`	`ACCESS_BY_CREATOR_ONLY_COMPLEMENT` The access by creator only authorization is enabled to complement the ObjectGrid map authorization.
`static int`	`ACCESS_BY_CREATOR_ONLY_DISABLED` The access by creator only authorization is disabled.
`static int`	`ACCESS_BY_CREATOR_ONLY_SUPERSEDE` The access by creator only authorization is enabled to supersede the ObjectGrid map authorization.
`static int`	`AUTHORIZATION_MECHANISM_CUSTOM` Constant representing custom authorization
`static int`	`AUTHORIZATION_MECHANISM_JAAS` Constant representing JAAS authorization
`static int`	`CLIENT_CERTIFICATE_AUTHENTICATION_NEVER` Constant indicating client certificate authentication is not supported.
`static int`	`CLIENT_CERTIFICATE_AUTHENTICATION_REQUIRED` Constant indicating client certificate authentication is required.
`static int`	`CLIENT_CERTIFICATE_AUTHENTICATION_SUPPORTED` Constant indicating client certificate authentication is supported.
`static int`	`CREDENTIAL_AUTHENTICATION_NEVER` Constant indicating credential authentication is not supported.
`static int`	`CREDENTIAL_AUTHENTICATION_REQUIRED` Constant indicating credential authentication is required.
`static int`	`CREDENTIAL_AUTHENTICATION_SUPPORTED` Constant indicating credential authentication is supported.
`static String`	`NEVER_STRING` String representation for value Never indicating an option is not supported.
`static String`	`NEW_SECURE_TOKEN_MANAGER_STRING` String representation for "autoSecret" type of the secure token manager.
`static String`	`REQUIRED_STRING` String representation for value Required indicating an option is required.
`static String`	`SECURE_TOKEN_MANAGER_CUSTOM_STRING` String representation for "custom" type of the secure token manager.
`static String`	`SECURE_TOKEN_MANAGER_DEFAULT_STRING` String representation for "default" type of the secure token manager.
`static String`	`SECURE_TOKEN_MANAGER_NONE_STRING` String representation for "none" type of the secure token manager.
`static int`	`SSL_REQUIRED` Constant indicating SSL transport is required.
`static String`	`SSL_REQUIRED_STRING` String representation for value SSL-Required indicating SSL transport type is required.
`static int`	`SSL_SUPPORTED` Constant indicating SSL transport is supported.
`static String`	`SSL_SUPPORTED_STRING` String representation for value SSL-Supported indicating SSL transport type is supported.
`static String`	`SUPPORTED_STRING` String representation for value Supported indicating an option is supported.
`static int`	`TCP_IP` Constant indicating TCP/IP is the only supported transport.
`static String`	`TCPIP_STRING` String representation for value TCP/IP indicating a transport type of TCP/IP is used.

Constructor Summary
`SecurityConstants()`

Method Summary

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

AUTHORIZATION_MECHANISM_JAAS

public static final int AUTHORIZATION_MECHANISM_JAAS

Constant representing JAAS authorization

See Also:: ObjectGrid.setAuthorizationMechanism(int), Constant Field Values

AUTHORIZATION_MECHANISM_CUSTOM

public static final int AUTHORIZATION_MECHANISM_CUSTOM

Constant representing custom authorization

See Also:: ObjectGrid.setAuthorizationMechanism(int), Constant Field Values

TCP_IP

public static final int TCP_IP

Constant indicating TCP/IP is the only supported transport.

If the client's transport type is set to this value, TCP/IP is the only supported transport type. If the server requires SSL, the client won't be able to connect to the server.

Since:: WAS XD 6.0.1
See Also:: ClientSecurityConfiguration.setTransportType(int), Constant Field Values

SSL_SUPPORTED

public static final int SSL_SUPPORTED

Constant indicating SSL transport is supported.

If the client's transport type is set to this value, the client supports both TCP/IP and SSL. SSL will be used if both sides side supports SSL. Otherwise, TCP/IP will be used.

Since:: WAS XD 6.0.1
See Also:: ClientSecurityConfiguration.setTransportType(int), Constant Field Values

SSL_REQUIRED

public static final int SSL_REQUIRED

Constant indicating SSL transport is required.

If the client's transport type is set to this value, SSL is the only supported transport type. If the server requires TCP/IP, the client won't be able to connect to the server.

Since:: WAS XD 6.0.1
See Also:: ClientSecurityConfiguration.setTransportType(int), Constant Field Values

CREDENTIAL_AUTHENTICATION_NEVER

public static final int CREDENTIAL_AUTHENTICATION_NEVER

Constant indicating credential authentication is not supported.

If the credential authentication type is set to this value, no credential authentication will be enforced. If the server requires credential authentication, the client won't be able to connect to the server.

Since:: WAS XD 6.0.1
See Also:: ClientSecurityConfiguration.setCredentialAuthenticationType(int), Constant Field Values

CREDENTIAL_AUTHENTICATION_SUPPORTED

public static final int CREDENTIAL_AUTHENTICATION_SUPPORTED

Constant indicating credential authentication is supported.

If the credential authentication type is set to this value, credential authentication will be enforced if and only if both client and server support credential authentication.

Since:: WAS XD 6.0.1
See Also:: ClientSecurityConfiguration.setCredentialAuthenticationType(int), Constant Field Values

CREDENTIAL_AUTHENTICATION_REQUIRED

public static final int CREDENTIAL_AUTHENTICATION_REQUIRED

Constant indicating credential authentication is required.

If the credential authentication type is set to this value, credential authentication will be enforced. If the server doesn't support credential authentication, the client won't be able to connect to the server.

Since:: WAS XD 6.0.1
See Also:: ClientSecurityConfiguration.setCredentialAuthenticationType(int), Constant Field Values

CLIENT_CERTIFICATE_AUTHENTICATION_NEVER

public static final int CLIENT_CERTIFICATE_AUTHENTICATION_NEVER

Constant indicating client certificate authentication is not supported.

If the client certificate authentication type is set to this value, no client certificate authentication will be enforced. If the server doesn't support client certificate authentication, the client won't be able to connect to the server.

Since:: WAS XD 6.0.1
See Also:: ClientSecurityConfiguration.setClientCertificateAuthentication(int), Constant Field Values

CLIENT_CERTIFICATE_AUTHENTICATION_SUPPORTED

public static final int CLIENT_CERTIFICATE_AUTHENTICATION_SUPPORTED

Constant indicating client certificate authentication is supported.

If the client certificate authentication type is set to this value, client certificate authentication will be enforced when the following conditions are met:

both client and server supports or requires client certificate authentication;
the transport protocol to use is SSL;
no credential authentication will be done.

Since:: WAS XD 6.0.1
See Also:: ClientSecurityConfiguration.setClientCertificateAuthentication(int), Constant Field Values

CLIENT_CERTIFICATE_AUTHENTICATION_REQUIRED

public static final int CLIENT_CERTIFICATE_AUTHENTICATION_REQUIRED

Constant indicating client certificate authentication is required. If the client certificate authentication type is set to this value, client certificate authentication will be enforced if the following conditions are met:

both client and server supports or requires client certificate authentication;
the transport protocol to use is SSL;
no credential authentication will be done.

If the server doesn't support client certificate authentication and no credential authentication will be done, the client won't be able to connect to the server.

Since:: WAS XD 6.0.1
See Also:: ClientSecurityConfiguration.setClientCertificateAuthentication(int), Constant Field Values

NEVER_STRING

public static final String NEVER_STRING

String representation for value Never indicating an option is not supported.

This value is used as a value to configuration settings in a Properties object or property file for client and server security configurations. It is used for the configuration settings "clientCertificateAuthentication" and "credentialAuthentication".

Since:: WAS XD 6.0.1
See Also:: CLIENT_CERTIFICATE_AUTHENTICATION_NEVER, CREDENTIAL_AUTHENTICATION_NEVER, Constant Field Values

SUPPORTED_STRING

public static final String SUPPORTED_STRING

String representation for value Supported indicating an option is supported.

Since:: WAS XD 6.0.1
See Also:: CLIENT_CERTIFICATE_AUTHENTICATION_SUPPORTED, CREDENTIAL_AUTHENTICATION_SUPPORTED, Constant Field Values

REQUIRED_STRING

public static final String REQUIRED_STRING

String representation for value Required indicating an option is required.

Since:: WAS XD 6.0.1
See Also:: CLIENT_CERTIFICATE_AUTHENTICATION_REQUIRED, CREDENTIAL_AUTHENTICATION_REQUIRED, Constant Field Values

TCPIP_STRING

public static final String TCPIP_STRING

String representation for value TCP/IP indicating a transport type of TCP/IP is used.

Since:: WAS XD 6.0.1
See Also:: TCP_IP, Constant Field Values

SSL_SUPPORTED_STRING

public static final String SSL_SUPPORTED_STRING

String representation for value SSL-Supported indicating SSL transport type is supported.

Since:: WAS XD 6.0.1
See Also:: SSL_SUPPORTED, Constant Field Values

SSL_REQUIRED_STRING

public static final String SSL_REQUIRED_STRING

String representation for value SSL-Required indicating SSL transport type is required.

Since:: WAS XD 6.0.1
See Also:: SSL_REQUIRED, Constant Field Values

SECURE_TOKEN_MANAGER_NONE_STRING

public static final String SECURE_TOKEN_MANAGER_NONE_STRING

String representation for "none" type of the secure token manager.

This value is used in a property file for server security configurations. It is used for the configuration setting "secureTokenManagerType".

Since:: WAS XD 6.0.1
See Also:: Constant Field Values

SECURE_TOKEN_MANAGER_DEFAULT_STRING

public static final String SECURE_TOKEN_MANAGER_DEFAULT_STRING

String representation for "default" type of the secure token manager.

This value is used in a property file for server security configurations. It is used for the configuration setting "secureTokenManagerType". This value requires users to provide the secure token key store settings.

Since:: WAS XD 6.0.1
See Also:: Constant Field Values

SECURE_TOKEN_MANAGER_CUSTOM_STRING

public static final String SECURE_TOKEN_MANAGER_CUSTOM_STRING

String representation for "custom" type of the secure token manager.

Since:: WAS XD 6.0.1
See Also:: Constant Field Values

NEW_SECURE_TOKEN_MANAGER_STRING

public static final String NEW_SECURE_TOKEN_MANAGER_STRING

String representation for "autoSecret" type of the secure token manager.

This value is used in a property file for server security configurations. It is used for the configuration setting "secureTokenManagerType". This value does not require users to provide other settings.

Since:: WebSphere eXtremeScale 8.6
See Also:: Constant Field Values

ACCESS_BY_CREATOR_ONLY_DISABLED

public static final int ACCESS_BY_CREATOR_ONLY_DISABLED

The access by creator only authorization is disabled.

The access by creator authorization ensures that only the user (represented by the Principals associated with it), who inserts the data entry into the map, can access the data. Here the access means read, update, invalidate, and remove.

Since:: WAS XD 6.1 FIX3
See Also:: Constant Field Values

ACCESS_BY_CREATOR_ONLY_COMPLEMENT

public static final int ACCESS_BY_CREATOR_ONLY_COMPLEMENT

The access by creator only authorization is enabled to complement the ObjectGrid map authorization.

If this constant is used, both map authorization and access by creator only authorization will take effect. Therefore, you can further limit the operations to the data entries. For example, you can restrict the creator from invalidating the data entries.

Since:: WAS XD 6.1 FIX3
See Also:: Constant Field Values

ACCESS_BY_CREATOR_ONLY_SUPERSEDE

public static final int ACCESS_BY_CREATOR_ONLY_SUPERSEDE

The access by creator only authorization is enabled to supersede the ObjectGrid map authorization.

If this constant is used, the access by creator only authorization will supersede the map authorization; no map authorization will be done.

Since:: WAS XD 6.1 FIX3
See Also:: Constant Field Values

Constructor Detail