CASClient (cas-client 3.2.9 API)

java.lang.Object
- com.sas.cas.BaseCASClient
- - com.sas.cas.CASClient

All Implemented Interfaces:: CASClientInterface, java.lang.AutoCloseable

public final class CASClient
extends BaseCASClient

Represents a connection to a Cloud Analytic Services (CAS) instance. To connect to a CAS instance, simply specify the host and port of the server:

 CASClient client = new CASClient();
 client.setHost("myhost");
 client.setPort(10738)

And setup the action parameters and invoke the action:

 CASActionOptions options = new CASActionOptions();
 options.setActionSetName("builtins");
 options.setActionName("serverstatus");

Then invoke the action and process the results:

 CASActionResults<CASValue> results = client.invoke(options);

 // Print all events generated by the action
 BaseSample.printEvents(results);
 
 // Print all results generated by the action
 BaseSample.printResultValues(results);

This class should not be assumed to be thread safe.

Nested Class Summary
- Nested classes/interfaces inherited from class com.sas.cas.BaseCASClient
  BaseCASClient.AUTH_METHOD

Constructor Summary

Constructors
Constructor and Description
`CASClient()` Instantiate a new CASClient.
`CASClient(CASClient client)` Copy constructor.
`CASClient(CASClient client, boolean includeSessionID)` Copy constructor.
`CASClient(java.lang.String host, int port)` Instantiates a new CASClient with the given connection information.
`CASClient(java.lang.String host, int port, java.lang.String userName, java.lang.String password)` Instantiates a new CASClient with the given connection information.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected com.sas.cas.proto.CASClientProto.Request`	`buildRequest(CASActionOptions options)`
`void`	`close()` Closes the current connection, if any, to the server.
`void`	`close(boolean endSession)` Closes the current connection, if any, to the server.
`CASClientInterface`	`copy(boolean includeSessionID)` Creates a copy of the current object with the same settings.
`protected boolean`	`equals(java.lang.String s1, java.lang.String s2)` Returns true if both strings are equal, or both strings are null.
`protected CASActionResults<com.sas.cas.proto.CASClientProto.Value>`	`getActions(CASActionOptions options)` Uses reflection to get the action parameters.
`CASAuthenticatedUserEventListener`	`getAuthenticatedUserEventListener()` Returns the current authenticated user event listener.
`CASAuthenticatedUserInfo`	`getAuthenticatedUserInfo()` Gets information about the authenticated user.
`java.lang.String[]`	`getBackupHosts()` Gets the list of backup hosts in the format host:port.
`java.lang.String`	`getHost()`
`protected long`	`getLastActivityTime()` Gets the time of the last activity.
`java.lang.String`	`getLocale()`
`static java.lang.String`	`getMessage(java.lang.Throwable ex)` Gets an exception message.
`int`	`getNumberOfNodes()`
`int`	`getPort()`
`java.lang.String`	`getRecordingInputFileName()`
`java.lang.String`	`getRecordingOutputFileName()`
`CASServerInfo`	`getServerInfo()` Gets information about the current server.
`java.lang.String`	`getSessionID()` Gets the session ID associated with this client.
`CASSocketAttemptEventListener`	`getSocketAttemptEventListener()`
`CASSocketEventListener`	`getSocketEventListener()` Returns the current socket event listener.
`int`	`getSocketRetries()`
`CASSSLSocketEventListener`	`getSSLSocketEventListener()` Returns the current SSL socket event listener.
`java.lang.String`	`getUserName()` Gets the user name which may have been set prior to authentication.
`java.lang.Object`	`getUserProperty(java.lang.String key)` Returns the user property associated with the given key.
`java.util.Iterator<java.lang.String>`	`getUserPropertyKeys()` Returns an iterator of user property keys.
`CASActionResults<CASValue>`	`invoke(CASActionOptions options, com.sas.cas.proto.CASClientProto.Request request)` Invokes an action on the server
`protected CASActionResults<com.sas.cas.proto.CASClientProto.Value>`	`invoke(CASActionOptions options, com.sas.cas.proto.CASClientProto.Request request, com.sas.cas.CASClient.ResultValueHandler handler, boolean reconnect)`
`protected CASActionResults<CASValue>`	`invokeInternal(CASActionOptions options)`
`static boolean`	`isActionRestart(com.sas.cas.proto.CASClientProto.Response response)`
`boolean`	`isClosed()` Returns true if the current connection is closed, or a connection has not been established.
`boolean`	`isCommunicationEncrypted()`
`CASClient`	`setAuthenticatedUserEventListener(CASAuthenticatedUserEventListener authenticatedUserEventListener)` Sets the authenticated user event listener that will be called when a user has been authenticated with the server.
`CASClient`	`setBackupHosts(java.lang.String hosts)` Sets the backup CAS host name(s).
`CASClient`	`setBackupHosts(java.lang.String[] hosts)` Sets the backup CAS host name(s).
`CASClient`	`setHost(java.lang.String host)` Sets the target CAS host.
`CASClient`	`setLocale(java.lang.String locale)` Sets the client locale.
`CASClient`	`setNumberOfNodes(int numberOfNodes)` Sets the number of nodes to use on the target server.
`CASClient`	`setPassword(java.lang.String password)` Sets the user password used with authentication to the CAS instance.
`CASClient`	`setPort(int port)` Sets the target CAS port.
`CASClient`	`setProperties(CASClient client)` Sets the properties from an existing client.
`CASClient`	`setProperties(CASClient client, boolean includeSessionID)` Sets the properties from an existing client.
`CASClient`	`setRecordingInputFileName(java.lang.String recordingInputFileName)` Sets the name of the input recording file name.
`CASClient`	`setRecordingOutputFileName(java.lang.String recordingOutputFileName)` Sets the name of the output recording file name.
`CASClient`	`setSessionID(java.lang.String sessionID)` Sets the session ID used with authentication to the CAS instance.
`CASClient`	`setSocketAttemptEventListener(CASSocketAttemptEventListener socketAttemptEventListener)` Sets the socket attempt event lisetener that will be called when new socket connections are being attempted.
`CASClient`	`setSocketEventListener(CASSocketEventListener socketListener)` Sets the socket event listener that will be called when new socket connections have been established and sockets are being closed.
`CASClient`	`setSocketRetries(int socketRetries)` Sets the number of times a connection to a server will be retried before failing.
`CASClient`	`setSSLSocketEventListener(CASSSLSocketEventListener sslSocketEventListener)` Sets the SSL socket event listener that will be called when a new SSL socket connection is created.
`CASClient`	`setUserName(java.lang.String userName)` Sets the user name used with authentication to the CAS instance.
`CASClient`	`setUserProperty(java.lang.String key, java.lang.Object value)` Sets a user property.

Methods inherited from class com.sas.cas.BaseCASClient
addActionEventListener, addEventListener, addExceptionHandler, addLogEventListener, batchAction, cancelAction, checkAuthMethod, checkDispositions, copy, copy, fireAndSetDispositionEvents, fireAndSetDispositionEvents, fireAndSetLogEvents, fireAndSetLogEvents, fireAndSetPerformanceEvents, fireAndSetPerformanceEvents, fireGlobalLogEvent, getActionEventListeners, getActions, getActionSets, getAutoCloseTimeout, getClientContext, getDispositionEventListener, getEventListeners, getExceptionHandler, getExceptionHandlerKeys, getLogEventListener, getLogEventListeners, getObjectFactories, getPerformanceEventListener, getSecurityToken, getSecurityTokenProvider, getTableAttributes, invoke, invoke, loadActionSet, removeActionEventListener, removeEventListener, removeExceptionHandler, removeLogEventListener, setAsActiveClientContext, setAutoCloseTimeout, setClientContext, setDispositionEventListener, setLogEventListener, setPerformanceEventListener, setSecurityToken, setSecurityTokenProvider, shutdown, stopAction, toDispositionEvent, toLogEvent, toPerformanceEvent

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

- Constructor Detail
  - CASClient
```
public CASClient()
```
    Instantiate a new CASClient.
  - CASClient
```
public CASClient(java.lang.String host,
                 int port)
