A B C D E G H I M N R S X

A

addCertificateFile(File) - Method in class com.cri.xcat.api.Connection
Adds the certificate file security information to the SSL client.

B

BasicRequest - Class in com.cri.xcat.api.helpers
BasicRequest extends the base Request class and represents a basic xCAT request to the xCAT daemon.
BasicRequest(String) - Constructor for class com.cri.xcat.api.helpers.BasicRequest
Default Constructor that creates a Basic Request with the command name equal to the input parameter.
BasicTest - Class in com.cri.xcat.api.examples
This class sends a basic request to xcatd (tabdump site) and gets the response.
BasicTest() - Constructor for class com.cri.xcat.api.examples.BasicTest
 
buildXmlOutputStream(OutputStream) - Method in class com.cri.xcat.api.examples.DetailedRequest
 
buildXmlOutputStream(OutputStream) - Method in class com.cri.xcat.api.helpers.BasicRequest
 
buildXmlOutputStream(OutputStream) - Method in class com.cri.xcat.api.Request
Creates the XML and sends it to the xCAT server.

C

characters(char[], int, int) - Method in class com.cri.xcat.api.examples.NonBlockingHandler
 
characters(char[], int, int) - Method in class com.cri.xcat.api.helpers.DefaultResponseHandler
 
com.cri.xcat.api - package com.cri.xcat.api
Provides classes and interfaces for the core communication process with an xCAT daemon.
com.cri.xcat.api.examples - package com.cri.xcat.api.examples
Provides examples on simple use-cases for connecting to and communicating with an xCAT server.
com.cri.xcat.api.helpers - package com.cri.xcat.api.helpers
Provides helper classes for communicating via XML to an xCAT server.
Connection - Class in com.cri.xcat.api
This class contains the information needed to make a valid SSL socket connection to an xCAT daemon.
Connection() - Constructor for class com.cri.xcat.api.Connection
Create a new connection to an xCAT daemon using hostname of "localhost" port of "3001", and the default xCAT certificate files: "ca.pem" & "client-cred.pem" located in the default xCAT directory.
Connection(String, int) - Constructor for class com.cri.xcat.api.Connection
Create a new connection to an xCAT daemon with the hostname and port specified.
Connection(String, int, File[]) - Constructor for class com.cri.xcat.api.Connection
Create a new connection to an xCAT daemon with the hostname and port specified, and adds the security information from the security files specified.
CreateRequest - Class in com.cri.xcat.api.examples
This request is a time consuming request, and therefore we do not want to wait for it to complete, but instead just be notified when new messages appear.
CreateRequest() - Constructor for class com.cri.xcat.api.examples.CreateRequest
 
createSocket() - Method in class com.cri.xcat.api.Connection
Creates a SSL socket from the SSLClient.
createXmlDocument(Map<String, Object>) - Static method in class com.cri.xcat.api.helpers.XcatUtilities
Creates an XML document in the format that xcatd would expect from the input map.

D

DEFAULT_HOSTNAME - Static variable in class com.cri.xcat.api.XcatConstants
The default host which is running the xCAT daemon.
DEFAULT_PORT - Static variable in class com.cri.xcat.api.XcatConstants
The default port which the xCAT daemon is listening on.
DEFAULT_SOCKET_TIMEOUT - Static variable in class com.cri.xcat.api.XcatConstants
The default socket timeout (in milliseconds) to listen for a response from the xCAT server.
DefaultResponseHandler - Class in com.cri.xcat.api.helpers
This class is the default handler for a xCAT response from the xCAT daemon.
DefaultResponseHandler() - Constructor for class com.cri.xcat.api.helpers.DefaultResponseHandler
 
DetailedRequest - Class in com.cri.xcat.api.examples
 
DetailedRequest(String) - Constructor for class com.cri.xcat.api.examples.DetailedRequest
 

E

endDocument() - Method in class com.cri.xcat.api.examples.NonBlockingHandler
 
endElement(String, String, String) - Method in class com.cri.xcat.api.examples.NonBlockingHandler
 
endElement(String, String, String) - Method in class com.cri.xcat.api.helpers.DefaultResponseHandler
 

G

getArgs() - Method in class com.cri.xcat.api.helpers.BasicRequest
Gets the list of arguments that will be sent to the xCAT deamon with the command.
getCommandName() - Method in class com.cri.xcat.api.helpers.BasicRequest
Gets the name of the command that will be sent to the xCAT deamon.
getConnection() - Method in class com.cri.xcat.api.Request
Gets the connection used to create the socket.
getCurrentWorkingDirectory() - Method in class com.cri.xcat.api.helpers.BasicRequest
Gets the current working directory.
getHandler() - Method in class com.cri.xcat.api.Request
Gets the handler used to handle XML responses and any errors that might have occurred.
getHostname() - Method in class com.cri.xcat.api.Connection
Gets the host name of the server running the xCAT daemon.
getNodeRange() - Method in class com.cri.xcat.api.helpers.BasicRequest
Get the node range for the command.
getPort() - Method in class com.cri.xcat.api.Connection
Gets the port number of which the xCAT daemon is listening for incoming requests.
getResponseData() - Method in class com.cri.xcat.api.helpers.DefaultResponseHandler
Returns a map that contains the information contained in the XML.
getSocketTimeOut() - Method in class com.cri.xcat.api.Request
Gets the timeout used to read data from the socket to xCAT (in milliseconds).
getTransactionId() - Method in class com.cri.xcat.api.examples.DetailedRequest
 

