*** This class provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.connection
Class MetadataClusterUtil

com.sas.services.connection.MetadataClusterUtil

@SASScope(value="ALL")
@BinaryCompatibilityOnly
public final class MetadataClusterUtil

Utility class to create SAS metadata server cluster definitions. Cluster nodes may be specified by the caller or retrieved from the system application properties table.

Since:

9.4

Field Summary

static java.lang.String	OPTION_ENCRYPT Encrypt all data when communicating with the cluster.
static java.lang.String	OPTION_SSPI_PACKAGE Specify SSPI security package.
static java.lang.String	OPTION_SSPI_PACKAGE_LIST Specify SSPI security package list.
static java.lang.String	OPTION_SSPI_SPN Specify SSPI service principal name.
static java.lang.String	OPTION_USE_CLUSTER_PROPERTIES Enable or disable replacement of host/port parameters with the cluster definition found in the application properties table.

Constructor Summary

MetadataClusterUtil()

Method Summary

static Cluster	createCluster(HostPortSet clusterNodes, java.util.Map<java.lang.String,java.lang.String> options) Convenience method for creating a metadata cluster.
static Cluster	createCluster(java.lang.String hosts, java.lang.String ports, java.util.Map<java.lang.String,java.lang.String> options) Convenience method for creating a metadata cluster.
static HostPortSet	getClusterHostPortSet() Returns host/port collection for metadata server cluster as defined in the application properties table.

Field Detail

OPTION_ENCRYPT

public static final java.lang.String OPTION_ENCRYPT

Encrypt all data when communicating with the cluster. Boolean value.

See Also:

Constant Field Values

OPTION_SSPI_PACKAGE

public static final java.lang.String OPTION_SSPI_PACKAGE

Specify SSPI security package. The security package will be set to negotiate if this option is not specified.

See Also:

Constant Field Values

OPTION_SSPI_PACKAGE_LIST

public static final java.lang.String OPTION_SSPI_PACKAGE_LIST

Specify SSPI security package list.

See Also:

Constant Field Values

OPTION_SSPI_SPN

public static final java.lang.String OPTION_SSPI_SPN

Specify SSPI service principal name.

See Also:

Constant Field Values

OPTION_USE_CLUSTER_PROPERTIES

public static final java.lang.String OPTION_USE_CLUSTER_PROPERTIES

Enable or disable replacement of host/port parameters with the cluster definition found in the application properties table. Boolean value. If this option is not specified, the USE_SYSTEM_PROPERTIES_FOR_CLUSTER system property is used instead. If the system property is not defined, application properties are ignored.

See Also:

Constant Field Values

Constructor Detail

MetadataClusterUtil

public MetadataClusterUtil()

Method Detail

createCluster

public static Cluster createCluster(java.lang.String hosts,
                                    java.lang.String ports,
                                    java.util.Map<java.lang.String,java.lang.String> options)

Convenience method for creating a metadata cluster. This method creates the BridgeServer objects that define the cluster.

Parameters:

hosts - space delimited list of host names. May be abbreviated to a single name if the same host is used for all cluster nodes. May be null or empty if cluster properties lookup is enabled.

ports - space delimited list of port numbers. May be abbreviated to a single port if the same port is used for all cluster nodes. May be null or empty if cluster properties lookup is enabled.

options - connection options. See OPTION_* constants for available options.

Returns:

cluster definition

createCluster

public static Cluster createCluster(HostPortSet clusterNodes,
                                    java.util.Map<java.lang.String,java.lang.String> options)

Convenience method for creating a metadata cluster. This method creates the BridgeServer objects that define the cluster.

Parameters:

clusterNodes - one or more nodes making up the cluster. May be null or empty if and only if the sas.metadata.use.cluster.properties system property or OPTION_USE_CLUSTER_PROPERTIES option is true.

options - connection options. See OPTION_* constants for available options.

Returns:

cluster definition

getClusterHostPortSet

public static HostPortSet getClusterHostPortSet()

Returns host/port collection for metadata server cluster as defined in the application properties table. Returns null if sas.metadata.use.cluster.properties system property is not defined.

Returns:

host/port collection for metadata server cluster as defined in the application properties table

Throws:

java.lang.RuntimeException - if application properties table cannot be accessed

*** This class provides Binary Compatibility only, not Source Compatibility ***