```
    Instantiates a new CASClient with the given connection information.
    
    Parameters:
    
    host - The CAS host
    
    port - The CAS port
  - CASClient
```
public CASClient(java.lang.String host,
                 int port,
                 java.lang.String userName,
                 java.lang.String password)
```
    Instantiates a new CASClient with the given connection information.
    
    Parameters:
    
    host - The CAS host
    
    port - The CAS port
    
    userName - The user name
    
    password - The user password
  - CASClient
```
public CASClient(CASClient client)
```
    Copy constructor.
    
    Parameters:
    
    client - The source CASClient
  - CASClient
```
public CASClient(CASClient client,
                 boolean includeSessionID)
```
    Copy constructor.
    
    Parameters:
    
    client - The source CASClient
- Method Detail
  - setProperties
```
public CASClient setProperties(CASClient client)
```
    Sets the properties from an existing client. Copies all properties except numberOfNodes.
    
    Parameters:
    
    client - The client
  - setProperties
```
public CASClient setProperties(CASClient client,
                               boolean includeSessionID)
```
    Sets the properties from an existing client. Copies all properties except numberOfNodes.
    
    Parameters:
    
    includeSessionID - True to include the session ID
    
    client - The client
  - getHost
```
public java.lang.String getHost()
```
  - setHost
```
public CASClient setHost(java.lang.String host)
```
    Sets the target CAS host. Multiple hosts (primary plus backups) can be specified by separating the host names with a comma (','), semicolon (';'), or space (' '), such as "host:1234,host2". Currently backup hosts use the same port as the primary.
    
    Parameters:
    
    host - The host name or address
  - setBackupHosts
```
public CASClient setBackupHosts(java.lang.String hosts)
```
    Sets the backup CAS host name(s). Multiple hosts can be specified by separating the host names with a comma (','), semicolon (';'), or space (' '). Currently backup hosts use the same port as the primary
    
    Parameters:
    
    hosts - The host name(s)
  - setBackupHosts
```
public CASClient setBackupHosts(java.lang.String[] hosts)
```
    Sets the backup CAS host name(s).
    
    Parameters:
    
    hosts - The array of host name(s)
  - getBackupHosts
```
public java.lang.String[] getBackupHosts()
```
    Gets the list of backup hosts in the format host:port.
    
    Returns:
    
    The backup hosts, or null if none
  - isCommunicationEncrypted
```
public boolean isCommunicationEncrypted()
```
  - getPort
```
public int getPort()
```
  - setPort
```
public CASClient setPort(int port)
```
    Sets the target CAS port.
    
    Parameters:
    
    port - The port
  - getNumberOfNodes
```
public int getNumberOfNodes()
```
  - setNumberOfNodes
```
public CASClient setNumberOfNodes(int numberOfNodes)
```
    Sets the number of nodes to use on the target server.
    
    Parameters:
    
    numberOfNodes - The number of nodes, or 0 for all
  - getUserName
```
public java.lang.String getUserName()
```
    Description copied from interface: CASClientInterface
    
    Gets the user name which may have been set prior to authentication.
    
    Returns:
    
    The user name, if known
  - setUserName
```
public CASClient setUserName(java.lang.String userName)
```
    Sets the user name used with authentication to the CAS instance.
    
    Parameters:
    
    userName - The user name
  - setPassword
```
public CASClient setPassword(java.lang.String password)
```
    Sets the user password used with authentication to the CAS instance.
    
    Parameters:
    
    password - The password
  - getSessionID
```
public java.lang.String getSessionID()
```
    Description copied from interface: CASClientInterface
    
    Gets the session ID associated with this client.
    
    Returns:
    
    The session ID, if known
  - setSessionID
```
public CASClient setSessionID(java.lang.String sessionID)
```
    Sets the session ID used with authentication to the CAS instance. A null value indicates to create a new session; otherwise an attempt will be made to reconnect to the session with the given ID.
    
    Parameters:
    
    sessionID - The session ID
  - getLocale
```
public java.lang.String getLocale()
```
  - setLocale
```
public CASClient setLocale(java.lang.String locale)
```
    Sets the client locale. The default locale is that of the VM (Locale.getDefault). The locale must be set prior to establishing a session.
    
    Parameters:
    
    locale - The locale, or null to use the server default.
  - getRecordingOutputFileName
```
public java.lang.String getRecordingOutputFileName()
```
  - setRecordingOutputFileName
```
public CASClient setRecordingOutputFileName(java.lang.String recordingOutputFileName)
```
    Sets the name of the output recording file name. All traffic with the server will be recorded and stored here.
    
    Parameters:
    
    recordingOutputFileName - The output file name
  - getRecordingInputFileName
```
public java.lang.String getRecordingInputFileName()
```
  - setRecordingInputFileName
```
public CASClient setRecordingInputFileName(java.lang.String recordingInputFileName)
                                    throws java.io.IOException