H

handleError(Exception) - Method in class com.cri.xcat.api.examples.NonBlockingHandler
 
handleError(Exception) - Method in class com.cri.xcat.api.helpers.DefaultResponseHandler
Logs the error that occurred and prints the error to the console.
handleError(Exception) - Method in interface com.cri.xcat.api.IResponseHandler
This method is called when an error has occurred while attempting to submit a request (send a command) to the xCAT daemon.
handleXmlResponse(InputStream) - Method in class com.cri.xcat.api.examples.NonBlockingHandler
 
handleXmlResponse(InputStream) - Method in class com.cri.xcat.api.helpers.DefaultResponseHandler
Saves the XML response to the an internal responseData Map.
handleXmlResponse(InputStream) - Method in interface com.cri.xcat.api.IResponseHandler
This method takes the InputStream from the SSL socket connection and parses it.

I

IResponseHandler - Interface in com.cri.xcat.api
This interface is used for handling an xCAT response (from the xCAT daemon).
isEmpty(String) - Static method in class com.cri.xcat.api.helpers.XcatUtilities
Returns true if the string is null or an empty string.

M

main(String[]) - Static method in class com.cri.xcat.api.examples.BasicTest
 
main(String[]) - Static method in class com.cri.xcat.api.examples.CreateRequest
 
main(String[]) - Static method in class com.cri.xcat.api.examples.SpecificTest
 

N

NonBlockingHandler - Class in com.cri.xcat.api.examples
 
NonBlockingHandler(Observer) - Constructor for class com.cri.xcat.api.examples.NonBlockingHandler
 

R

read() - Method in class com.cri.xcat.api.XcatInputStream
 
Request - Class in com.cri.xcat.api
A request (also referred to as a command) is the basic information that is sent to the xCAT daemon.
Request() - Constructor for class com.cri.xcat.api.Request
 
REQUEST_ROOT_XML_TAG - Static variable in class com.cri.xcat.api.XcatConstants
The default root tag for the XML request that is sent to the xCAT server.
RESPONSE_ROOT_XML_TAG - Static variable in class com.cri.xcat.api.XcatConstants
This is the root XML tag for all of xcatd's responses.
responseData - Variable in class com.cri.xcat.api.helpers.DefaultResponseHandler
 

S

serverDone - Variable in class com.cri.xcat.api.helpers.DefaultResponseHandler
 
SERVERDONE_XML_TAG - Static variable in class com.cri.xcat.api.XcatConstants
This is the XML tag that signifies the server is done processing the request.
setArgs(String[]) - Method in class com.cri.xcat.api.helpers.BasicRequest
Sets the list of arguments that will be sent to the xCAT deamon with the command.
setCommandName(String) - Method in class com.cri.xcat.api.helpers.BasicRequest
Sets the name of the command that will be sent to the xCAT deamon.
setCurrentWorkingDirectory(String) - Method in class com.cri.xcat.api.helpers.BasicRequest
Set the current working directory for the xCAT request.
setHostname(String) - Method in class com.cri.xcat.api.Connection
Sets the host name of the server running the xCAT daemon.
setNodeRange(String) - Method in class com.cri.xcat.api.helpers.BasicRequest
Set the node range for the request.
setPort(int) - Method in class com.cri.xcat.api.Connection
Sets the port number of which the xCAT daemon is listening for incoming requests.
setSocketTimeOut(int) - Method in class com.cri.xcat.api.Request
Sets the timeout used to read data from the socket to xCAT (in milliseconds).
setTransactionId(String) - Method in class com.cri.xcat.api.examples.DetailedRequest
 
SpecificTest - Class in com.cri.xcat.api.examples
 
SpecificTest() - Constructor for class com.cri.xcat.api.examples.SpecificTest
 
submitRequest(Connection) - Method in class com.cri.xcat.api.Request
Submits a request to the xCAT daemon using the connection passed in and a new DefaultResponseHandler as the handler.
submitRequest(Connection, IResponseHandler) - Method in class com.cri.xcat.api.Request
Submits a request to the xCAT daemon using the connection and handler passed in.

X

XcatCommunicationException - Exception in com.cri.xcat.api
 
XcatCommunicationException(String, Throwable) - Constructor for exception com.cri.xcat.api.XcatCommunicationException
Constructor for a XcatCommunicationException
XcatCommunicationException(String) - Constructor for exception com.cri.xcat.api.XcatCommunicationException
Constructor for a XcatCommunicationException
XcatConstants - Class in com.cri.xcat.api
 
XcatConstants() - Constructor for class com.cri.xcat.api.XcatConstants
 
XcatInputStream - Class in com.cri.xcat.api
Extends any InputStream by forcing a input stream to report the end of reading once a
XcatInputStream(InputStream) - Constructor for class com.cri.xcat.api.XcatInputStream
The constructor for this class must include an input stream to decorate.
XcatUtilities - Class in com.cri.xcat.api.helpers
Contains various helper functions that are useful in dealing with xCAT communications.
XcatUtilities() - Constructor for class com.cri.xcat.api.helpers.XcatUtilities
 
xmlToOutputStream(Document, OutputStream) - Static method in class com.cri.xcat.api.helpers.XcatUtilities
Takes an XML document and sends it to the output stream in a way that xcatd would expect.

A B C D E G H I M N R S X