```
    Sets the name of the input recording file name.
    
    Parameters:
    
    recordingInputFileName - The input file name
    
    Throws:
    
    java.io.IOException
  - getAuthenticatedUserInfo
```
public CASAuthenticatedUserInfo getAuthenticatedUserInfo()
```
    Description copied from interface: CASClientInterface
    
    Gets information about the authenticated user.
    
    Returns:
    
    The authenticated user info, if known
  - getServerInfo
```
public CASServerInfo getServerInfo()
```
    Description copied from interface: CASClientInterface
    
    Gets information about the current server.
    
    Returns:
    
    The server information
  - copy
```
public CASClientInterface copy(boolean includeSessionID)
```
    Description copied from interface: CASClientInterface
    
    Creates a copy of the current object with the same settings.
    
    Parameters:
    
    includeSessionID - True to include the session ID
    
    Returns:
    
    The cloned object
  - getSocketRetries
```
public int getSocketRetries()
```
  - setSocketRetries
```
public CASClient setSocketRetries(int socketRetries)
```
    Sets the number of times a connection to a server will be retried before failing. The default is 0.
    
    Parameters:
    
    socketRetries - The number of retries
  - equals
```
protected boolean equals(java.lang.String s1,
                         java.lang.String s2)
```
    Returns true if both strings are equal, or both strings are null.
    
    Parameters:
    
    s1 - The first string
    
    s2 - The second string
    
    Returns:
    
    true if equal or both null
  - getSocketEventListener
```
public CASSocketEventListener getSocketEventListener()
```
    Returns the current socket event listener.
    
    Returns:
    
    The listener
  - setSocketEventListener
```
public CASClient setSocketEventListener(CASSocketEventListener socketListener)
```
    Sets the socket event listener that will be called when new socket connections have been established and sockets are being closed.
    
    Parameters:
    
    socketListener - The socket listener
  - getSSLSocketEventListener
```
public CASSSLSocketEventListener getSSLSocketEventListener()
```
    Returns the current SSL socket event listener.
    
    Returns:
    
    The listener
  - setSSLSocketEventListener
```
public CASClient setSSLSocketEventListener(CASSSLSocketEventListener sslSocketEventListener)
```
    Sets the SSL socket event listener that will be called when a new SSL socket connection is created.
    
    Parameters:
    
    sslSocketEventListener - The SSL socket listener
  - getSocketAttemptEventListener
```
public CASSocketAttemptEventListener getSocketAttemptEventListener()
```
  - setSocketAttemptEventListener
```
public CASClient setSocketAttemptEventListener(CASSocketAttemptEventListener socketAttemptEventListener)
```
    Sets the socket attempt event lisetener that will be called when new socket connections are being attempted.
    
    Parameters:
    
    socketAttemptEventListener - The listener
  - getAuthenticatedUserEventListener
```
public CASAuthenticatedUserEventListener getAuthenticatedUserEventListener()
```
    Returns the current authenticated user event listener.
    
    Returns:
    
    The listener
  - setAuthenticatedUserEventListener
```
public CASClient setAuthenticatedUserEventListener(CASAuthenticatedUserEventListener authenticatedUserEventListener)
```
    Sets the authenticated user event listener that will be called when a user has been authenticated with the server.
    
    Parameters:
    
    authenticatedUserEventListener - The listener
  - setUserProperty
```
public CASClient setUserProperty(java.lang.String key,
                                 java.lang.Object value)
```
    Sets a user property.
    
    Parameters:
    
    key - The property key
    
    value - The property value, or null to remove the key
  - getUserProperty
```
public java.lang.Object getUserProperty(java.lang.String key)
```
    Returns the user property associated with the given key.
    
    Parameters:
    
    key - The property key
    
    Returns:
    
    The value bound to the key, or null if not found
  - getUserPropertyKeys
```
public java.util.Iterator<java.lang.String> getUserPropertyKeys()
```
    Returns an iterator of user property keys.
    
    Returns:
    
    The user property keys
  - getMessage
```
public static java.lang.String getMessage(java.lang.Throwable ex)
```
    Gets an exception message. If the underlying message of the exception is empty, return the exception class name.
    
    Parameters:
    
    ex - The exception
    
    Returns:
    
    The exception message
  - getActions
```
protected CASActionResults<com.sas.cas.proto.CASClientProto.Value> getActions(CASActionOptions options)
                                                                       throws CASException,
                                                                              java.io.IOException
```
    Description copied from class: BaseCASClient
    
    Uses reflection to get the action parameters.
    
    Specified by:
    
    getActions in class BaseCASClient
    
    Parameters:
    
    options - The options
    
    Returns:
    
    The raw protobuf results
    
    Throws:
    
    CASException
    
    java.io.IOException
  - invokeInternal
```
protected CASActionResults<CASValue> invokeInternal(CASActionOptions options)
                                             throws CASException,
                                                    java.io.IOException
```
    Specified by:
    
    invokeInternal in class BaseCASClient
    
    Throws:
    
    CASException
    
    java.io.IOException
  - invoke
```
public CASActionResults<CASValue> invoke(CASActionOptions options,
                                         com.sas.cas.proto.CASClientProto.Request request)
                                  throws CASException,
                                         java.io.IOException
```
    Invokes an action on the server
    
    Parameters:
    
    options - The action options
    
    request - The protobuf request
    
    Returns:
    
    The results
    
    Throws:
    
    CASException
    
    java.io.IOException
  - isClosed
```
public boolean isClosed()
```
    Description copied from interface: CASClientInterface
    
    Returns true if the current connection is closed, or a connection has not been established.
    
    Returns:
    
    true if closed
  - close
```
public void close(boolean endSession)
           throws CASException,
                  java.io.IOException
```
    Description copied from interface: CASClientInterface
    
    Closes the current connection, if any, to the server.
    
    Specified by:
    
    close in interface CASClientInterface
    
    Overrides:
    
    close in class BaseCASClient
    
    Parameters:
    
    endSession - true to end the server session
    
    Throws:
    
    CASException
    
    java.io.IOException
  - close
```
public void close()
           throws CASException,
                  java.io.IOException
```
    Description copied from interface: CASClientInterface
    
    Closes the current connection, if any, to the server. By default this does not end the server session.
    
    Specified by:
    
    close in interface CASClientInterface
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class BaseCASClient
    
    Throws:
    
    CASException
    
    java.io.IOException
  - buildRequest
```
protected com.sas.cas.proto.CASClientProto.Request buildRequest(CASActionOptions options)
```
  - isActionRestart
```
public static boolean isActionRestart(com.sas.cas.proto.CASClientProto.Response response)
```
  - invoke
```
protected CASActionResults<com.sas.cas.proto.CASClientProto.Value> invoke(CASActionOptions options,
                                                                          com.sas.cas.proto.CASClientProto.Request request,
                                                                          com.sas.cas.CASClient.ResultValueHandler handler,
                                                                          boolean reconnect)
                                                                   throws CASException,
                                                                          java.io.IOException
```
    Throws:
    
    CASException
    
    java.io.IOException
  - getLastActivityTime
```
protected long getLastActivityTime()
```
    Description copied from class: BaseCASClient
    
    Gets the time of the last activity. Used for AutoClose.
    
    Specified by:
    
    getLastActivityTime in class BaseCASClient
    
    Returns:
    
    The time of the last activity or 0 if currently running an action

Class CASClient

Nested Class Summary

Nested classes/interfaces inherited from class com.sas.cas.BaseCASClient

Constructor Summary

Method Summary

Methods inherited from class com.sas.cas.BaseCASClient

Methods inherited from class java.lang.Object

Constructor Detail

CASClient

CASClient

CASClient

CASClient

CASClient

Method Detail

setProperties

setProperties

getHost

setHost

setBackupHosts

setBackupHosts

getBackupHosts

isCommunicationEncrypted

getPort

setPort

getNumberOfNodes

setNumberOfNodes

getUserName

setUserName

setPassword

getSessionID

setSessionID

getLocale

setLocale

getRecordingOutputFileName

setRecordingOutputFileName

getRecordingInputFileName

setRecordingInputFileName

getAuthenticatedUserInfo

getServerInfo

copy

getSocketRetries

setSocketRetries

equals

getSocketEventListener

setSocketEventListener

getSSLSocketEventListener

setSSLSocketEventListener

getSocketAttemptEventListener

setSocketAttemptEventListener

getAuthenticatedUserEventListener

setAuthenticatedUserEventListener

setUserProperty

getUserProperty

getUserPropertyKeys

getMessage

getActions

invokeInternal

invoke

isClosed

close

close

buildRequest

isActionRestart

invoke

getLastActivityTime